# @polymer/paper-checkbox

> A material design checkbox

Latest version **3.1.0** (published 2018-09-20) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @polymer/paper-checkbox
pnpm add @polymer/paper-checkbox
yarn add @polymer/paper-checkbox
bun add @polymer/paper-checkbox
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.0 |
| Published | 2018-09-20 |
| First published | 2016-02-02 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 27.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 58 |
| Author | The Polymer Authors |
| Maintainers | aomarks, azakus, bicknellr, emarquez, justinfagnani, keanulee, notwaldorf, polymer-devs, samli, sorvell, tvanderlippe, usergenic |
| Keywords | web-components, polymer, paper, checkbox, control |

## Links

- npm: https://www.npmjs.com/package/@polymer/paper-checkbox
- Repository: https://github.com/PolymerElements/paper-checkbox
- Issues: https://github.com/PolymerElements/paper-checkbox/issues
- npm.io page: https://npm.io/package/@polymer/paper-checkbox

## Dependencies (6)

- [@polymer/polymer](https://npm.io/package/@polymer/polymer.md) ^3.0.0
- [@polymer/paper-ripple](https://npm.io/package/@polymer/paper-ripple.md) ^3.0.0-pre.26
- [@polymer/paper-styles](https://npm.io/package/@polymer/paper-styles.md) ^3.0.0-pre.26
- [@polymer/paper-behaviors](https://npm.io/package/@polymer/paper-behaviors.md) ^3.0.0-pre.27
- [@polymer/iron-a11y-keys-behavior](https://npm.io/package/@polymer/iron-a11y-keys-behavior.md) ^3.0.0-pre.26
- [@polymer/iron-checked-element-behavior](https://npm.io/package/@polymer/iron-checked-element-behavior.md) ^3.0.0-pre.26

## Recent versions

- 3.1.0 (latest) — 2018-09-20
- 3.0.0-pre.20 (next) — 2018-06-23
- 1.4.2-pre.3 (preview) — 2017-01-24
- 3.0.1 — 2018-09-14
- 3.0.0 — 2018-09-13
- 3.0.0-pre.26 — 2018-09-12
- 3.0.0-pre.25 — 2018-08-29
- 3.0.0-pre.24 — 2018-08-29
- 3.0.0-pre.23 — 2018-08-25
- 3.0.0-pre.22 — 2018-08-25
- 3.0.0-pre.21 — 2018-06-23
- 3.0.0-pre.19 — 2018-05-09
- 3.0.0-pre.18 — 2018-05-09
- 3.0.0-pre.17 — 2018-05-08
- 3.0.0-pre.16 — 2018-05-04
- … 18 more at https://npm.io/package/@polymer/paper-checkbox/versions

## README

[![Published on NPM](https://img.shields.io/npm/v/@polymer/paper-checkbox.svg)](https://www.npmjs.com/package/@polymer/paper-checkbox)
[![Build status](https://travis-ci.org/PolymerElements/paper-checkbox.svg?branch=master)](https://travis-ci.org/PolymerElements/paper-checkbox)
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](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
<html>
  <head>
    <script type="module">
      import '@polymer/paper-checkbox/paper-checkbox.js';
    </script>
  </head>
  <body>
    <paper-checkbox>Unchecked</paper-checkbox>
    <paper-checkbox checked>Checked</paper-checkbox>
    <paper-checkbox disabled>Disabled</paper-checkbox>
  </body>
</html>
```

### 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`
      <paper-checkbox>Unchecked</paper-checkbox>
      <paper-checkbox checked>Checked</paper-checkbox>
      <paper-checkbox disabled>Disabled</paper-checkbox>
    `;
  }
}

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:<port>/demo/
```

### Running the tests

```sh
polymer test --npm
```

---
_Source: https://npm.io/package/@polymer/paper-checkbox · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._