• Overview
@angular/forms

CheckboxControlValueAccessor

directive

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

API

  
    class CheckboxControlValueAccessor extends BuiltInControlValueAccessor implements ControlValueAccessor {}
  
  

writeValue

void

Sets the "checked" property on the input element.

@paramvalueany
@returnsvoid

onChange

(_: any) => void

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

onTouched

() => void

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

setProperty

void

Helper method that sets a property on a target element using the current Renderer implementation.

@paramkeystring
@paramvalueany
@returnsvoid

registerOnTouched

void

Registers a function called when the control is touched.

@paramfn() => void
@returnsvoid

registerOnChange

void

Registers a function called when the control value changes.

@paramfn(_: any) => {}
@returnsvoid

setDisabledState

void

Sets the "disabled" property on the range input element.

@paramisDisabledboolean
@returnsvoid

Description

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


Exported by

Usage Notes

Using a checkbox with a reactive form.

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

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