[](https://www.npmjs.com/package/@polymer/paper-checkbox) [](https://travis-ci.org/PolymerElements/paper-checkbox) [](https://webcomponents.org/element/@polymer/paper-checkbox) ## <paper-checkbox> `paper-checkbox` is a button that can be either checked or unchecked. User can tap the checkbox to check or uncheck it. Usually you use checkboxes to allow user to select multiple options from a set. If you have a single ON/OFF option, avoid using a single checkbox and use `paper-toggle-button` instead. See: [Documentation](https://www.webcomponents.org/element/@polymer/paper-checkbox), [Demo](https://www.webcomponents.org/element/@polymer/paper-checkbox/demo/demo/index.html). ## Usage ### Installation ``` npm install --save @polymer/paper-checkbox ``` ### In an HTML file ```html Unchecked Checked Disabled ``` ### In a Polymer 3 element ```js import {PolymerElement} from '@polymer/polymer/polymer-element.js'; import {html} from '@polymer/polymer/lib/utils/html-tag.js'; import '@polymer/paper-checkbox/paper-checkbox.js'; class ExampleElement extends PolymerElement { static get template() { return html` Unchecked Checked Disabled `; } } customElements.define('example-element', ExampleElement); ``` ## Contributing If you want to send a PR to this element, here are the instructions for running the tests and demo locally: ### Installation ```sh git clone https://github.com/PolymerElements/paper-checkbox cd paper-checkbox npm install npm install -g polymer-cli ``` ### Running the demo locally ```sh polymer serve --npm open http://127.0.0.1:/demo/ ``` ### Running the tests ```sh polymer test --npm ```