OLD | NEW |
| (Empty) |
1 | |
2 <!--- | |
3 | |
4 This README is automatically generated from the comments in these files: | |
5 paper-checkbox.html | |
6 | |
7 Edit those files, and our readme bot will duplicate them over here! | |
8 Edit this file, and the bot will squash your changes :) | |
9 | |
10 The bot does some handling of markdown. Please file a bug if it does the wrong | |
11 thing! https://github.com/PolymerLabs/tedium/issues | |
12 | |
13 --> | |
14 | |
15 [![Build status](https://travis-ci.org/PolymerElements/paper-checkbox.svg?branch
=master)](https://travis-ci.org/PolymerElements/paper-checkbox) | |
16 | |
17 _[Demo and API docs](https://elements.polymer-project.org/elements/paper-checkbo
x)_ | |
18 | |
19 | |
20 ##<paper-checkbox> | |
21 | |
22 Material design: [Checkbox](https://www.google.com/design/spec/components/select
ion-controls.html#selection-controls-checkbox) | |
23 | |
24 `paper-checkbox` is a button that can be either checked or unchecked. User | |
25 can tap the checkbox to check or uncheck it. Usually you use checkboxes | |
26 to allow user to select multiple options from a set. If you have a single | |
27 ON/OFF option, avoid using a single checkbox and use `paper-toggle-button` | |
28 instead. | |
29 | |
30 Example: | |
31 | |
32 ```html | |
33 <paper-checkbox>label</paper-checkbox> | |
34 | |
35 <paper-checkbox checked> label</paper-checkbox> | |
36 ``` | |
37 | |
38 ### Styling | |
39 | |
40 The following custom properties and mixins are available for styling: | |
41 | |
42 | Custom property | Description | Default | | |
43 | --- | --- | --- | | |
44 | `--paper-checkbox-unchecked-background-color` | Checkbox background color when
the input is not checked | `transparent` | | |
45 | `--paper-checkbox-unchecked-color` | Checkbox border color when the input is n
ot checked | `--primary-text-color` | | |
46 | `--paper-checkbox-unchecked-ink-color` | Selected/focus ripple color when the
input is not checked | `--primary-text-color` | | |
47 | `--paper-checkbox-checked-color` | Checkbox color when the input is checked |
`--primary-color` | | |
48 | `--paper-checkbox-checked-ink-color` | Selected/focus ripple color when the in
put is checked | `--primary-color` | | |
49 | `--paper-checkbox-checkmark-color` | Checkmark color | `white` | | |
50 | `--paper-checkbox-label-color` | Label color | `--primary-text-color` | | |
51 | `--paper-checkbox-label-spacing` | Spacing between the label and the checkbox
| `8px` | | |
52 | `--paper-checkbox-error-color` | Checkbox color when invalid | `--error-color`
| | |
53 | `--paper-checkbox-size` | Size of the checkbox | `18px` | | |
54 | |
55 This element applies the mixin `--paper-font-common-base` but does not import `p
aper-styles/typography.html`. | |
56 In order to apply the `Roboto` font to this element, make sure you've imported `
paper-styles/typography.html`. | |
57 | |
58 | |
OLD | NEW |