NgDocToggleComponent
Switch control. It works with forms (ngModel, reactive forms, [formField]) and with host controls; the circle can be clicked or dragged.
- Decorators
@Component - Selectors
ng-doc-toggle - Generic types
T- Extends
DIStateControl<T>- Implements
ControlValueAccessor
@Component ({ … })
export class NgDocToggleComponent <T>
extends DIStateControl<T>
implements ControlValueAccessor { … }Members
Constructor1 | |||||||||||||||||
() | — | ||||||||||||||||
Signature | |||||||||||||||||
Properties13 | |||||||||||||||||
change: (value: T | null) => void | — | ||||||||||||||||
changeDetectorRef: | — | ||||||||||||||||
checked: | — | ||||||||||||||||
config?: DIStateControlConfig<boolean | TModel> | undefined | — | ||||||||||||||||
disabledValue: | — | ||||||||||||||||
dragging: | Whether the user is dragging the circle. | ||||||||||||||||
elementRef: | — | ||||||||||||||||
incomingUpdate?: ((value: T | null) => void) | undefined | — | ||||||||||||||||
model: | — | ||||||||||||||||
ngControl: | — | ||||||||||||||||
renderer: | — | ||||||||||||||||
touch: () => void | Function that should be used to make control touched. | ||||||||||||||||
value: true | TModel | — | ||||||||||||||||
Accessors4 | |||||||||||||||||
get disabled: boolean | Returns true if the control is disabled. | ||||||||||||||||
set disabled: boolean | — | ||||||||||||||||
get hasValue: boolean | Returns true if the control is not empty. | ||||||||||||||||
get isIntermediate: boolean | — | ||||||||||||||||
Methods11 | |||||||||||||||||
(): void | Sets checked state | ||||||||||||||||
Signature Returns voidOverloads
| |||||||||||||||||
(): void | Sets intermediate state | ||||||||||||||||
Signature Returns voidOverloads
| |||||||||||||||||
(…): void | — | ||||||||||||||||
Signature Parameters
Returns voidOverloads
| |||||||||||||||||
(): void | — | ||||||||||||||||
Signature Returns voidOverloads
| |||||||||||||||||
(): void | — | ||||||||||||||||
Signature Returns void | |||||||||||||||||
(…): void | Method is called by the forms API. | ||||||||||||||||
Signature Parameters
Returns voidOverloads
| |||||||||||||||||
(…): void | — | ||||||||||||||||
Signature Parameters
Returns void | |||||||||||||||||
(): void | Toggles checked state | ||||||||||||||||
Signature Returns voidOverloads
| |||||||||||||||||
(): void | Sets unchecked state | ||||||||||||||||
Signature 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
| |||||||||||||||||