UI Headless Runtime API - v1.0.0
    Preparing search index...

    Interface TreeOptions

    Tree View state ownership and selection options.

    interface TreeOptions {
        defaultExpandedIds?: readonly string[];
        defaultSelectedIds?: readonly string[];
        getExpandedIds?: () => readonly string[];
        getSelectedIds?: () => readonly string[];
        multiple?: boolean;
        onExpandedIdsChange?: (
            ids: readonly string[],
            details: ChangeDetails<TreeChangeReason>,
        ) => void;
        onSelectedIdsChange?: (
            ids: readonly string[],
            details: ChangeDetails<TreeChangeReason>,
        ) => void;
        subscribeExpandedIds?: (listener: () => void) => () => void;
        subscribeSelectedIds?: (listener: () => void) => () => void;
    }
    Index

    Properties

    defaultExpandedIds? defaultSelectedIds? getExpandedIds? getSelectedIds? multiple? onExpandedIdsChange? onSelectedIdsChange? subscribeExpandedIds? subscribeSelectedIds?

    Properties

    defaultExpandedIds?: readonly string[]

    Initial expanded IDs in uncontrolled mode.

    defaultSelectedIds?: readonly string[]

    Initial selected IDs in uncontrolled mode.

    getExpandedIds?: () => readonly string[]

    Reads consumer-owned expanded IDs.

    getSelectedIds?: () => readonly string[]

    Reads consumer-owned selected IDs.

    multiple?: boolean

    Enables selection of more than one node.

    false

    onExpandedIdsChange?: (
        ids: readonly string[],
        details: ChangeDetails<TreeChangeReason>,
    ) => void

    Receives accepted expansion requests.

    onSelectedIdsChange?: (
        ids: readonly string[],
        details: ChangeDetails<TreeChangeReason>,
    ) => void

    Receives accepted selection requests.

    subscribeExpandedIds?: (listener: () => void) => () => void

    Subscribes to external expansion changes.

    subscribeSelectedIds?: (listener: () => void) => () => void

    Subscribes to external selection changes.

    Settings

    Member Visibility

    On This Page

    Properties