SearchCmdk

In progress
ARIA
RTL

Command menu search can be used as an accessible combobox. You render items, it filters and sorts them automatically.

SearchCmdk

Search Cmdk

Anatomy

<SearchCmdk.Trigger>
  <SearchCmdk.TriggerIcon />
  ...
  <SearchCmdk.TriggerKbd />
</SearchCmdk.Trigger>

<SearchCmdk>
  <SearchCmdk.InputWrapper>
    <SearchCmdk.Icon />
    <SearchCmdk.Input />
    <SearchCmdk.Kbd />
  </SearchCmdk.InputWrapper>

  <SearchCmdk.Separator />

  <SearchCmdk.Result>
    <SearchCmdk.NoResults />
    <SearchCmdk.ResultItem>
      ...
    </SearchCmdk.ResultItem>
  </SearchCmdk.Result>
</SearchCmdk>

SearchCmdk props

NameTypeRequiredDefaultDescription
openbooleanYes-Whether the SearchCmdk is open or not.
onOpenChange(open: boolean) => voidYes-The function to call when SearchCmdk is open or closed.
labelstringNoLabel title
classNamestringNoTailwind classes for customization

SearchCmdk.InputWrapper props

NameTypeRequiredDefaultDescription
classNamestringNoTailwind classes for customization

SearchCmdk.Input props

NameTypeRequiredDefaultDescription
classNamestringNoTailwind classes for customization
placeholderstringNoPlaceholder for input

SearchCmdk.Icon props

NameTypeRequiredDefaultDescription
classNamestringNoTailwind classes for customization

SearchCmdk.Separator props

NameTypeRequiredDefaultDescription
classNamestringNoTailwind classes for customization

SearchCmdk.Result props

NameTypeRequiredDefaultDescription
classNamestringNoTailwind classes for customization

SearchCmdk.NoResults props

NameTypeRequiredDefaultDescription
classNamestringNoTailwind classes for customization

SearchCmdk.ResultItem props

NameTypeRequiredDefaultDescription
classNamestringNoTailwind classes for customization
onSelect(value: string) => voidNoThe function to call when ResultItem is selected.

SearchCmdk.Kbd props

NameTypeRequiredDefaultDescription
classNamestringNoTailwind classes for customization

SearchCmdk.Overlay props

NameTypeRequiredDefaultDescription
classNamestringNoTailwind classes for customization