HelixOverviewDocsComponentsSandboxTheme builderCortexDocsEngramBuildingTraceBuildingRecallDeclaredServicesInsightsGet in touchSource on GitHub
Loading the reference
CommandView SourceEdit in SandboxView MarkdownCopy MarkdownOpen in ClaudeOpen in CursorA list of commands, opened from anywhere and filtered by typing.StableSince 0.1.0NavigationUsageimport'@fusion.dev/helix/command'import'@fusion.dev/helix-headless/command'Preview
API ReferenceRoothelix-commandA list of commands, opened from anywhere and filtered by typing.
PropTypeDefaultDescriptiondefaultOpenbooleanfalseInitial open state for uncontrolled use, where nothing declared one.emptyTextstring"No commands"Words shown where the filter has matched nothing.hotkeystring"mod+k"The key that opens it, as `mod+k` or `shift+p` or plain `k`.labelstring"Commands"Accessible name for the overlay, which has no visible heading.openbooleanWhether the element is open.placeholderstring"Search commands"Shown in the field before anything is typed.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The commands, which are `helix-option` elements and their groups.footerUnder the list, for the keys a reader can press.
EventTypeDescriptionhelix-before-closeHelixBeforeCloseEventFired before it closes. Cancelable: refusing it takes the decision and nothing moves.helix-before-openHelixBeforeOpenEventFired before the palette opens. Cancelable: refusing it takes the decision and nothing moves.helix-selectHelixSelectEventFired when a command is chosen. Cancelable: refusing it takes the decision and nothing moves.toggleEventSays the state moved, carrying `newState` and `oldState`.
MethodTypeDescriptionrequestOpen(next: boolean) => booleanRequests an open-state change, and reports whether it was applied.toggleOpen() => booleanRequests the opposite of the current state.
PartDescriptiondialogThe overlay's own box, forwarded from the dialog.footerThe row under the list.listboxThe list inside it.listbox-emptyShown when a filter has hidden everything.listbox-feedbackWhat is wrong with it.listbox-filter-iconThe mark beside that field.listbox-filter-markThe glyph beside the filter field, where none is slotted.listbox-hintHelp under the list.listbox-itemsThe list itself.listbox-labelThe question, over the list.listbox-loadingShown while the options are still on their way.listbox-searchThe region holding the field that narrows the list.listbox-search-fieldThe field itself.
CSS PropertyDescription--command-list-sizeHow tall the list grows before it scrolls.--command-sizeHow wide the palette is. Defaults to `40rem`.
Roothelix-headless-commandA list of commands, opened from anywhere and filtered by typing.
PropTypeDefaultDescriptiondefaultOpenbooleanfalseInitial open state for uncontrolled use, where nothing declared one.emptyTextstring"No commands"Words shown where the filter has matched nothing.hotkeystring"mod+k"The key that opens it, as `mod+k` or `shift+p` or plain `k`.labelstring"Commands"Accessible name for the overlay, which has no visible heading.openbooleanWhether the element is open.placeholderstring"Search commands"Shown in the field before anything is typed.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The commands, which are `helix-option` elements and their groups.footerUnder the list, for the keys a reader can press.
EventTypeDescriptionhelix-before-closeHelixBeforeCloseEventFired before it closes. Cancelable: refusing it takes the decision and nothing moves.helix-before-openHelixBeforeOpenEventFired before the palette opens. Cancelable: refusing it takes the decision and nothing moves.helix-selectHelixSelectEventFired when a command is chosen. Cancelable: refusing it takes the decision and nothing moves.toggleEventSays the state moved, carrying `newState` and `oldState`.
MethodTypeDescriptionrequestOpen(next: boolean) => booleanRequests an open-state change, and reports whether it was applied.toggleOpen() => booleanRequests the opposite of the current state.
PartDescriptiondialogThe overlay's own box, forwarded from the dialog.footerThe row under the list.listboxThe list inside it.listbox-emptyShown when a filter has hidden everything.listbox-feedbackWhat is wrong with it.listbox-filter-iconThe mark beside that field.listbox-filter-markThe glyph beside the filter field, where none is slotted.listbox-hintHelp under the list.listbox-itemsThe list itself.listbox-labelThe question, over the list.listbox-loadingShown while the options are still on their way.listbox-searchThe region holding the field that narrows the list.listbox-search-fieldThe field itself.
ExamplesNameDescriptionEventsA palette runs a command rather than holding a value, and says exactly that.HotkeyOpened by a key from anywhere on the page.OpenThe palette as it looks the moment it opens, before anything is typed.PreviewA command palette open, with its list already filtered by what is typed.PreviewA command palette open, with its list already filtered by what is typed.Two DestinationsRows carrying a second destination, taken with the modifier held.