NgDocBooleanControlComponent
The playground control of boolean inputs: a checkbox labelled with the input name.
- Decorators
@Component - Selectors
ng-doc-boolean-control - Extends
DIControl<boolean | undefined, boolean | undefined>- Implements
NgDocTypeControl <boolean | undefined>
@Component ({ … })
export class NgDocBooleanControlComponent
extends DIControl<boolean | undefined>
implements NgDocTypeControl <boolean | undefined> { … }Members
Constructor1 | |||||||||||||||||
() | — | ||||||||||||||||
Signature | |||||||||||||||||
Properties13 | |||||||||||||||||
change: (value: T | null) => void | — | ||||||||||||||||
changeDetectorRef: | — | ||||||||||||||||
config?: DIControlConfig<TModel, TChildModel> | undefined | — | ||||||||||||||||
default: | Default value of the input; | ||||||||||||||||
description: | Description of the input, shown in a tooltip. | ||||||||||||||||
disabledValue: | — | ||||||||||||||||
elementRef: | — | ||||||||||||||||
incomingUpdate?: ((value: T | null) => void) | undefined | — | ||||||||||||||||
model: | — | ||||||||||||||||
name: | Name of the input. | ||||||||||||||||
ngControl: | — | ||||||||||||||||
renderer: | — | ||||||||||||||||
touch: () => void | Function that should be used to make control touched. | ||||||||||||||||
Accessors4 | |||||||||||||||||
get defaultValue: boolean | undefined | The value an unchecked box stands for. | ||||||||||||||||
get disabled: boolean | Returns true if the control is disabled. | ||||||||||||||||
set disabled: boolean | — | ||||||||||||||||
get hasValue: boolean | Returns true if the control is not empty. | ||||||||||||||||
Methods4 | |||||||||||||||||
(): void | — | ||||||||||||||||
Signature Returns voidOverloads
| |||||||||||||||||
(…): void | Method is called by the forms API. | ||||||||||||||||
Signature Parameters
Returns voidOverloads
| |||||||||||||||||
(…): void | Updates the model of the current control. This is the main method that should be used to update the model. | ||||||||||||||||
Signature Parameters
Returns void | |||||||||||||||||
(…): void | Method is called by the forms API to write to the view when programmatic changes from model to view are requested. | ||||||||||||||||
Signature Parameters
Returns voidOverloads
| |||||||||||||||||