Skip to content
@ng-doc/core / Interface

NgDocCategory

No documentation has been provided.

Extends
NgDocBaseEntity
DeclarationTypeScript
export interface NgDocCategory extends NgDocBaseEntity { … }

Members

Properties

9
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?: boolean | undefined
inherited from NgDocBaseEntity

If true the page will be hidden from the sidebar

onlyForTags?: string[] | undefined

Build tags this category is rendered for. The category is part of a build only when the build has at least one of these tags; otherwise it and everything in it (child categories, pages and API pages) is left out, as if it did not exist. A category without onlyForTags is part of every build.

With the new generator engine (the Vite plugin, the vite-* builders and the ng-doc CLI), the build tags are:

  • Vite plugin and vite-* builders: the Vite mode (development for the dev server, production for a build, or the builders' mode option), or generator.discovery.tags;
  • ng-doc CLI: production for generate, development for dev and watch, or --tags.

null or an empty string means no filter; an empty array hides the entry in every build. The legacy application/dev-server builders ignore this option.

order?: number | undefined
inherited from NgDocBaseEntity

Order is using for sorting entities in the sidebar

providers?: (EnvironmentProviders | Provider)[] | undefined
—
route?: string | undefined
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/core
Edit this page