@samply/lens
    Preparing search index...

    Type Alias SingleSelectCategory

    A catalogue item that lets the user select one or more criteria from a predefined list. The list of criteria is rendered in the catalogue tree and the user can select criteria by clicking a "->" button. The resulting query matches any of the selected criteria.

    type SingleSelectCategory = {
        criteria: Criteria[];
        fieldType: "single-select";
        infoButtonText?: string[];
        key: string;
        name: string;
        subCategoryName?: string;
        system: string;
        type: "EQUALS";
    }
    Index

    Properties

    criteria fieldType infoButtonText? key name subCategoryName? system type

    Properties

    criteria: Criteria[]

    The list of criteria the user can select from

    fieldType: "single-select"
    infoButtonText?: string[]

    Optional text that is accessed by clicking a "ⓘ" button next to the display name

    key: string

    A key that uniquely identifies the catalogue item. It is typically used to look up the CQL snippet for that item.

    name: string

    The item's user-facing display name

    subCategoryName?: string

    This overwrites the display name in the catalogue component only. The intended use-case is to have multiple catalogue items with the same key and name but different subCategoryName. They will appear as different collapsable entries in the catalogue but will be grouped together in the same chip in the search bar.

    system: string
    type: "EQUALS"

    Settings

    Member Visibility

    On This Page

    Properties