Skip to content
@ng-doc/app / Interface

NgDocShortcut

A keyboard shortcut registered with the NgDocShortcutsService.

DeclarationTypeScript
export interface NgDocShortcut { … }

Members

Properties

3
chord?: boolean | undefined

Whether the shortcut is a chord with the Command key (macOS) or the Control key (elsewhere). Chords always work: in text fields too, and when single-key shortcuts are turned off. Other shortcuts are single keys: they run only while single-key shortcuts are on, never while the reader types in a field, and never with Command, Control or Alt held.

handler: (event?: KeyboardEvent | undefined) => void

Runs the shortcut. The default action of the keyboard event is prevented before it runs. The event is missing when the shortcut runs from the search palette.

key: string

The key that runs the shortcut, compared with the key of the keyboard event without regard to case, for example '/', '[' or 'f'.

Symbol
Kind
Interface
Scope
@ng-doc/app
Edit this page