Getting Started
Writing content
API Documentation
Customization
Recipes
API References Develop
@ng-doc/app / Interface

NgDocNavigation

Navigation item interface

Properties

NameTypeDescription
children
NgDocNavigation[] | undefined

Children of the navigation item

expandable
boolean | undefined
expanded
boolean | undefined

Determines whether the category should be expanded by default

hidden
inherited from NgDocBaseEntity
boolean | undefined

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
inherited from NgDocBaseEntity
number | undefined

Order is using for sorting entities in the sidebar

route
overrides NgDocBaseEntity
string

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

title
inherited from NgDocBaseEntity
string

The entity title