Help Angular by taking a 1 minute survey!Go to surveyHome
API > @angular/forms

CheckboxControlValueAccessor

A ControlValueAccessor for writing a value and listening to changes on a checkbox input element.

NgModules

Selectors

Properties

Property Description
onChange: (_: any) => { }

The registered callback function called when a change event occurs on the input element.
onTouched: () => { }

The registered callback function called when a blur event occurs on the input element.

Description

Using a checkbox with a reactive form.

The following example shows how to use a checkbox with a reactive form.

const rememberLoginControl = new FormControl(); 
      
      const rememberLoginControl = new FormControl();
<input type="checkbox" [formControl]="rememberLoginControl"> 
      
      <input type="checkbox" [formControl]="rememberLoginControl">

Methods

writeValue()

Sets the "checked" property on the input element.
writeValue(value: any): void
      
      writeValue(value: any): void
Parameters
value any

The checked value
Returns

void

registerOnChange()

Registers a function called when the control value changes.
registerOnChange(fn: (_: any) => {}): void
      
      registerOnChange(fn: (_: any) => {}): void
Parameters
fn (_: any) => {}

The callback function
Returns

void

registerOnTouched()

Registers a function called when the control is touched.
registerOnTouched(fn: () => {}): void
      
      registerOnTouched(fn: () => {}): void
Parameters
fn () => {}

The callback function
Returns

void

setDisabledState()

Sets the "disabled" property on the input element.
setDisabledState(isDisabled: boolean): void
      
      setDisabledState(isDisabled: boolean): void
Parameters
isDisabled boolean

The disabled value
Returns

void