JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q44637F
  • License Apache-2.0

Paper Checkbox React component

Package Exports

  • paper-checkbox

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (paper-checkbox) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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>