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

<tr>
    <td>inputProps</td>
    <td><pre><code>object</code></pre></td>
    <td><pre><code class="language-js">{
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; applied to the .b-checkbox node

<tr>
    <td>label</td>
    <td><pre><code>any renderable</code></pre></td>
    <td><pre><code class="language-js">null</code></pre></td>
    <td>any React-renderable content, most commonly a simple string</td>
</tr>

<tr>
    <td>labelProps</td>
    <td><pre><code>object</code></pre></td>
    <td><pre><code class="language-js">{}</code></pre></td>
    <td>any [React-supported attribute](https://facebook.github.io/react/docs/tags-and-attributes.html#html-attributes); applied to the `.b-checkbox-label` node</td>
</tr>

<tr>
    <td>onChecked</td>
    <td><pre><code>function</code></pre></td>
    <td><pre><code class="language-js">noop</code></pre></td>
    <td>called when the element becomes checked; backing data must be updated to persist the state change</td>
</tr>

<tr>
    <td>onUnchecked</td>
    <td><pre><code>function</code></pre></td>
    <td><pre><code class="language-js">noop</code></pre></td>
    <td>called when the element becomes unchecked; backing data must be updated to persist the state change</td>
</tr>