Command Palette
Filterable command overlay. Set the commands property, then open with the button or ⌘/Ctrl + K. Arrow keys navigate, Enter runs, Esc closes.
Preview
Commands are set in a script: el.commands = [{ id, label, group, action }, …].
<button id="open-cmdk">Open command palette</button>
<esa-command-palette id="cmdk"></esa-command-palette> import { Component, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
import '@esa/ecology/esa-command-palette';
@Component({
selector: 'app-command-palette-demo',
standalone: true,
schemas: [CUSTOM_ELEMENTS_SCHEMA],
template: `
<button id="open-cmdk">Open command palette</button>
<esa-command-palette id="cmdk"></esa-command-palette>
`,
})
export class CommandPaletteDemo {} API
| Prop | Type | Default | Description |
|---|---|---|---|
commands | EsaCommand[] | [] | Command registry, set as a property. Each: { id, label, description?, shortcut?, group?, keywords?, disabled?, action }. |
open | boolean | false | Reflected open state. |
hotkey | boolean | true | Registers the global Cmd/Ctrl+K toggle listener. On by default. Write `="false"` to turn it off — unusually for a boolean attribute, this one reads the value. |
Methods
| Prop | Type | Default | Description |
|---|---|---|---|
show() | method | — | Opens the palette, clears the query, and focuses the input. |
close() | method | — | Closes the palette. |
toggle() | method | — | Toggles open state — also bound to Cmd/Ctrl+K. |
Selecting a command runs its action callback, then closes the palette — there is no separate event.
Accessibility
- The overlay is
role="dialog"; the results list isrole="listbox"withrole="option"items andaria-selected. - ArrowUp / ArrowDown move the active option (wrapping), Enter executes, Esc closes.
- The search input is focused automatically when the palette opens.
Theming surface
Every public token this component reads, extracted from its source at build time,
split by blast radius: the hooks that belong to this component,
then the shared and system tokens it consumes alongside everything else. The
Resolves to column walks each token's real lineage —
component → semantic → primitive → raw value — so you
can see exactly where re-pointing it lands. A spoke re-skins by overriding these in
its theme-<slug>.css; component internals are never edited. No
hook for what you need? File it with /request-lego.
Type roles it names
This component does not set a size, weight, face or tracking of its own — it names a composite, and the composite carries all five. A composite is a class rather than a token, so none of it appears in the tables below; re-theme text by re-pointing the token family, not by editing the component.
| Role | Re-point | Reach |
|---|---|---|
.typography-body-md |
| +28 more componentsesa-app-shell, esa-breadcrumbs, esa-card, esa-checkbox, esa-checkbox-group, esa-collapsible, esa-combobox, esa-confirm-dialog, esa-container, esa-danger-zone, esa-dialog, esa-dropdown-menu, esa-empty-state, esa-entity-search, esa-form-field, esa-header-nav, esa-input-tag, esa-nav-dropdown, esa-page-header, esa-popover, esa-progress-bar, esa-radio-group, esa-select, esa-side-dialog, esa-snackbar-item, esa-switch-toggle, esa-tab-layout, esa-textarea |
.typography-body-sm |
| +20 more componentsesa-alert-box, esa-breadcrumbs, esa-button-toggle, esa-card, esa-checkbox-group, esa-combobox, esa-date-picker, esa-empty-state, esa-file-upload, esa-form-field, esa-input-tag, esa-link-column, esa-loading-overlay, esa-progress-bar, esa-radio-group, esa-search-panel, esa-select, esa-stat, esa-text-field, esa-textarea |
.typography-body-xs |
| +14 more componentsesa-breadcrumbs, esa-checkbox, esa-checkbox-group, esa-combobox, esa-empty-state, esa-entity-search, esa-field-error, esa-header-nav, esa-input-tag, esa-progress-bar, esa-radio-group, esa-search-panel, esa-select, esa-textarea |
.typography-eyebrow-md |
| +3 more componentsesa-entity-search, esa-search-panel, esa-sidebar-nav |
.typography-label-md |
| +33 more componentsesa-app-bar, esa-breadcrumbs, esa-button-group, esa-button-toggle, esa-card, esa-checkbox-group, esa-color-picker, esa-combobox, esa-confirm-dialog, esa-danger-zone, esa-date-picker, esa-dialog, esa-empty-state, esa-entity-search, esa-file-upload, esa-filter-container, esa-form-field, esa-header-nav, esa-input-tag, esa-link-column, esa-page-header, esa-pillbox, esa-popover, esa-progress-bar, esa-radio-group, esa-range-slider, esa-select, esa-side-dialog, esa-sidebar-nav, esa-stat, esa-text-field, esa-textarea, esa-tooltip |
.typography-microcopy-lg-subtle |
| +7 more componentsesa-combobox, esa-date-picker, esa-entity-search, esa-filter-dropdown, esa-input-tag, esa-select, esa-text-field |
Wired to this component
No other component reads these — re-point them and esa-command-palette is the
only thing that moves.
| Token | Tier | Resolves to |
|---|---|---|
--command-palette-max-height | component | 440px |
--command-palette-width | component | 560px |
Shared tokens it reads
Owned by a family or by the semantic layer. Still overridable — but scope the
override (esa-foo { --form-border-color: … }) unless you mean to move
everything that reads it. Reach says what else that is.
| Token | Reach | Resolves to |
|---|---|---|
--focus-ring-color | component focus ring group · +34 more | #3e9b4f via --color-border-default-focus → --color-grass-10 |
--focus-ring-offset | component focus ring group · +31 more | 2px |
--focus-ring-width | component focus ring group · +35 more | 2px via --border-width-focus → --border-width-200 |
--animation-enter | semantic every component | 150ms via --duration-150 |
--border-width-default | semantic every component | 1px via --border-width-100 |
--color-background-elevation-floating | semantic every component | #fcfcfc via --color-gray-1 |
--color-background-elevation-sunken | semantic every component | #f0f0f0 via --color-gray-3 |
--color-background-overlay-backdrop | semantic every component | rgba(0, 0, 0, 0.5) via --color-black-a-7 |
--color-border-default | semantic every component | one role per property, so a theme can move the ring's weight and its colour independently. Tier 3's --focus-ring-width now reads this instead of holding a bare 2px, which is the same shape --focus-ring-color has always had (a thin tier-3 alias over a tier-2 role) — width was simply never given the tier-2 half.
*
* This role was rejected once, and the rejection is worth recording because its PREMISE was wrong rather than its reasoning. The argument against an `emphasis` width was that every 2px border in the kit is micro-geometry — spinner rings, the kbd keycap lip, a chevron. The focus ring was not in that enumeration and does not fit it: 33 components render it, more than read any other tier-3 token, and it is not micro-geometry but an accessibility affordance whose weight is a legitimate brand axis (a spoke that needs a heavier ring for contrast has to be able to reach it). It is also not a `border` in any component — every consumer paints it with `outline` or `box-shadow` — which is precisely why a survey of BORDERS missed it. The name still says `border` because tier 2 already calls the ring's colour --color-border-default-focus |
--color-border-default-subtle | semantic every component | #d9d9d9 via --color-gray-6 |
--color-content-default | semantic every component | #202020 via --color-gray-12 |
--color-content-default-secondary | semantic every component | #646464 via --color-gray-11 |
--elevation-6 | semantic every component | 0 via --shadow-offset-x |
--radius-lg | semantic every component | 0.75rem via --radius-400 |
--radius-md | semantic every component | 0.5rem via --radius-200 |
--radius-sm | semantic every component | 0.25rem via --radius-100 |
--typography-font-family-sans | semantic every component | 'DM Sans', sans-serif via --font-family-dm-sans |
--spacing-100 | primitive every component | 0.25rem |
--spacing-200 | primitive every component | 0.5rem |
--spacing-300 | primitive every component | 0.75rem |
--spacing-400 | primitive every component | 1rem |
--spacing-600 | primitive every component | 2rem |