enso-org/enso
1
1
Fork 0
mirror of https://github.com/enso-org/enso.git synced 2024-12-27 02:23:40 +03:00
Code Issues Projects Releases Wiki Activity
abdbcfcdb1
enso/app/gui/docs/product/shortcuts.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

144 lines
17 KiB
Markdown
Raw Normal View History

Add frontmatter blocks to each documentation page (https://github.com/enso-org/ide/pull/630) Original commit: https://github.com/enso-org/ide/commit/1b338ea9eaa384b9e86269fad6da08e72e157c42
2020-07-03 13:08:14 +03:00
---
layout: developer-doc
title: Shortcuts
category: product
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
tags: [product, ui]
Add frontmatter blocks to each documentation page (https://github.com/enso-org/ide/pull/630) Original commit: https://github.com/enso-org/ide/commit/1b338ea9eaa384b9e86269fad6da08e72e157c42
2020-07-03 13:08:14 +03:00
---
Focus manager (Part 1, internal focus management) (https://github.com/enso-org/ide/pull/838) Original commit: https://github.com/enso-org/ide/commit/db6d2f20b6dea27977c3b278d333b6364b20595d
2020-10-20 05:44:35 +03:00
## General Assumptions
Update shortcuts.md Original commit: https://github.com/enso-org/ide/commit/5b1855f54f5c465cc0a59177fcf254ccbe330712
2020-10-02 05:16:38 +03:00
Focus manager (Part 1, internal focus management) (https://github.com/enso-org/ide/pull/838) Original commit: https://github.com/enso-org/ide/commit/db6d2f20b6dea27977c3b278d333b6364b20595d
2020-10-20 05:44:35 +03:00
#### The <kbd>meta</kbd> key.
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
Update shortcuts to reflect Component Browser design docs. (#3823) When no node is edited, `Enter` creates a new one (opening Component Browser). The shortcut for entering node was changed to `cmd + Enter`
2022-10-25 20:21:12 +03:00
The <kbd>cmd</kbd> key was introduced to make the shortcuts consistent across
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
platforms. It is defined as <kbd>command</kbd> on macOS, and as <kbd>ctrl</kbd>
on Windows and Linux.
Focus manager (Part 1, internal focus management) (https://github.com/enso-org/ide/pull/838) Original commit: https://github.com/enso-org/ide/commit/db6d2f20b6dea27977c3b278d333b6364b20595d
2020-10-20 05:44:35 +03:00
#### Keyboard-only Workflow
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
The GUI and all shortcuts were designed in a way to allow both efficient
mouse-only as well as keyboard-only workflows. In most cases, there is a
relation between mouse and keyboard shortcuts, namely, the `left-mouse-button`
corresponds to `enter`. For example, stepping into a node is done by either
double clicking the node, or just pressing the enter key.
Focus manager (Part 1, internal focus management) (https://github.com/enso-org/ide/pull/838) Original commit: https://github.com/enso-org/ide/commit/db6d2f20b6dea27977c3b278d333b6364b20595d
2020-10-20 05:44:35 +03:00
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
#### Missing / not working shortcuts
Focus manager (Part 1, internal focus management) (https://github.com/enso-org/ide/pull/838) Original commit: https://github.com/enso-org/ide/commit/db6d2f20b6dea27977c3b278d333b6364b20595d
2020-10-20 05:44:35 +03:00
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
Some of the shortcuts presented below are marked with the :warning: icon, which
means, that they are planned, but not yet implemented. Feel free to contribute
and help us implement them!
Focus manager (Part 1, internal focus management) (https://github.com/enso-org/ide/pull/838) Original commit: https://github.com/enso-org/ide/commit/db6d2f20b6dea27977c3b278d333b6364b20595d
2020-10-20 05:44:35 +03:00
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
Shortcuts marked with the :bangbang: icon should work, but are reported to be
broken and require further investigation.
Focus manager (Part 1, internal focus management) (https://github.com/enso-org/ide/pull/838) Original commit: https://github.com/enso-org/ide/commit/db6d2f20b6dea27977c3b278d333b6364b20595d
2020-10-20 05:44:35 +03:00
## Graph Editor
#### General Shortcuts
Improved docs with custom visualization example (https://github.com/enso-org/ide/pull/625) Original commit: https://github.com/enso-org/ide/commit/03d5d116fd1b12a30f48ad9dfd471b8469867e88
2020-07-11 04:00:26 +03:00
Additional shortcut for Redo (#4035) Add a cmd+shift+z shortcut for redo while keeping alse the old one
2023-01-17 15:38:25 +03:00
| Shortcut | Action |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <kbd>cmd</kbd>+<kbd>alt</kbd>+<kbd>shift</kbd>+<kbd>t</kbd> | Toggle light/dark application style. Currently doesn't work properly, as the Theme Switcher is not created yet. (https://github.com/enso-org/ide/issues/795) |
| <kbd>ctrl</kbd>+<kbd>`</kbd> | Show Code Editor. Please note that the Code Editor implementation is in a very early stage and you should not use it. Even just openning it can cause errors in the IDE. Do not try using the graph editor while having the code editor tab openned. |
| <kbd>cmd</kbd>+<kbd>o</kbd> | Open project |
| <kbd>cmd</kbd>+<kbd>s</kbd> | Save module |
Fix #6377: Change ctrl-r shortcut (#6620) Fixes #6377: The fact that `ctrl-r` was restoring the project to potentially the initial state was confusing. This PR changes that shortcut to `ctrl-shift-r`, as discussed in #6377. Note that: - `ctrl-shift-r` was already taken by the re-execution shortcut, so that got the `ctrl-alt` modifiers instead, along with the interruption shortcut for consistency. - `ctrl-alt-shift-r` was already taken by a shortcut to refresh the whole Electron app, so that wasn't available.
2023-05-10 11:40:24 +03:00
| <kbd>cmd</kbd>+<kbd>shift</kbd>+<kbd>r</kbd> | Restore module from last save |
Additional shortcut for Redo (#4035) Add a cmd+shift+z shortcut for redo while keeping alse the old one
2023-01-17 15:38:25 +03:00
| <kbd>cmd</kbd>+<kbd>z</kbd> | Undo last action |
| <kbd>cmd</kbd>+<kbd>y</kbd> or <kbd>cmd</kbd> + <kbd>shift</kbd> + <kbd>z</kbd> | Redo last undone action |
| <kbd>cmd</kbd>+<kbd>q</kbd> | Close the application (MacOS) |
| <kbd>ctrl</kbd>+<kbd>q</kbd> | Close the application (Linux) |
| <kbd>alt</kbd>+<kbd>F4</kbd> | Close the application (MacOS, Windows, Linux) |
| <kbd>ctrl</kbd>+<kbd>w</kbd> | Close the application (Windows, Linux) |
| :warning: <kbd>ctrl</kbd>+<kbd>p</kbd> | Toggle profiling mode |
| <kbd>escape</kbd> | Cancel current action. For example, drop currently dragged connection. |
Fix #6377: Change ctrl-r shortcut (#6620) Fixes #6377: The fact that `ctrl-r` was restoring the project to potentially the initial state was confusing. This PR changes that shortcut to `ctrl-shift-r`, as discussed in #6377. Note that: - `ctrl-shift-r` was already taken by the re-execution shortcut, so that got the `ctrl-alt` modifiers instead, along with the interruption shortcut for consistency. - `ctrl-alt-shift-r` was already taken by a shortcut to refresh the whole Electron app, so that wasn't available.
2023-05-10 11:40:24 +03:00
| <kbd>cmd</kbd>+<kbd>alt</kbd>+<kbd>t</kbd> | Terminate the program execution |
| <kbd>cmd</kbd>+<kbd>alt</kbd>+<kbd>r</kbd> | Re-execute the program |
Execution environment integration fixes. (#6434) Follow up to https://github.com/enso-org/enso/pull/6341#issuecomment-1522341055 . Contains some refactoring and solves some left over to-dos in the code.
2023-04-27 20:30:26 +03:00
| <kbd>cmd</kbd>+<kbd>shift</kbd>+<kbd>k</kbd> | Switch the execution environment to Design. |
| <kbd>cmd</kbd>+<kbd>shift</kbd>+<kbd>l</kbd> | Switch the execution environment to Live. |
Copy-pasting nodes (#7618) Closes #6261 - Adds support for copy-pasting nodes with `cmd + C` and `cmd + V` shortcuts. - Only a single, currently selected node will be copied. Adding support for multiple node copies seems easy, though (but was out of the scope of the task). - We use a custom data format for clipboard content. Node's metadata is also copied, so opened visualizations are preserved. However, the visualization's size is not preserved, as we do not store this info in metadata. - For custom format to work, we use a pretty new feature called [Clipboard pickling](https://github.com/w3c/editing/blob/gh-pages/docs/clipboard-pickling/explainer.md), but it is available in Electron and in most browsers already. - Pasting plain text from other applications (or from Enso, if the code is copied in edit mode) is supported and is currently enabled. There are some security concerns related to this, though. I will create a separate issue/discussion for that. - Undo/redo works as you expect. - New node is pasted at the cursor position. https://github.com/enso-org/enso/assets/6566674/7a04d941-19f7-4a39-9bce-0e554af50ba3
2023-08-30 16:04:21 +03:00
| <kbd>cmd</kbd>+<kbd>c</kbd> | Copy the selected nodes to the clipboard. |
| <kbd>cmd</kbd>+<kbd>v</kbd> | Paste a node from the clipboard at the mouse cursor position. |
Focus manager (Part 1, internal focus management) (https://github.com/enso-org/ide/pull/838) Original commit: https://github.com/enso-org/ide/commit/db6d2f20b6dea27977c3b278d333b6364b20595d
2020-10-20 05:44:35 +03:00
#### Navigation
Improved docs with custom visualization example (https://github.com/enso-org/ide/pull/625) Original commit: https://github.com/enso-org/ide/commit/03d5d116fd1b12a30f48ad9dfd471b8469867e88
2020-07-11 04:00:26 +03:00
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
| Shortcut | Action |
| ------------------------------------------------ | ------------------------------- |
| Drag gesture (two fingers) | Pan the scene. |
| Pinch gesture (two fingers) | Zoom the scene. |
| <kbd>MMB</kbd> drag | Pan the scene. |
| <kbd>RMB</kbd> drag | Zoom the scene. |
| <kbd>LMB</kbd> double press node name | Step into the node. |
| :warning: <kbd>LMB</kbd> double press background | Step out of the current node. |
Update shortcuts to reflect Component Browser design docs. (#3823) When no node is edited, `Enter` creates a new one (opening Component Browser). The shortcut for entering node was changed to `cmd + Enter`
2022-10-25 20:21:12 +03:00
| <kbd>cmd</kbd>+<kbd>enter</kbd> | Step in the last selected node. |
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
| <kbd>alt</kbd>+<kbd>enter</kbd> | Step out of the current node. |
The last selected node may be entered by pressing Ctrl+Enter. (https://github.com/enso-org/ide/pull/607) Original commit: https://github.com/enso-org/ide/commit/40a41760736e4cf83736ca1f7e72cc0f65278d65
2020-06-25 13:54:41 +03:00
Focus manager (Part 1, internal focus management) (https://github.com/enso-org/ide/pull/838) Original commit: https://github.com/enso-org/ide/commit/db6d2f20b6dea27977c3b278d333b6364b20595d
2020-10-20 05:44:35 +03:00
#### Node Layout
The last selected node may be entered by pressing Ctrl+Enter. (https://github.com/enso-org/ide/pull/607) Original commit: https://github.com/enso-org/ide/commit/40a41760736e4cf83736ca1f7e72cc0f65278d65
2020-06-25 13:54:41 +03:00
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
| Shortcut | Action |
| ------------------------------------------ | ----------------------------------------------------------------- |
| <kbd>LMB</kbd> drag non-selected node name | Move the node to new position (dragging do not modify selection). |
| <kbd>LMB</kbd> drag selected node name | Move all selected nodes the node to new positions. |
Exposing graph editor FRP outputs (https://github.com/enso-org/ide/pull/435) Original commit: https://github.com/enso-org/ide/commit/1f4d5fd10ec0156097dbb0d392f4320ad27cc3bf
2020-05-19 15:24:12 +03:00
#### Node Selection
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
| Shortcut | Action |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| <kbd>LMB</kbd> click node name | Deselect all nodes. Select the target node. |
| <kbd>LMB</kbd> click background | Deselect all nodes. |
| :warning: <kbd>LMB</kbd> drag background | Select nodes using selection-box. |
| <kbd>shift</kbd> + <kbd>LMB</kbd> click node name | Add / remove node to the selection group. |
| :warning: <kbd>shift</kbd> + <kbd>LMB</kbd> drag background | Add / remove nodes to the selection group. |
| :warning: <kbd>\*-arrow</kbd> | Select node on the right side of the newest selected node. |
| :warning: <kbd>cmd</kbd> + <kbd>a</kbd> | Select all nodes. |
| :warning: <kbd>escape</kbd> | Deselect all nodes (if not in a mode, like edit mode). |
| <kbd>shift</kbd> + <kbd>ctrl</kbd> + <kbd>LMB</kbd> click node name | Add node to the selection group. |
| :warning: <kbd>shift</kbd> + <kbd>ctrl</kbd> + <kbd>LMB</kbd> drag background | Add nodes to the selection group. |
| <kbd>shift</kbd> + <kbd>alt</kbd> + <kbd>LMB</kbd> click node name | Remove node to the selection group. |
| :warning: <kbd>shift</kbd> + <kbd>alt</kbd> + <kbd>LMB</kbd> drag background | Remove nodes to the selection group. |
| <kbd>shift</kbd> + <kbd>ctrl</kbd> + <kbd>alt</kbd> + <kbd>LMB</kbd> click node name | Inverse node selection. |
| :warning: <kbd>shift</kbd> + <kbd>ctrl</kbd> + <kbd>alt</kbd> + <kbd>LMB</kbd> drag background | Inverse nodes selection. |
Exposing graph editor FRP outputs (https://github.com/enso-org/ide/pull/435) Original commit: https://github.com/enso-org/ide/commit/1f4d5fd10ec0156097dbb0d392f4320ad27cc3bf
2020-05-19 15:24:12 +03:00
Focus manager (Part 1, internal focus management) (https://github.com/enso-org/ide/pull/838) Original commit: https://github.com/enso-org/ide/commit/db6d2f20b6dea27977c3b278d333b6364b20595d
2020-10-20 05:44:35 +03:00
#### Node Editing
Improved docs with custom visualization example (https://github.com/enso-org/ide/pull/625) Original commit: https://github.com/enso-org/ide/commit/03d5d116fd1b12a30f48ad9dfd471b8469867e88
2020-07-11 04:00:26 +03:00
Update shortcuts to reflect Component Browser design docs. (#3823) When no node is edited, `Enter` creates a new one (opening Component Browser). The shortcut for entering node was changed to `cmd + Enter`
2022-10-25 20:21:12 +03:00
| Shortcut | Action |
| ------------------------------------------------ | ----------------------------------------------------------- |
Change shortcut for opening Component Browser to `enter` (#7527) This was meant to be a trivial change, but actually a dirty workaround needed to be applied. Because enter is used to both open searcher and accept input/entry, both actions were fired at once. I fixed it by debouncing opening searcher event (so the searcher will be opened only once key event handling is over)
2023-08-11 21:05:17 +03:00
| <kbd>enter</kbd> | Open Component Browser to create a new node . |
Update shortcuts to reflect Component Browser design docs. (#3823) When no node is edited, `Enter` creates a new one (opening Component Browser). The shortcut for entering node was changed to `cmd + Enter`
2022-10-25 20:21:12 +03:00
| <kbd>backspace</kbd> or <kbd>delete</kbd> | Remove selected nodes. |
| <kbd>cmd</kbd>+<kbd>g</kbd> | Collapse (group) selected nodes. |
| <kbd>cmd</kbd>+<kbd>LMB</kbd> | Start editing node expression. |
| <kbd>cmd</kbd>+<kbd>enter</kbd> | Start editing node expression. |
| <kbd>enter</kbd> or <kbd>LMB</kbd> on suggestion | Pick selected suggestion and commit editing. |
| <kbd>cmd</kbd> + <kbd>enter</kbd> | Accept the current Component Browser expression input as-is |
| <kbd>tab</kbd> | Pick selected suggestion and continue editing. |
Improved docs with custom visualization example (https://github.com/enso-org/ide/pull/625) Original commit: https://github.com/enso-org/ide/commit/03d5d116fd1b12a30f48ad9dfd471b8469867e88
2020-07-11 04:00:26 +03:00
Labels on nodes should reflect function argument names (https://github.com/enso-org/ide/pull/856) Original commit: https://github.com/enso-org/ide/commit/49bdc4e83bb6bcc2c221cc3d43635d09b5410b1f
2020-10-21 11:59:58 +03:00
#### Visualization
Focus manager (Part 1, internal focus management) (https://github.com/enso-org/ide/pull/838) Original commit: https://github.com/enso-org/ide/commit/db6d2f20b6dea27977c3b278d333b6364b20595d
2020-10-20 05:44:35 +03:00
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
| Shortcut | Action |
| ----------------------------------------- | ------------------------------------------------------------- |
| <kbd>space</kbd> | Toggle visualization visibility of the selected node. |
| <kbd>space</kbd> hold | Preview visualization of the selected node (hide on release). |
| :warning: <kbd>space</kbd> double press | Toggle visualization fullscreen mode |
| <kbd>ctrl</kbd> + <kbd>space</kbd> | Cycle visualizations of the selected node. |
| :bangbang: <kbd>cmd</kbd> + <kbd>\\</kbd> | Toggle documentation view visibility |
Improved docs with custom visualization example (https://github.com/enso-org/ide/pull/625) Original commit: https://github.com/enso-org/ide/commit/03d5d116fd1b12a30f48ad9dfd471b8469867e88
2020-07-11 04:00:26 +03:00
Scatterplot visualization (https://github.com/enso-org/ide/pull/810) Original commit: https://github.com/enso-org/ide/commit/60501a611d9a69aae510360ac65db9740ec3b3c3
2020-11-02 23:59:27 +03:00
#### Visualizations Implementations
Update shortcuts to reflect Component Browser design docs. (#3823) When no node is edited, `Enter` creates a new one (opening Component Browser). The shortcut for entering node was changed to `cmd + Enter`
2022-10-25 20:21:12 +03:00
| Shortcut | Action |
| ----------------------------- | -------------------------------------------------- |
| <kbd>cmd</kbd> + <kbd>a</kbd> | Show all points if available in visualization. |
| <kbd>cmd</kbd> + <kbd>z</kbd> | Zoom into selection if available in visualization. |
Scatterplot visualization (https://github.com/enso-org/ide/pull/810) Original commit: https://github.com/enso-org/ide/commit/60501a611d9a69aae510360ac65db9740ec3b3c3
2020-11-02 23:59:27 +03:00
Labels on nodes should reflect function argument names (https://github.com/enso-org/ide/pull/856) Original commit: https://github.com/enso-org/ide/commit/49bdc4e83bb6bcc2c221cc3d43635d09b5410b1f
2020-10-21 11:59:58 +03:00
#### Debug
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
| Shortcut | Action |
Fix shortcuts table formatting (#6644)
2023-05-11 15:05:51 +03:00
| ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
Reloading file in LS after desynchronization. (#6752) Fixes #5203 This PR changes behavior when `text/applyChange` returned error. Before we always assumed that the change was _not_ applied, and tried to send full synchronization still assuming old file content. But this was not the case on some errors (timeouts for example). Now we instead reopen the file (getting its actual content) and then make a full invalidation. Also added a shortcut allowing manual file reloading, what may be useful in some kinds of error (and also allowed me testing of reopening file in the application). # Important Notes The unit tests of sending text updates were improved: now we actually check if all expected messages are emitted from the IDE.
2023-05-23 11:19:27 +03:00
| <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>x</kbd> | Force reloading file in the backend. May fix some issues with synchronization if they appear. |
Debug Mode for Graph Editor (#3264)
2022-02-14 13:19:08 +03:00
| <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>d</kbd> | Toggle Debug Mode. All actions below are only possible when it is activated. |
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
| <kbd>ctrl</kbd> + <kbd>alt</kbd> + <kbd>shift</kbd> + <kbd>i</kbd> | Open the developer console. |
| <kbd>ctrl</kbd> + <kbd>alt</kbd> + <kbd>shift</kbd> + <kbd>r</kbd> | Reload the visual interface. |
| <kbd>ctrl</kbd> + <kbd>alt</kbd> + <kbd>0 - 10</kbd> | Switch between debug rendering modes (0 is the normal mode). |
| <kbd>ctrl</kbd> + <kbd>alt</kbd> + <kbd>`</kbd> | Toggle profiling monitor (performance, memory usage, etc). |
Add a shortcut to toggle the visibility of private components in the component browser (#5582) Closes #4962 This PR adds the `cmd+alt+p` shortcut to toggle the visibility of components with a "PRIVATE" tag in the component browser. The default is to have these private components hidden. https://user-images.githubusercontent.com/117099775/219106357-0b14a5b5-404f-44dd-b30c-5389054683a7.mp4
2023-02-21 00:24:51 +03:00
| <kbd>ctrl</kbd> + <kbd>alt</kbd> + <kbd>p</kbd> | Toggle the visibility of internal components (private API) in the component browser. |
Introducing single config for prettier and applying it across the codebase. (#3141)
2021-11-05 14:51:43 +03:00
| <kbd>ctrl</kbd> + <kbd>d</kbd> | Send test data to the selected node. |
| <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>enter</kbd> | Push a hardcoded breadcrumb without navigating. |
| <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>arrow up</kbd> | Pop a breadcrumb without navigating. |
| <kbd>cmd</kbd> + <kbd>i</kbd> | Reload visualizations. To see the effect in the currently shown visualizations, you need to switch to another and switch back. |
Fix shortcuts table formatting (#6644)
2023-05-11 15:05:51 +03:00
| <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>b</kbd> | Toggle read-only mode. |
Reference in New Issue Copy Permalink