Function Command

Parameters

• __namedParameters: Children & Pick<
      Pick<
          DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
          "key" | (keyof HTMLAttributes<HTMLDivElement>),
      > & { ref?: Ref<HTMLDivElement> } & { asChild?: boolean },
      "key" | (keyof HTMLAttributes<HTMLDivElement>) | "asChild",
  > & {
      defaultValue?: string;
      disablePointerSelection?: boolean;
      filter?: CommandFilter;
      label?: string;
      loop?: boolean;
      onValueChange?: (value: string) => void;
      shouldFilter?: boolean;
      value?: string;
      vimBindings?: boolean;
  } & RefAttributes<HTMLDivElement>

  • OptionaldefaultValue?: string

    Optional default item value when it is initially rendered.

  • OptionaldisablePointerSelection?: boolean

    Optionally set to true to disable selection via pointer events.

  • Optionalfilter?: CommandFilter

    Custom filter function for whether each command menu item should matches the given search query. It should return a number between 0 and 1, with 1 being the best match and 0 being hidden entirely. By default, uses the command-score library.

  • Optionallabel?: string

    Accessible label for this command menu. Not shown visibly.

  • Optionalloop?: boolean

    Optionally set to true to turn on looping around when using the arrow keys.

  • OptionalonValueChange?: (value: string) => void

    Event handler called when the selected item of the menu changes.

  • OptionalshouldFilter?: boolean

    Optionally set to false to turn off the automatic filtering and sorting. If false, you must conditionally render valid items based on the search query yourself.

  • Optionalvalue?: string

    Optional controlled state of the selected command menu item.

  • OptionalvimBindings?: boolean

    Set to false to disable ctrl+n/j/p/k shortcuts. Defaults to true.