Interface BaseTocItem

Represents an item within the toc.

interface BaseTocItem {
    children: TocItem[];
    childrenToggleMode: ChildrenToggleMode;
    hasHiddenChildren: boolean;
    isFirstChild: boolean;
    isLastChild: boolean;
    isLeaf: boolean;
    isOpen: boolean;
    isRoot: boolean;
    listMode: ListMode;
    ref: any;
    setOpen(open): void;
    setOpenOnTree(open): void;
    type: TocItemType;
}

Hierarchy (view full)

Properties

children childrenToggleMode hasHiddenChildren isFirstChild isLastChild isLeaf isOpen isRoot listMode ref type

Methods

setOpen setOpenOnTree

Properties

Readonly children

children: TocItem[]

The children of this item.

Readonly childrenToggleMode

childrenToggleMode: ChildrenToggleMode

The toggle mode for the children of this item.

Readonly hasHiddenChildren

hasHiddenChildren: boolean

True if the item currently has any hidden children.

Readonly isFirstChild

isFirstChild: boolean

True if this item is the first child of its parent.

Readonly isLastChild

isLastChild: boolean

True if this item is the last child of its parent.

Readonly isLeaf

isLeaf: boolean

True if this item is a leaf (no further children).

Readonly isOpen

isOpen: boolean

True if this item is currently opened (expanded).

Readonly isRoot

isRoot: boolean

True if this item is the root item (no further parent).

Readonly listMode

listMode: ListMode

The list mode of this item.

Readonly ref

ref: any

Provides access to the real object represented by the toc item.

Readonly type

type: TocItemType

The type of this toc item.

Methods

setOpen

  • setOpen(open): void

  • Sets the "open" (expanded) state of this toc item.

    Parameters

    • open: boolean

    Returns void

setOpenOnTree

  • setOpenOnTree(open): void

  • Sets the open state (expanded) state of this toc item and its sub tree.

    Parameters

    • open: boolean

    Returns void

Settings

Member Visibility

Theme

On This Page

childrenchildrenToggleModehasHiddenChildrenisFirstChildisLastChildisLeafisOpenisRootlistModereftypesetOpensetOpenOnTree

Generated using TypeDoc