Flarum (v2.0.0-beta.6)
    Preparing search index...

    Type Alias GeneralIndexItem

    type GeneralIndexItem = {
        help?: string;
        id: string;
        label: string;
        link?: string;
        tree?: string[];
        visible?: () => boolean;
    }
    Index

    Properties

    help? id label link? tree? visible?

    Properties

    help?: string

    Optional: The description to display in the search results.

    id: string

    The unique identifier for this index item.

    label: string

    The label to display in the search results.

    link?: string

    Optional: The URL to navigate to when this item is selected. The default is to navigate to the extension page.

    tree?: string[]

    Optional: The tree path to this item, used for grouping in the search results.

    visible?: () => boolean

    Optional: A callback that returns a boolean indicating whether this item should be visible in the search results.

    Settings

    Member Visibility

    On This Page

    Properties