Skip to content

Keymap

Manages keymap lifecycle for different Scopes.

Constructors

new Keymap()

new Keymap(): Keymap

Returns

Keymap

Methods

popScope()

popScope(scope): void

Remove a scope from the scope stack. If the given scope is active, the next scope in the stack will be made active.

Parameters

scope: Scope

Returns

void


pushScope()

pushScope(scope): void

Push a scope onto the scope stack, setting it as the active scope to handle all key events.

Parameters

scope: Scope

Returns

void


isModEvent()

static isModEvent(evt?): boolean | PaneType

Translates an event into the type of pane that should open. Returns ‘tab’ if the modifier key Cmd/Ctrl is pressed OR if this is a middle-click MouseEvent. Returns ‘split’ if Cmd/Ctrl+Alt is pressed. Returns ‘window’ if Cmd/Ctrl+Alt+Shift is pressed.

Parameters

evt?: null | UserEvent

Returns

boolean | PaneType


isModifier()

static isModifier(evt, modifier): boolean

Checks whether the modifier key is pressed during this event.

Parameters

evt: MouseEvent | KeyboardEvent | TouchEvent

modifier: Modifier

Returns

boolean