pivotick - v3.0.0
    Preparing search index...

    Interface PivotFacet

    One narrowing control, declared by the provider and rendered by the library — the same facet vocabulary the filter panel speaks.

    interface PivotFacet {
        default?: string | boolean | string[];
        key: string;
        label: string;
        options?: { count?: number; label: string; value: string }[];
        type: NarrowingFacetType;
    }
    Index

    Properties

    default?: string | boolean | string[]

    What the provider does when this key is absent from the narrowing, drawn as the facet's starting value and the value Clear narrowing returns to. A multiselect takes the picked option values, a select one value, a boolean true or false. The key is still left out of the narrowing while the facet holds its default, so the provider must treat "absent" as this value. An emptied multiselect with a default is sent as [], meaning none.

    key: string
    label: string
    options?: { count?: number; label: string; value: string }[]

    For select / multiselect. A count is shown beside the option when given.