Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...

    Interface ControlRailToggle

    A compact icon toggle shown inside a ControlRailItem.flyout.

    interface ControlRailToggle {
        id: string;
        title: string;
        shortcut?: string;
        icon: string;
        activate: () => void;
        openSelector?: string;
        isActive?: () => boolean;
        excludeFromParentActive?: boolean;
    }
    Index
    id title shortcut? icon activate openSelector? isActive? excludeFromParentActive?
    id: string
    title: string
    shortcut?: string
    icon: string
    activate: () => void
    openSelector?: string
    isActive?: () => boolean
    excludeFromParentActive?: boolean

    Exclude this toggle from the PARENT flyout button's active state (the chip itself still shows active inside the flyout). For session-long ambient states like fullscreen, where lighting the parent button for the whole session reads as noise rather than signal — unlike cinematic mode, whose glow deliberately advertises a changed render pipeline.

    Settings
    Member Visibility

    On This Page
    Properties