Skip to content
@ng-doc/app / Interface

NgDocNavigation

Navigation item interface

Extends
NgDocBaseEntity
DeclarationTypeScript
export interface NgDocNavigation extends NgDocBaseEntity { … }

Members

Properties

8
children?: NgDocNavigation[] | undefined

Children of the navigation item

expandable?: boolean | undefined
—
expanded?: boolean | undefined

Determines whether the category should be expanded by default

hidden?: boolean | undefined
inherited from NgDocBaseEntity

If true the page will be hidden from the sidebar

metadata?: JSDocMetadata | undefined

The item metadata. Collects all tags based on the JSDoc tags for NgDocPage or NgDocCategory entities.

order?: number | undefined
inherited from NgDocBaseEntity

Order is using for sorting entities in the sidebar

route: string
overrides NgDocBaseEntity

The route of the entity (current sourceFileFolder name by default)

title: string
inherited from NgDocBaseEntity

The entity title

Symbol
Kind
Interface
Extends
NgDocBaseEntity
Scope
@ng-doc/app
Edit this page