Interface IRawNode

Defines a page or menu entry. The item is considered as a menu-only if it does not have a source.

Hierarchy

Properties

children? childrenDir? loader? moduleRoot? name source?

Properties

Optional children

children?: AnyLoaderRawPageNode[]

List of children nodes. Both pages & menu entries can have children.

Optional childrenDir

childrenDir?: string

The directory in which children are sourced.\

See

Managing pages & menu items for details.

Optional loader

loader?: "declarative"

Optional moduleRoot

moduleRoot?: boolean

name

name: LiteralUnion<"VIRTUAL", string>

The name of the page/menu.

If setting moduleRoot to true, the name is used to lookup the module/package/workspace to attach children to. When a source is also provided, the source is prepended to the target module index page.

If set to 'VIRTUAL', the node itself is omitted and children are collected from childrenDir.

See

Managing pages & menu items for details.

Optional source

source?: string

The source file. The node is a page only if this property is set.

Settings

Member Visibility

Theme

Generated using TypeDoc