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

NgDocCategory

No documentation has been provided.

Properties

NameTypeDescription
category
NgDocCategory | undefined

The parent category

expandable
boolean | undefined

Determines whether the category is expandable

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

onlyForTags
string[] | undefined

Render the page only for specific build tags

order
inherited from NgDocBaseEntity
number | undefined

Order is using for sorting entities in the sidebar

route
overrides NgDocBaseEntity
string | undefined

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

title
inherited from NgDocBaseEntity
string

The entity title