Interface: IShortcutService

The interface of the shortcut service.

Properties

Property	Type	Description	Defined in
`shortcutChanged$`	`Observable`<`void`>	An observable that emits when the shortcuts are changed.	submodules/univer/packages/ui/src/services/shortcut/shortcut.service.ts:95

forceEscape(): IDisposable

Make the shortcut service ignore all keyboard events.

a disposable that could be used to cancel the force escaping.

submodules/univer/packages/ui/src/services/shortcut/shortcut.service.ts:101

getAllShortcuts(): IShortcutItem<object>[]

Get all the shortcuts registered in the shortcut service.

all the shortcuts registered in the shortcut service.

submodules/univer/packages/ui/src/services/shortcut/shortcut.service.ts:125

getShortcutDisplay(shortcut): string

Get the display string of the shortcut item.

Parameter	Type	Description
`shortcut`	`IShortcutItem`<`object`>	the shortcut item to get the display string.

string

the display string of the shortcut. For example Ctrl+Enter.

submodules/univer/packages/ui/src/services/shortcut/shortcut.service.ts:114

getShortcutDisplayOfCommand(id): null | string

Get the display string of the shortcut of the command.

Parameter	Type	Description
`id`	`string`	the id of the command to get the shortcut display.

null | string

the display string of the shortcut. For example Ctrl+Enter.

submodules/univer/packages/ui/src/services/shortcut/shortcut.service.ts:120

registerShortcut(shortcut): IDisposable

Parameter	Type	Description
`shortcut`	`IShortcutItem`<`object`>	the shortcut item to be registered.

a disposable that could be used to unregister the shortcut.

submodules/univer/packages/ui/src/services/shortcut/shortcut.service.ts:108