Skip to content
@ng-doc/ui-kit / Class

NgDocDataListGroupComponent

Data list whose options are grouped by itemGroupFn, with a header per group.

Decorators
@Component
Selectors
ng-doc-data-list-group
Generic types
TG
Extends
NgDocDataListComponent<T>
DeclarationTypeScript
@Component({ … })
export class NgDocDataListGroupComponent<T, G>
  extends NgDocDataListComponent<T> { … }

Members

Properties

11
autofocus: InputSignal<boolean>
readonly input() inherited from NgDocDataListComponent

Whether the list takes focus when it opens.

defineValueFn: InputSignal<NgDocDefineValueFunction<unknown, unknown>>
readonly input() inherited from NgDocDataListComponent

Maps an item to the value its option selects.

emptyContent: InputSignal<NgDocContent>
readonly input() inherited from NgDocDataListComponent

Content shown when there are no items.

readonly input()

Content of a group header; its context is the group.

groupItems: Signal<G[]>
readonly

The groups, in the order in which they first appear.

groups: Signal<Map<G, T[]>>
readonly

Items by group, in the order in which the groups first appear.

readonly input() inherited from NgDocDataListComponent

Content of an option; its context is the item.

itemDisabledFn: InputSignal<NgDocBooleanHandler<T>>
readonly input() inherited from NgDocDataListComponent

Returns true for items whose option is disabled.

itemGroupFn: InputSignal<NgDocGroupFn<T, G> | undefined>
readonly input()

Returns the group of an item. Without it, no option is shown.

items: InputSignal<readonly T[] | null>
readonly input() inherited from NgDocDataListComponent

Items to show.

readonly input() inherited from NgDocDataListComponent

Identifies items across changes of items.

Methods

1
(): T[]
inherited from NgDocDataListComponent

Returns the items as an array.

Symbol
Kind
Class
Decorators
@Component
Selectors
ng-doc-data-list-group
Generic types
TG
Extends
NgDocDataListComponent<T>
Scope
@ng-doc/ui-kit
Edit this page