Member Junction
    Preparing search index...

    Interface TabRequest

    Request to open a new tab

    interface TabRequest {
        ApplicationId: string;
        Configuration?: Record<string, unknown>;
        IsPinned?: boolean;
        PreservePinState?: boolean;
        ResourceRecordId?: string;
        ResourceType?: string;
        ResourceTypeId?: string;
        Route?: string;
        TempScope?: "main" | "records";
        Title: string;
    }
    Index

    Properties

    ApplicationId Configuration? IsPinned? PreservePinState? ResourceRecordId? ResourceType? ResourceTypeId? Route? TempScope? Title

    Properties

    ApplicationId: string

    ID of the application this tab belongs to

    Configuration?: Record<string, unknown>

    Tab-specific configuration

    IsPinned?: boolean

    Whether this tab should be pinned (permanent)

    PreservePinState?: boolean

    When true, opening this tab must NOT mutate other tabs' pin state. OpenTabForced normally pins all existing temporary tabs (the classic "only one temp tab at a time" rule).

    Record opens no longer need this: TempScope: 'records' scopes both the consumption pool and the pin cascade to the records region, which leaves the nav tab's temp status untouched while still enforcing one temp tab per region. (A pinned nav tab forces the main tab bar visible on every nav page forever after, which is what the blunt opt-out was avoiding.) It remains for callers that genuinely want no cascade at all.

    ResourceRecordId?: string

    Resource record ID for matching existing tabs

    ResourceType?: string

    Resource type for resource-based tabs

    ResourceTypeId?: string

    Resource type ID for matching existing tabs (legacy)

    Route?: string

    Route to load in the tab (optional if ResourceType is provided)

    TempScope?: "main" | "records"

    Which "single temporary tab" pool this request participates in, for both consumption (OpenTab) and the pin cascade (OpenTabForced). Defaults to 'main', the classic single-pool behavior.

    'records' targets the records region: a plain record open consumes the region's temporary record tab and leaves nav tabs alone, and vice versa. The two pools are disjoint, which is what lets records get preview-tab behavior without a nav click ever replacing an open record.

    Title: string

    Display title for the tab

    Settings

    Member Visibility

    On This Page

    Properties