Merge Chromium + Blink git repositories
[chromium-blink-merge.git] / third_party / polymer / v1_0 / components-chromium / paper-checkbox / README.md
blob01eddc1a20ab455329411c079891eec6725f5e1d
1 # paper-checkbox
3 `paper-checkbox` is a button that can be either checked or unchecked.  User
4 can tap the checkbox to check or uncheck it.  Usually you use checkboxes
5 to allow user to select multiple options from a set.  If you have a single
6 ON/OFF option, avoid using a single checkbox and use `paper-toggle-button`
7 instead.
9 Example:
11 ```html
12 <paper-checkbox>label</paper-checkbox>
14 <paper-checkbox checked>label</paper-checkbox>
15 ```
17 Styling a checkbox:
19 ```html
20 <style is="custom-style">
21   paper-checkbox {
22     --paper-checkbox-label-color: #000;
23     --paper-checkbox-checkmark-color: #fff;
25     /* Unhecked state colors. */
26     --paper-checkbox-unchecked-color: #5a5a5a;
27     --paper-checkbox-unchecked-background-color: #5a5a5a;
28     --paper-checkbox-unchecked-ink-color: #5a5a5a;
30     /* Checked state colors. */
31     --paper-checkbox-checked-color: #009688;
32     --paper-checkbox-checked-ink-color: #009688;
33   }
34 </style>
35 ```