Member Junction
    Preparing search index...

    Interface NavItem

    Navigation item displayed in the app header

    interface NavItem {
        Badge?: string | number;
        ClientTools?: NavItemClientTool[];
        Configuration?: Record<string, any>;
        Description?: string;
        DriverClass?: string;
        Icon?: string;
        isDefault?: boolean;
        Label: string;
        queryParams?: Record<string, string>;
        RecordID?: string;
        ResourceType?: string;
        Route?: string;
        Status?: "Active" | "Pending" | "Disabled";
    }

    Hierarchy (View Summary)

    Index

    Properties

    Badge? ClientTools? Configuration? Description? DriverClass? Icon? isDefault? Label queryParams? RecordID? ResourceType? Route? Status?

    Properties

    Badge?: string | number

    Badge to display (notification count, etc.)

    ClientTools?: NavItemClientTool[]

    Client tools that become available when this nav item is active. References MJ: AI Client Tool Definitions by ID. When the user navigates to this nav item, these tools are activated for the agent session. When the user leaves, they deactivate.

    Configuration?: Record<string, any>

    Additional configuration for the resource

    Description?: string

    Optional description — shown as tooltip in UI and passed to AI for context

    DriverClass?: string

    Driver class name for Custom resource type When ResourceType is "Custom", this specifies the BaseResourceComponent subclass to instantiate For standard resource types, the DriverClass from ResourceType metadata is used instead

    Icon?: string

    Font Awesome icon class (e.g., 'fa-solid fa-chart-line')

    isDefault?: boolean

    Whether this is the default nav item for the application

    Label: string

    Display label for the nav item

    queryParams?: Record<string, string>

    Query parameters to include in the route (used with Route)

    RecordID?: string

    Resource record ID (if opening a specific resource)

    ResourceType?: string

    Resource type to load in a tab (alternative to Route)

    Route?: string

    Route to navigate to when clicked (optional if ResourceType is provided)

    Status?: "Active" | "Pending" | "Disabled"

    Status of the nav item. Only 'Active' items are displayed.

    • 'Active': Displayed and functional (default if not specified)
    • 'Pending': Hidden, reserved for features in development
    • 'Disabled': Hidden, explicitly disabled

    Settings

    Member Visibility

    On This Page

    Properties