Keyboard shortcuts
A dialog listing keyboard shortcuts by group.
Guidance
The keyboard shortcuts dialog lists every shortcut, grouped (Global, Navigation, Query editor,
Lineage, Tables), as a two-column table of what it does and its keys. Keys are formatted for the
platform: ⌘ on macOS and iOS, Ctrl elsewhere. A filter at the top matches descriptions,
groups and key names.
Set global-shortcut to open it with "?" from anywhere, except while typing in a text field, an
editor or a combobox. Open it from the command palette's "Show keyboard shortcuts" command with
show(). It opens instantly because it is opened from the keyboard. Escape closes it and focus
returns to where it was.
Properties
| Property | Attribute | Type | Default | Description |
|---|---|---|---|---|
open | open | boolean | false | |
inline | inline | boolean | false | Renders the panel in place instead of as a modal, for documentation. |
shortcuts | Shortcut[] | The shortcuts to list. Defaults to the Marmot set from defaultShortcuts(). | ||
globalShortcut | global-shortcut | boolean | false | Open with "?" when focus is not in a text field. |
dialogTitle | dialog-title | string | '' |
Events
| Event | Detail | Description |
|---|---|---|
mm-open | CustomEvent<null> | When the dialog opens. |
mm-close | CustomEvent<null> | When the dialog closes. |
CSS parts
| Part | Description |
|---|---|
panel | The dialog. |
filter | The filter input. |
table | Each group's table. |
Examples
Every state of mm-shortcut-help in Storybook, with keyboard and screen reader tests.