Command
A command menu component that can be used to search, filter, and select items.
Structure
API Reference
The root command component which manages & scopes the state of the command.
Property | Type | Description |
---|---|---|
value bindable prop | string | The value of the command. Default: undefined |
onValueChange | function | A callback that is fired when the command value changes. Default: undefined |
label | string | An accessible label for the command menu. This is not visible and is only used for screen readers. Default: undefined |
filter | function | A custom filter function used to filter items. This function should return a number between Default: undefined |
shouldFilter | boolean | Whether or not the command menu should filter items. This is useful when you want to apply custom filtering logic outside of the Command component. Default: true |
loop | boolean | Whether or not the command menu should loop through items when navigating with the keyboard. Default: false |
disablePointerSelection | boolean | Set this to true to prevent items from being selected when the users pointer moves over them. Default: false |
vimBindings | boolean | Whether VIM bindings should be enabled or not, which allow the user to navigate using ctrl+n/j/p/k Default: true |
ref bindable prop | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to get a reference to the element. Default: undefined |
children | Snippet | The children content to render. Default: undefined |
child | Snippet | Use render delegation to render your own element. See delegation docs for more information. Default: undefined |
Data Attribute | Value | Description |
---|---|---|
data-command-root | '' | Present on the root element. |
A representation of the combobox input element, which is typically displayed in the content.
Property | Type | Description |
---|---|---|
value bindable prop | string | The value of the search query. This is used to filter items and to search for items. Default: undefined |
ref bindable prop | HTMLInputElement | The underlying DOM element being rendered. You can bind to this to get a reference to the element. Default: undefined |
children | Snippet | The children content to render. Default: undefined |
child | Snippet | Use render delegation to render your own element. See delegation docs for more information. Default: undefined |
Data Attribute | Value | Description |
---|---|---|
data-command-input | '' | Present on the input element. |
The container for the viewport and its items of the command menu.
Property | Type | Description |
---|---|---|
ref bindable prop | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to get a reference to the element. Default: undefined |
children | Snippet | The children content to render. Default: undefined |
child | Snippet | Use render delegation to render your own element. See delegation docs for more information. Default: undefined |
Data Attribute | Value | Description |
---|---|---|
data-command-list | '' | Present on the list element. |
CSS Variable | Description |
---|---|
--bits-command-list-height | The height of the command list element, which is computed by the |
The viewport component which contains the items of the command menu. This component tracks the height of the viewport and updates the --bits-command-list-height
CSS variable on the Command.List
component.
Property | Type | Description |
---|---|---|
ref bindable prop | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to get a reference to the element. Default: undefined |
children | Snippet | The children content to render. Default: undefined |
child | Snippet | Use render delegation to render your own element. See delegation docs for more information. Default: undefined |
Data Attribute | Value | Description |
---|---|---|
data-command-viewport | '' | Present on the viewport element. |
A group of items within the command menu.
Property | Type | Description |
---|---|---|
value | string | If a Default: undefined |
forceMount | boolean | Whether or not the group should always be mounted to the DOM, regardless of the internal filtering logic Default: false |
ref bindable prop | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to get a reference to the element. Default: undefined |
children | Snippet | The children content to render. Default: undefined |
child | Snippet | Use render delegation to render your own element. See delegation docs for more information. Default: undefined |
Data Attribute | Value | Description |
---|---|---|
data-command-group | '' | Present on the group element. |
A heading for a group of items within the command menu.
Property | Type | Description |
---|---|---|
ref bindable prop | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to get a reference to the element. Default: undefined |
children | Snippet | The children content to render. Default: undefined |
child | Snippet | Use render delegation to render your own element. See delegation docs for more information. Default: undefined |
Data Attribute | Value | Description |
---|---|---|
data-command-group-heading | '' | Present on the group heading element. |
The container for the items within a group.
Property | Type | Description |
---|---|---|
ref bindable prop | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to get a reference to the element. Default: undefined |
children | Snippet | The children content to render. Default: undefined |
child | Snippet | Use render delegation to render your own element. See delegation docs for more information. Default: undefined |
Data Attribute | Value | Description |
---|---|---|
data-command-group-items | '' | Present on the group items element. |
Represents a single item within the command menu. If you wish to render an anchor element to link to a page, use the Command.LinkItem
component.
Property | Type | Description |
---|---|---|
value required prop | string | The value of the item. Default: undefined |
keywords | string[] | An array of additional keywords or aliases that will be used to filter the item. Default: undefined |
forceMount | boolean | Whether or not the item should always be mounted to the DOM, regardless of the internal filtering logic Default: false |
onSelect | function | A callback that is fired when the item is selected. Default: undefined |
disabled | boolean | Whether or not the combobox item is disabled. This will prevent interaction/selection. Default: false |
ref bindable prop | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to get a reference to the element. Default: undefined |
children | Snippet | The children content to render. Default: undefined |
child | Snippet | Use render delegation to render your own element. See delegation docs for more information. Default: undefined |
Data Attribute | Value | Description |
---|---|---|
data-disabled | '' | Present when the item is disabled. |
data-selected | '' | Present when the item is selected. |
data-command-item | '' | Present on the item element. |
Similar to the Command.Item
component, but renders an anchor element to take advantage of preloading before navigation.
Property | Type | Description |
---|---|---|
value required prop | string | The value of the item. Default: undefined |
keywords | string[] | An array of additional keywords or aliases that will be used to filter the item. Default: undefined |
forceMount | boolean | Whether or not the item should always be mounted to the DOM, regardless of the internal filtering logic Default: false |
onSelect | function | A callback that is fired when the item is selected. Default: undefined |
disabled | boolean | Whether or not the combobox item is disabled. This will prevent interaction/selection. Default: false |
ref bindable prop | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to get a reference to the element. Default: undefined |
children | Snippet | The children content to render. Default: undefined |
child | Snippet | Use render delegation to render your own element. See delegation docs for more information. Default: undefined |
Data Attribute | Value | Description |
---|---|---|
data-disabled | '' | Present when the item is disabled. |
data-selected | '' | Present when the item is selected. |
data-command-item | '' | Present on the item element. |
The empty state of the command menu. Shown when there are no items to display.
Property | Type | Description |
---|---|---|
ref bindable prop | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to get a reference to the element. Default: undefined |
children | Snippet | The children content to render. Default: undefined |
child | Snippet | Use render delegation to render your own element. See delegation docs for more information. Default: undefined |
Data Attribute | Value | Description |
---|---|---|
data-command-empty | '' | Present on the empty element. |
The loading state of the command menu. Shown when the menu is loading items.
Property | Type | Description |
---|---|---|
progress | number | The progress of the loading state. Default: 0 |
ref bindable prop | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to get a reference to the element. Default: undefined |
children | Snippet | The children content to render. Default: undefined |
child | Snippet | Use render delegation to render your own element. See delegation docs for more information. Default: undefined |
Data Attribute | Value | Description |
---|---|---|
data-command-loading | '' | Present on the loading element. |
A visual separator for use between items and groups. Visible when the search query is empty or the forceMount
prop is true
.
Property | Type | Description |
---|---|---|
forceMount | boolean | Whether or not the separator should always be mounted to the DOM, regardless of the internal filtering logic Default: false |
ref bindable prop | HTMLDivElement | The underlying DOM element being rendered. You can bind to this to get a reference to the element. Default: undefined |
children | Snippet | The children content to render. Default: undefined |
child | Snippet | Use render delegation to render your own element. See delegation docs for more information. Default: undefined |
Data Attribute | Value | Description |
---|---|---|
data-command-separator | '' | Present on the separator element. |