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

NgDocComboboxComponent

A select with an optional text field. Its options are an ng-doc-list in a template marked with the ngDocData directive.

Decorators
@Component
Selectors
ng-doc-combobox
Generic types
T
Extends
DIControl<T, T>
Implements
NgDocListHost
DeclarationTypeScript
@Component({ … })
export class NgDocComboboxComponent<T>
  extends DIControl<T>
  implements NgDocListHost { … }

Members

Constructor

1
()
—

Properties

16
change: (value: T | null) => void
protected inherited from DIControlValueAccessor
—
changeDetectorRef: ChangeDetectorRef
protectedreadonly inherited from DIControlValueAccessor
—
clearButton: InputSignal<boolean>
readonly input()

Whether the clear button is shown.

config?: DIControlConfig<TModel, TChildModel> | undefined
protectedreadonly inherited from DIControl
—
data: Signal<TemplateRef<any> | undefined>
readonly

The template of the options, marked with the ngDocData directive.

disabledValue: WritableSignal<boolean>
protectedreadonly inherited from DIControlValueAccessor
—
elementRef: ElementRef<HTMLElement>
protectedreadonly inherited from DIControlValueAccessor
—
incomingUpdate?: ((value: T | null) => void) | undefined
protectedreadonly inherited from DIControlValueAccessor
—
model: Signal<T | null>
protectedreadonly inherited from DIControlValueAccessor
—
ngControl: NgControl | null
protectedreadonly inherited from DIControlValueAccessor
—
placeholder: InputSignal<string>
readonly input()

Placeholder of the text field.

readonly: InputSignal<boolean>
readonly input()

Whether the text field is read-only: the value is picked from the list only.

renderer: Renderer2
protectedreadonly inherited from DIControlValueAccessor
—
rightContent: InputSignal<NgDocContent>
readonly input()

Content shown at the right of the field.

touch: () => void
protected inherited from DIControl

Function that should be used to make control touched.

readonly input()

Content that shows the value while the field is not being edited.

Accessors

4
get disabled: boolean
inherited from DIControlValueAccessor

Returns true if the control is disabled.

set disabled: boolean
inherited from DIControlValueAccessor
—
get hasValue: boolean
inherited from DIControlValueAccessor

Returns true if the control is not empty.

get listHostOrigin: HTMLElement
implements NgDocListHost
—

Methods

4
(): void
inherited from DIControl
—
(…): void
inherited from DIControl

Method is called by the forms API.

(…): void
inherited from DIControl

Updates the model of the current control. This is the main method that should be used to update the model.

(…): void
inherited from DIControl

Method is called by the forms API to write to the view when programmatic changes from model to view are requested.

Symbol
Kind
Class
Decorators
@Component
Selectors
ng-doc-combobox
Generic types
T
Extends
DIControl<T, T>
Implements
NgDocListHost
Scope
@ng-doc/ui-kit
Edit this page