Context

Context is application state that determines which commands are active. It's evaluated on every key/mouse event.

Providing Context

Pass a getter function as the second argument to keybinds():

keybinds(commands, () => ({
  hasSelection: selectedItems.length > 0,
  isEditing: editMode === true,
  canUndo: history.length > 0,
}), { inputs: [keys()] })

The function is called on every event, so it always reflects current state.

Using Context in Commands

The when function receives context and returns a boolean:

{
  id: 'delete',
  keys: ['Backspace'],
  when: ctx => ctx.hasSelection && !ctx.isEditing,
  execute: () => deleteSelected()
}

Commands without when are always active.

Context in Execute

The execute function also receives context:

{
  id: 'copy',
  keys: ['$mod+c'],
  when: ctx => ctx.hasSelection,
  execute: (ctx) => {
    copyToClipboard(ctx.selectedItems)
  }
}

Patterns

Modal interfaces

const getContext = () => ({
  mode: currentMode,  // 'normal', 'insert', 'visual'
})

const commands = [
  { id: 'enterInsert', keys: ['i'], when: ctx => ctx.mode === 'normal', ... },
  { id: 'exitInsert', keys: ['Escape'], when: ctx => ctx.mode === 'insert', ... },
]

Focus-aware

const getContext = () => ({
  focusedPanel: document.activeElement?.closest('[data-panel]')?.dataset.panel,
})

const commands = [
  { id: 'closePanel', keys: ['Escape'], when: ctx => ctx.focusedPanel != null, ... },
]

Feature flags

const getContext = () => ({
  canEdit: user.permissions.includes('edit'),
  experimentalFeatures: settings.experimental,
})

Components and Context

Pass context to components to gray out inactive commands:

const palette = document.querySelector('keybinds-command-palette')
palette.commands = commands
palette.context = getContext()  // Commands with failing `when` appear disabled

Update context when state changes:

function updatePaletteContext() {
  palette.context = getContext()
}