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

NgDocCheckboxComponent

A checkbox control; project its label.

Decorators
@Component
Selectors
ng-doc-checkbox
Generic types
T
Extends
DIStateControl<T>
DeclarationTypeScript
@Component({ … })
export class NgDocCheckboxComponent<T> extends DIStateControl<T> { … }

Members

Constructor

1
()
—

Properties

13
change: (value: T | null) => void
protected inherited from DIControlValueAccessor
—
changeDetectorRef: ChangeDetectorRef
protectedreadonly inherited from DIControlValueAccessor
—
checked: Signal<boolean | null>
inherited from DIStateControl
—
readonly input()

Colour of the checked box.

config?: DIStateControlConfig<boolean | TModel> | undefined
protectedreadonly inherited from DIStateControl
—
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
—
renderer: Renderer2
protectedreadonly inherited from DIControlValueAccessor
—
touch: () => void
protected inherited from DIControl

Function that should be used to make control touched.

value: true | TModel
inherited from DIStateControl
—

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 isIntermediate: boolean
inherited from DIStateControl
—

Methods

9
(): void
inherited from DIStateControl

Sets checked state

(): void
inherited from DIStateControl

Sets intermediate state

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

Method is called by the forms API.

(): void
inherited from DIStateControl

Toggles checked state

(): void
inherited from DIStateControl

Sets unchecked state

(…): 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-checkbox
Generic types
T
Extends
DIStateControl<T>
Scope
@ng-doc/ui-kit
Edit this page