novx
    Preparing search index...

    Interface FeatureOptions

    possible feature options

    interface FeatureOptions {
        clients?: ClientConstraints;
        description?: string;
        features?: string[];
        i18n?: string;
        icon?: string;
        id: string;
        label?: string;
        parent?: string;
        path?: string;
        permissions?: string[];
        preloadI18n?: string[];
        tags?: string[];
        visibility?: ("public" | "private")[];
    }
    Index

    Properties

    clients? description? features? i18n? icon? id label? parent? path? permissions? preloadI18n? tags? visibility?

    Properties

    clients?: ClientConstraints

    the required ClientConstraints that this feature requires

    description?: string

    description of the feature

    features?: string[]

    optional array of feature flags that this feature requires

    i18n?: string

    optional i18n key that contains trarnslations for the label

    icon?: string

    optional icon name

    id: string

    the id

    label?: string

    a label

    parent?: string

    optional parent feature id in case of chld features

    path?: string

    the route

    permissions?: string[]

    optional array of permissions that this feature requires

    preloadI18n?: string[]

    list of i18n namespaces that the feature will preload when rendered

    tags?: string[]

    any tags that can be used to categorize features

    visibility?: ("public" | "private")[]

    determines the required session status - public referes to a non existing session - for this feature.

    Settings

    Member Visibility

    On This Page

    Properties