react-checkbox
React Checkbox
A React checkbox with support for the indeterminate state.
Install
$ npm i --save react-checkbox
Usage
var Checkbox = var checked = null React
Props
checked
: Boolean/Null - whether the checkbox should be checked or not. IfsupportIntermediate
is true, thechecked
property can also have another value, which should equal toindeterminateValue
prop (which defaults to null)supportIndeterminate
: Boolean - whether the checkbox should support the indeterminate state. Defaults to false.indeterminateValue
- the value forchecked
that should render the checkbox as indeterminate. Defaults to nullstopPropagation
: Boolean - whether to stopchange
event propagation for the checkbox. Defaults to true.onChange
: Function(value, event) - The function to call when the state of the checkbox changes. NOTE: Unlike<input type="checkbox" />
, first param is the new value, and second param is the event object.defaultChecked
- uncontrolled version ofchecked
nextValue
: Function(oldValue, props) - can be used to change the default value order (whensupportIndeterminate
istrue
). Default order is: (checked -> unchecked; unchecked -> indeterminate; indeterminate -> checked
).
Other
If you want support for submitting the indeterminate value, and for specifying what to submit on each state, I suggest you take a look at react-check3