@antadesign/anta
    Preparing search index...

    Interface SelectFacetMultipleUnreviewed

    Pick any number of options. Value: an array of the chosen values (empty array clears the facet). Options are the same SelectItems as single, with the same string / number / boolean value support.

    interface SelectFacetMultiple {
        key: string;
        label: string;
        icon?: keyof IconShapes;
        kind: "multiple";
        options: SelectItem<OptionValue>[];
        filter?: FacetFilter;
        renderOption?: (
            option: SelectOption<OptionValue>,
            state: OptionState<OptionValue>,
        ) => ReactNode;
        selectAll?: boolean;
        selectAllLabel?: string;
    }

    Hierarchy

    • FacetBase
      • SelectFacetMultiple
    Index
    key label icon? kind options filter? renderOption? selectAll? selectAllLabel?
    key: string

    The key for this facet's value in the record. onValueChange reports it as attrs.facet. It must be unique across facets.

    label: string

    The facet's row label in the menu.

    icon?: keyof IconShapes

    Leading icon on the facet's row.

    kind: "multiple"
    options: SelectItem<OptionValue>[]

    The options — bare strings or SelectOptions (groups / submenus flattened).

    filter?: FacetFilter

    Add a search field atop this facet's flyout that filters its options.

    renderOption?: (
        option: SelectOption<OptionValue>,
        state: OptionState<OptionValue>,
    ) => ReactNode

    Replace the option's label, hint, and icon layout in the flyout and global search results. Receives the option and its value, selected, and disabled state. The row retains selection handling and its indicator. Filtering and summaries still use the option data. Return null to use the default layout.

    selectAll?: boolean

    A "Select all" row that toggles every option. On by default — set false to drop it.

    true
    selectAllLabel?: string

    Label for the selectAll row.

    Select all

    Settings
    Member Visibility

    On This Page
    Properties