Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

ComboboxSearch

Searches a fixed option list using DARTWIC's standard host-owned combobox.

Import

import { ComboboxSearch } from "@dartwic/interface-sdk/ui";

Declaration

export const ComboboxSearch: HostComponent<ComboboxSearchProps>;

ComboboxSearchProps

Props for the standard host-owned searchable list selector.

export interface ComboboxSearchProps extends HostComponentProps {
    items: ComboboxSearchItem[];
    initialValue?: string;
    placeholder?: string;
    commandSearchPlaceholder?: string;
    commandSearchEmptyPlaceholder?: string;
    overrideValue?: HostNode;
    onSelect?: (value: string) => void;
    unSelectable?: boolean;
    popoverContentClassName?: string;
}

Prop	Type	Requirement	Description
`items`	`ComboboxSearchItem[]`	Required
`initialValue`	`string`	Optional
`placeholder`	`string`	Optional
`commandSearchPlaceholder`	`string`	Optional
`commandSearchEmptyPlaceholder`	`string`	Optional
`overrideValue`	`HostNode`	Optional
`onSelect`	`(value: string) => void`	Optional
`unSelectable`	`boolean`	Optional
`popoverContentClassName`	`string`	Optional
`className`	`string`	Optional	Additional Tailwind or host CSS classes.
`children`	`HostNode`	Optional	Child content rendered by the host component.
`id`	`string`	Optional	Optional DOM identifier.
`style`	`Record<string, unknown>`	Optional	Inline style values passed to the host component.