Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KeybindingWidget

Hierarchy

  • ReactWidget
    • KeybindingWidget

Index

Constructors

constructor

  • Parameters

    • Optional options: IOptions

    Returns KeybindingWidget

Properties

Protected Readonly commandRegistry

commandRegistry: CommandRegistry

Protected Readonly fuzzyOptions

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

Protected items

items: KeybindingItem[] = []

The list of all available keybindings.

Protected Readonly keybindingRegistry

keybindingRegistry: KeybindingRegistry

Protected Readonly keybindingSeparator

keybindingSeparator: RegExp = ...

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

Protected Readonly keymapsService

keymapsService: KeymapsService

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean>

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean>

Readonly onDidDispose

onDidDispose: Event<void>

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void>

Readonly onDidUpdate

onDidUpdate: Event<void> = ...

Protected Readonly onDidUpdateEmitter

onDidUpdateEmitter: Emitter<void> = ...

Protected Readonly onRender

onRender: DisposableCollection

Readonly onScrollUp

onScrollUp: Event<void>

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void>

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void>

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void>

Protected query

query: string = ''

The current user search query.

Protected Readonly regexp

regexp: RegExp = ...

The regular expression used to extract values between fuzzy results.

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected Readonly searchKeybindings

searchKeybindings: () => void = ...

Search keybindings.

Type declaration

    • (): void
    • Returns void

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection

Static Readonly ID

ID: "keybindings.view.widget" = 'keybindings.view.widget'

Static Readonly LABEL

LABEL: "Keyboard Shortcuts" = 'Keyboard Shortcuts'

Methods

Protected addClipboardListener

  • addClipboardListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>): void
  • Type parameters

    • K: "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • listener: EventListenerOrEventListenerObject<K>

    Returns void

Protected addEventListener

  • addEventListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>, useCapture?: boolean): void
  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • listener: EventListenerOrEventListenerObject<K>
    • Optional useCapture: boolean

    Returns void

Protected addKeyListener

  • addKeyListener<K>(element: HTMLElement, keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[], action: (event: KeyboardEvent) => boolean | void | Object, ...additionalEventTypes: K[]): void
  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]
    • action: (event: KeyboardEvent) => boolean | void | Object
        • (event: KeyboardEvent): boolean | void | Object
        • Parameters

          • event: KeyboardEvent

          Returns boolean | void | Object

    • Rest ...additionalEventTypes: K[]

    Returns void

Protected addUpdateListener

  • addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: boolean): void
  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • Optional useCapture: boolean

    Returns void

Protected buildCellData

  • buildCellData(raw: string): CellData[]

clearFlag

  • clearFlag(flag: Flag): void
  • Parameters

    • flag: Flag

    Returns void

clearSearch

  • clearSearch(): void

Protected compareItem

  • 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.

Protected confirmResetKeybinding

Protected disableScrollBarFocus

  • disableScrollBarFocus(scrollContainer: HTMLElement): void
  • Parameters

    • scrollContainer: HTMLElement

    Returns void

dispose

  • dispose(): void
  • Returns void

Protected doSearchKeybindings

  • doSearchKeybindings(): void

Protected editKeybinding

Protected findSearchField

  • findSearchField(): null | HTMLInputElement

Protected focusInputField

  • focusInputField(): void

Protected getCommandLabel

  • getCommandLabel(command: Command): string

Protected getContextLabel

  • getContextLabel(keybinding: undefined | ScopedKeybinding): undefined | string

Protected getItems

Protected getKeybindingLabel

  • getKeybindingLabel(keybinding: undefined | ScopedKeybinding): undefined | string

Protected getScopeLabel

  • getScopeLabel(keybinding: undefined | ScopedKeybinding): undefined | string

Protected getScrollContainer

  • getScrollContainer(): MaybePromise<HTMLElement>
  • Returns MaybePromise<HTMLElement>

hasSearch

  • hasSearch(): boolean

Protected init

  • init(): void

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void
  • Parameters

    • msg: Message

    Returns void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void
  • Parameters

    • msg: Message

    Returns void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void
  • Parameters

    • msg: Message

    Returns void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void
  • Parameters

    • msg: Message

    Returns void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void
  • Parameters

    • msg: Message

    Returns void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void
  • Parameters

    • msg: Message

    Returns void

Protected render

  • render(): ReactNode

Protected renderActions

Protected renderEdit

Protected renderKeybinding

  • renderKeybinding(keybinding: string): ReactNode

Protected renderMatchedData

  • renderMatchedData(property: string): ReactNode

Protected renderMessage

  • renderMessage(): ReactNode

Protected renderReset

Protected renderRow

Protected renderRows

  • renderRows(): ReactNode

Protected renderSearch

  • renderSearch(): ReactNode

Protected renderTable

  • renderTable(): ReactNode

Protected resetKeybinding

setFlag

  • setFlag(flag: Flag): void
  • Parameters

    • flag: Flag

    Returns void

Protected validateKeybinding

  • 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.