Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ReactWidget
    • KeybindingWidget

Implements

  • StatefulWidget

Index

Constructors

Properties

commandRegistry: CommandRegistry
fuzzyOptions: { post: string; pre: string } = ...

The fuzzy search options. The pre and post options are used to wrap fuzzy matches.

Type declaration

  • post: string
  • pre: string
items: KeybindingItem[] = []

The list of all available keybindings.

keybindingRegistry: KeybindingRegistry
keybindingSeparator: RegExp = ...

The regular expression used to extract values between the keybinding separator.

keymapsService: KeymapsService
onDidUpdate: Event<void> = ...
onDidUpdateEmitter: Emitter<void> = ...
onRenderCallbacks: DisposableCollection = ...
query: string = ''

The current user search query.

regexp: RegExp = ...

The regular expression used to extract values between fuzzy results.

searchKeybindings: (() => void) = ...

Type declaration

    • (): void
    • Search keybindings.

      Returns void

updateItemsAndRerender: DebouncedFunc<(() => void)> = ...
ID: "keybindings.view.widget" = 'keybindings.view.widget'
LABEL: string = ...

Methods

  • clearSearch(): void
  • compareItem(a: Command, b: Command): number
  • Compare two commands.

    • Commands with a label should be prioritized and alphabetically sorted.
    • Commands without a label (id) should be placed at the bottom.

    Parameters

    • a: Command

      the first command.

    • b: Command

      the second command.

    Returns number

    an integer indicating whether a comes before, after or is equivalent to b.

    • returns -1 if a occurs before b.
    • returns 1 if a occurs after b.
    • returns 0 if they are equivalent.
  • createKeybindingItem(command: Command, keybinding?: ScopedKeybinding): KeybindingItem
  • doSearchKeybindings(): void
  • findSearchField(): null | HTMLInputElement
  • focusInputField(): void
  • formatAndMatchKeybinding(item: KeybindingItem, queryItems: string[]): boolean
  • getCommandLabel(command: Command): string
  • getContextLabel(keybinding: undefined | ScopedKeybinding): undefined | string
  • getKeybindingLabel(keybinding: undefined | ScopedKeybinding): undefined | string
  • getScopeLabel(keybinding: undefined | ScopedKeybinding): undefined | string
  • hasSearch(): boolean
  • init(): void
  • onActivateRequest(msg: Message): void
  • onRender(): void
  • render(): ReactNode
  • renderMessage(): ReactNode
  • renderRows(): ReactNode
  • renderSearch(): ReactNode
  • renderTable(): ReactNode
  • restoreState(oldState: { query: string }): void
  • storeState(): undefined | object
  • validateKeybinding(command: string, oldKeybinding: undefined | string, keybinding: string): string
  • Validate the provided keybinding value against its previous value.

    Parameters

    • command: string

      the command label.

    • oldKeybinding: undefined | string

      the old keybinding value.

    • keybinding: string

      the new keybinding value.

    Returns string

    the end user message to display.