boundless-checkbox

THIS IS AN AUTOGENERATED FILE. EDIT INDEX.JS INSTEAD.

Checkbox

An accessible checkbox with indeterminate support.

Checkbox is implemented as a "controlled input", meaning it is a direct representation of the model data passed inside. User interaction will bubble changes in the form of onChecked and onUnchecked that a controller view must intercept and apply against the data provider.

Props

Note: only top-level props are in the README, for the full list check out the website.

Required Props

There are no required props.

Optional Props

Name	Type	Default Value	Description
inputProps	object	{ checked: false, indeterminate: false, }	all input-specific props like `value`, `name`, etc should be passed here -- common ones are listed below. Also supports any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-checkbox` node
label	any renderable	null	any React-renderable content, most commonly a simple string
labelProps	object	{}	any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-checkbox-label` node
onChecked	function	() => {}	called when the element becomes checked; backing data must be updated to persist the state change
onUnchecked	function	() => {}	called when the element becomes unchecked; backing data must be updated to persist the state change