NgDocSidebarCategoryComponent

A category of the sidebar: a header row that expands and collapses the pages below it.

An expandable category opens by itself when the reader navigates to one of its pages.

DeclarationTypeScript

@Component({ … })
export class NgDocSidebarCategoryComponent { … }

Members

Constructor 1
()	—
Signature `constructor( ): NgDocSidebarCategoryComponent;`
Properties 7
category: `InputSignal<NgDocNavigation>` readonly `input()`required	The category.
childrenId: `string` protectedreadonly	Id of the element that holds the pages, for the header's `aria-controls`.
content: `InputSignal<NgDocContent>` readonly `input()`	The pages and categories inside the category.
expandable: `InputSignalWithTransform<boolean, unknown>` readonly `input()`	Whether the reader can collapse the category. A category that cannot is always open.
expanded: `InputSignalWithTransform<boolean, unknown>` readonly `input()`	Whether the category starts open.
isExpanded: `WritableSignal<boolean>` readonly	Whether the category is open: it starts from `expanded` and follows the reader.
isRoot: `InputSignalWithTransform<boolean, unknown>` readonly `input()`	Whether the category sits at the top level of the sidebar.
Methods 3
(): `void`	Closes the category, unless it cannot be collapsed.
Signature `collapse(): void;` Returns `void`
(): `void`	Opens the category.
Signature `expand(): void;` Returns `void`
(): `void`	Opens the category if it is open, or closes it otherwise.
Signature `toggle(): void;` Returns `void`