Skip to content
@ng-doc/app / Class

NgDocApiListComponent

The index of API declarations: a filter that matches names and descriptions, grouping by kind or by scope, and a kind filter with counts. The filter, kind, scope and grouping are kept in the query parameters (filter, type, scope and group), so a filtered index can be linked.

Decorators
@Component
Selectors
ng-doc-api-list
DeclarationTypeScript
@Component({ … })
export class NgDocApiListComponent { … }

Members

Constructor

1
()
—

Properties

17
declarations: Signal<Declaration[]>
protectedreadonly
—
failed: Signal<boolean>
protectedreadonly
—
filterForm: FieldTree<{ filter: string; }, string | number, "writable">
protectedreadonly
—
groupBy: WritableSignal<GroupBy>
protectedreadonly
—
groups: Signal<Group[]>
protectedreadonly
—
hasDescriptions: Signal<boolean>
protectedreadonly
—
inScope: Signal<Declaration[]>
protectedreadonly

Declarations in the selected scope, before the text and kind filters.

kind: WritableSignal<string>
protectedreadonly
—
kinds: Signal<KindFilter[]>
protectedreadonly
—
loaded: Signal<boolean>
protectedreadonly
—
model: WritableSignal<{ filter: string; }>
protectedreadonly
—
scope: WritableSignal<string>
protectedreadonly
—
scopes: Signal<string[]>
protectedreadonly
—
segment: InputSignal<string | undefined>
readonly input()

The segment of the API list data, when the site has more than one API list.

protectedreadonly
—
title: InputSignal<string>
readonly input()

The title of the page.

visible: Signal<Declaration[]>
protectedreadonly
—

Methods

3
(): void
protected

Shows the declarations of every scope.

(…): void
protected

Groups the declarations by kind or by scope.

(…): void
protected

Shows only the declarations of a kind, or of every kind.

Symbol
Kind
Class
Decorators
@Component
Selectors
ng-doc-api-list
Scope
@ng-doc/app
Edit this page