Skip to content

Commit

Permalink
Keyboard shortcuts (#159)
Browse files Browse the repository at this point in the history
* add keyboard shortcut page and initial shortcuts

* formatting cleanup

* add simulate shortcut and tweak timeline copy
  • Loading branch information
lklyne authored Jun 7, 2024
1 parent 56143bf commit f4a4b13
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 0 deletions.
68 changes: 68 additions & 0 deletions docs/keyboard-shortcuts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: Keyboard Shortcuts
---

export const Shortcut = ({ children }) => (
<kbd
style={{
margin: '0.2rem 0rem',
}}
>
{children}
</kbd>
);

A list of keyboard shortcuts that can be used within the Aerie UI.

### Plan View

Start running simulation from anywhere in the plan view with <Shortcut>⌘</Shortcut> + <Shortcut>s</Shortcut> (MacOS) or <Shortcut>ctrl</Shortcut> + <Shortcut>s</Shortcut> (Windows).

**Timeline**

The easiest way to navigate the timeline is by holding <Shortcut>⌘</Shortcut> (MacOS) or <Shortcut>ctrl</Shortcut> (Windows) and then using <Shortcut>click</Shortcut>+<Shortcut>drag</Shortcut> to pan and <Shortcut>scroll</Shortcut> to zoom in and out.

- <Shortcut>middle mouse button</Shortcut> + <Shortcut>drag</Shortcut> pans the timeline horizontally
- <Shortcut>=</Shortcut> zooms timeline in
- <Shortcut>-</Shortcut> zooms timeline out
- <Shortcut>[</Shortcut> nudges timeline left
- <Shortcut>]</Shortcut> nudges timeline right
- <Shortcut>ctrl</Shortcut> + <Shortcut>T</Shortcut> toggles the cursor visibility
- <Shortcut>0</Shortcut> resets the timeline zoom
- <Shortcut>delete</Shortcut> or <Shortcut>backspace</Shortcut> deletes selected activity directive

<br />

**Activity Table**

- <Shortcut>delete</Shortcut> or <Shortcut>backspace</Shortcut> delete selected row from tables you have permissions to delete

<br />

**Activity Parameters**

- <Shortcut>⌘</Shortcut> + <Shortcut>left click</Shortcut> (MacOS) or <Shortcut>ctrl</Shortcut> + <Shortcut>
left click
</Shortcut> (Windows) resets paramater value to default

<br />

**Activity Error Rollup**

- <Shortcut>⌘</Shortcut> + <Shortcut>left click</Shortcut> (MacOS) or <Shortcut>ctrl</Shortcut> + <Shortcut>
left click
</Shortcut> (Windows) resets invalid parameters if possible

<br />

### Expansion Rule Form

- <Shortcut>⌘</Shortcut> + <Shortcut>s</Shortcut> (MacOS) or <Shortcut>ctrl</Shortcut> + <Shortcut>s</Shortcut> (Windows)
saves the form

<br />

### Sequence Editor

- <Shortcut>⌘</Shortcut> + <Shortcut>s</Shortcut> (MacOS) or <Shortcut>ctrl</Shortcut> + <Shortcut>s</Shortcut> (Windows)
saves the sequence
5 changes: 5 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,11 @@ const sidebars = {
],
},
'glossary',
{
label: 'Keyboard Shortcuts',
type: 'doc',
id: 'keyboard-shortcuts',
},
],
upgradeGuides: [
'upgrade-guides/2-11-0-to-2-12-0',
Expand Down

0 comments on commit f4a4b13

Please sign in to comment.