Skip to content

Commit

Permalink
#1951 Miscellaneous documentation improvements (#1952)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomlyn authored May 15, 2024
1 parent 2c741d6 commit 9b1af5a
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/pages/01.01-flow-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,19 +83,23 @@ The flow editor can display a [context menu](01.03-context-menu.md) or [context

## Zoom Objects

The objects on the flow-editor canvas can be zoomed in and out either using the toolbar zoom buttons or by performing the zoom gesture using the mouse or trackpad. The canvas background can be panned by dragging the background.
The objects on the flow-editor canvas can be zoomed in and out either using the `zoomIn` or `zoomOut` toolbar buttons or by performing the zoom gesture using the mouse or trackpad. The canvas background can be panned by dragging the background.

<img src="../assets/cc-flow-editor-zoom.gif" width="600" />

A large flow can be centrally positioned, making all the nodes visible within the viewport, by clicking the `zoomToFit` button.

<img src="../assets/cc-flow-editor-zoom-to-fit.gif" width="600" />

## Command Stack

Command actions that update the objects within the flow editor are added to the [command stack](03.10-command-stack.md) and can be undone and then redone. The default toolbar had `undo` and `redo` buttons and the default context menu/toolbar for the canvas background has `undo` and `redo` options. There are also [keyboard](03.05-keyboard-support.md) shortcuts to undo and redo.
Command actions that update the objects within the flow editor are added to the [command stack](03.10-command-stack.md) and can be undone and then redone. The default toolbar has `undo` and `redo` buttons and the default context menu/toolbar for the canvas background has `undo` and `redo` options. There are also [keyboard](03.05-keyboard-support.md) shortcuts to undo and redo.

<img src="../assets/cc-flow-editor-command-stack.gif" width="500" />

## Clipboard

Users can cut and copy one object, or a set of objects, from the canvas onto the clipboard and paste them into the same flow or a different flow. The default canvas toolbar provides buttons for these three actions and they can also be accessed through the default context menus/toolbars for the objects on the canvas.
Users can `cut` and `copy` one or more objects from the canvas onto the clipboard and `paste` them into the same flow or a different flow. The default canvas toolbar provides buttons for these three actions and they can also be accessed through the default context menus/toolbars for the objects on the canvas.

There are also [keyboard](03.05-keyboard-support.md) shortcuts to cut, copy and paste.

Expand Down
1 change: 1 addition & 0 deletions docs/pages/03.05-keyboard-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ When any of the shortcut keys are pressed the common-canvas object model will be
|---|---|
|right arrow|Move focus to the button to the right of current focus position |
|left arrow|Move focus to the button to the left of current focus position |
|down arrow|Open sub-area (either a sub-menu or sub-panel) below button, if one is available |
|space bar|Activate the button |
|esc | Close any open associated sub-area (either a sub-menu or sub-panel) |

Expand Down
Binary file added docs/pages/assets/cc-flow-editor-zoom-to-fit.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9b1af5a

Please sign in to comment.