Circle V2 API Docs
    Preparing search index...

    Type Alias ComboboxProps

    ComboboxProps: Omit<ComboboxRootProps<ComboboxItem>, "collection"> & {
        filterable?: boolean;
        footer?: (
            picker: { clearFilter: () => void; close: () => void },
        ) => React.ReactNode;
        inDialog?: boolean;
        items: ComboboxItem[];
        placeholder?: string;
        portalled?: boolean;
        ref?: React.Ref<HTMLDivElement>;
    }

    Type Declaration

    • Optionalfilterable?: boolean

      When true, filters items by the typed input (client-side).

    • Optionalfooter?: (picker: { clearFilter: () => void; close: () => void }) => React.ReactNode

      Rendered under the items, for actions like "Add entry".

    • OptionalinDialog?: boolean

      Use when rendering inside a Dialog/Drawer. Disables portalling and applies fixed positioning so the dropdown isn't clipped.

    • items: ComboboxItem[]
    • Optionalplaceholder?: string
    • Optionalportalled?: boolean

      Renders inside a portal by default. Set to false to inline.

    • Optionalref?: React.Ref<HTMLDivElement>