paper-checkbox

Paper Checkbox React component

Usage no npm install needed!

<script type="module">
  import paperCheckbox from 'https://cdn.skypack.dev/paper-checkbox';
</script>

README

<PaperCheckbox />

Build Status

Install

npm install paper-checkbox

Using the Component

import PaperCheckbox from 'paper-checkbox';

Using the CSS

@import "/path/to/node_modules/paper-checkbox/dist/paper-checkbox.css";

API

  • checked: Boolean: Optional. Determines whether the checkbox is displayed as checked or unchecked.
  • children: Any: Optional. Used as a label for the checkbox.
  • disabled: Boolean: Optional. Determines whether the checkbox is disabled.
  • id: String: Required if using a label, optional otherwise.
  • onClick: Function: Optional. Called when the <PaperCheckbox> component is clicked.
  • theme: String: Optional. Accepts 'light' to add a light theme. Default theme is dark.

Example

<PaperCheckbox
  id='123'
  checked={this.state.clicked}
  onClick={() => this.setState({ clicked: !this.state.clicked })}
>
  Checkmate
</PaperCheckbox>