Skip to content
EliteChart

ShortcutHelp

Documentation


Documentation / @elitechart/core / ShortcutHelp

Defined in: ui/shortcut-help.ts:105

Modal keyboard-shortcut help overlay. Opens on ?, closes on ?, Esc, or backdrop click.

Example

code
const help = new ShortcutHelp({
  mount: document.body,
  groups: DEFAULT_SHORTCUT_GROUPS,
});
// close from app code:
help.close();

Constructors

Constructor

code
new ShortcutHelp(config): ShortcutHelp;

Defined in: ui/shortcut-help.ts:111

Parameters

config

ShortcutHelpConfig

Returns

ShortcutHelp

Accessors

element

Get Signature

code
get element(): HTMLElement;

Defined in: ui/shortcut-help.ts:130

Returns

HTMLElement

Methods

close()

code
close(): void;

Defined in: ui/shortcut-help.ts:121

Returns

void