platform-bible-react
    Preparing search index...

    Interface MarkerMenuItem

    Type for the markers that contain all necessary information to be displayed in the list

    interface MarkerMenuItem {
        action: () => void;
        icon?: FC<MarkerIconProps>;
        isDeprecated?: boolean;
        isDisallowed?: boolean;
        marker?: string;
        subtitle?: string;
        title: string;
    }
    Index

    Properties

    action: () => void

    Function to be triggered when the marker or command is selected

    icon?: FC<MarkerIconProps>

    Optional name of icon to use instead of the marker

    isDeprecated?: boolean

    Whether the command/marker is deprecated. Deprecated items stay visible in the menu (even when the search query is empty) but are rendered disabled so they cannot be selected.

    isDisallowed?: boolean

    Whether the command/marker is disallowed for this project (e.g. blocked while structure is protected). Unlike MarkerMenuItem.isDeprecated, this flag affects visibility as well as selectability: while the search query is empty, disallowed items are hidden if any allowed items exist (to reduce clutter) but are shown when every item is disallowed (so the menu isn't empty). A non-empty query reveals a disallowed item only on an exact marker-code match or a title match. Whenever a disallowed item is shown it is rendered disabled so it cannot be selected.

    marker?: string

    If the item is a marker, then this is the marker code

    subtitle?: string

    An optional subtitle for the marker

    title: string

    The main title for the marker or command