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

    Class Folder

    Hierarchy (View Summary)

    Index
    • Create a folder

      Parameters

      • name: string

        Display name

      • parent: Folder | null

        Parent folder (null for root GUI)

      • defaultClosed: boolean = false

        Whether folders start closed

      • Optionalicon: string

        Optional leading icon (inline SVG string, rail-style)

      Returns Folder

    name: string

    Display name

    icon?: string

    Optional leading icon (inline SVG string, rail-style).

    parent: Folder | null

    Parent folder (null for root GUI)

    controllers: Controller<any>[] = []

    Child controllers

    folders: Folder[] = []

    Child folders

    childrenContainer: HTMLElement

    DOM element for children

    domElement?: HTMLElement

    DOM element for folder (if not root) - can be overridden in subclasses

    isOpen: boolean

    Open/closed state

    defaultClosed: boolean

    Default open/close state for new folders

    eventManager: EventManager

    Event manager for cleanup

    • Create folder DOM structure

      Returns HTMLElement

    • Update open state for a specific element (used during construction)

      Parameters

      • element: HTMLElement

      Returns void

    • Add a controller for a property

      Auto-detects controller type based on value type and arguments

      Parameters

      • object: Record<string, any>

        Target object

      • property: string

        Property name

      • Optionalarg1: number | string[] | Record<string, any>

        Min value OR options array/object

      • Optionalarg2: number

        Max value (if arg1 is min)

      • Optionalarg3: number

        Step value (if arg1 and arg2 are min/max)

      Returns Controller

      Created controller

    • Add a nested folder

      Parameters

      • name: string

        Folder name

      • Optionalicon: string

        Optional leading icon (inline SVG string, rail-style)

      Returns Folder

      Created folder