Wagtail client-side components
    Preparing search index...

    Interface ComboBoxProps<ComboBoxOption>

    interface ComboBoxProps<ComboBoxOption> {
        getItemDescription: (item: ComboBoxOption) => string | null | undefined;
        getItemLabel: (
            type: string | undefined,
            item: ComboBoxOption,
        ) => string | null | undefined;
        getSearchFields: (item: ComboBoxOption) => (string | null | undefined)[];
        inputValue?: string;
        items: ComboBoxCategory<ComboBoxOption>[];
        label?: string;
        noResultsText?: string;
        onSelect: (change: UseComboboxStateChange<ComboBoxOption>) => void;
        placeholder?: string;
    }

    Type Parameters

    • ComboBoxOption
    Index

    Properties

    getItemDescription: (item: ComboBoxOption) => string | null | undefined
    getItemLabel: (
        type: string | undefined,
        item: ComboBoxOption,
    ) => string | null | undefined
    getSearchFields: (item: ComboBoxOption) => (string | null | undefined)[]
    inputValue?: string
    label?: string
    noResultsText?: string
    onSelect: (change: UseComboboxStateChange<ComboBoxOption>) => void
    placeholder?: string