<Checkbox />

A checkbox element. The component will automatically render as a Material Design checkbox on Android devices.

Most attributes that can be used for a normal <input type="checkbox"> element can also be used on the <Checkbox> component.

Usage

<Checkbox
  onChange={event => { this.setState({checked: event.target.checked})} }
  modifier='material' />

Props

Name Type Description
modifier string The appearance of the checkbox. Optional.
disabled bool Specifies whether the checkbox is disabled. Optional.
onChange func Called when the checkbox state changes. Optional.
value union Value of the checkbox. Optional.
checked bool Controls the state of the checkbox (controlled). Optional.
checked bool Defined the state of the radio button at first render for uncontrolled inputs. Optional.
inputId string Specify the “id” attribute of the inner <input> element. This is useful when using

Preset Modifiers

Name Description
material Displays a Material Design checkbox.
noborder iOS borderless checkbox.

Need Help?

If you have any questions, use our Community Forum or talk to us on Discord chat. The Onsen UI team and your peers in the community will work together to help solve your issues.

For bug reports and feature requests use our GitHub Issues page.