Blame view

bower_components/paper-item/README.md 4.96 KB
73bcce88   luigser   COMPONENTS
1
  
a1a3bc73   Luigi Serra   graphs updates
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
  <!---
  
  This README is automatically generated from the comments in these files:
  paper-icon-item.html  paper-item-behavior.html  paper-item-body.html  paper-item.html
  
  Edit those files, and our readme bot will duplicate them over here!
  Edit this file, and the bot will squash your changes :)
  
  -->
  
  [![Build Status](https://travis-ci.org/PolymerElements/paper-item.svg?branch=master)](https://travis-ci.org/PolymerElements/paper-item)
  
  _[Demo and API Docs](https://elements.polymer-project.org/elements/paper-item)_
  
  
  ##&lt;paper-item&gt;
  
  
  Material design: [Lists](https://www.google.com/design/spec/components/lists.html)
  
  `<paper-item>` is an interactive list item. By default, it is a horizontal flexbox.
  
      <paper-item>Item</paper-item>
  
  Use this element with `<paper-item-body>` to make Material Design styled two-line and three-line
  items.
  
      <paper-item>
        <paper-item-body two-line>
          <div>Show your status</div>
          <div secondary>Your status is visible to everyone</div>
        </paper-item-body>
        <iron-icon icon="warning"></iron-icon>
      </paper-item>
  
  ### Styling
  
  The following custom properties and mixins are available for styling:
  
  Custom property               | Description                                  | Default
  ------------------------------|----------------------------------------------|----------
  `--paper-item-min-height`     | Minimum height of the item                   | `48px`
  `--paper-item`                | Mixin applied to the item                    | `{}`
  `--paper-item-selected-weight`| The font weight of a selected item           | `bold`
  `--paper-item-selected`       | Mixin applied to selected paper-items        | `{}`
  `--paper-item-disabled-color` | The color for disabled paper-items           | `--disabled-text-color`
  `--paper-item-disabled`       | Mixin applied to disabled paper-items        | `{}`
  `--paper-item-focused`        | Mixin applied to focused paper-items         | `{}`
  `--paper-item-focused-before` | Mixin applied to :before focused paper-items | `{}`
  
  ### Accessibility
  
  This element has `role="listitem"` by default. Depending on usage, it may be more appropriate to set
  `role="menuitem"`, `role="menuitemcheckbox"` or `role="menuitemradio"`.
  
      <paper-item role="menuitemcheckbox">
        <paper-item-body>
          Show your status
        </paper-item-body>
        <paper-checkbox></paper-checkbox>
      </paper-item>
  
  
  
  ##&lt;paper-icon-item&gt;
  
  
  `<paper-icon-item>` is a convenience element to make an item with icon. It is an interactive list
  item with a fixed-width icon area, according to Material Design. This is useful if the icons are of
  varying widths, but you want the item bodies to line up. Use this like a `<paper-item>`. The child
  node with the attribute `item-icon` is placed in the icon area.
  
      <paper-icon-item>
        <iron-icon icon="favorite" item-icon></iron-icon>
        Favorite
      </paper-icon-item>
      <paper-icon-item>
        <div class="avatar" item-icon></div>
        Avatar
      </paper-icon-item>
  
  ### Styling
  
  The following custom properties and mixins are available for styling:
  
  Custom property               | Description                                    | Default
  ------------------------------|------------------------------------------------|----------
  `--paper-item-icon-width`     | Width of the icon area                         | `56px`
  `--paper-icon-item`           | Mixin applied to the item                      | `{}`
  `--paper-item-selected-weight`| The font weight of a selected item             | `bold`
  `--paper-item-selected`       | Mixin applied to selected paper-items                | `{}`
  `--paper-item-disabled-color` | The color for disabled paper-items             | `--disabled-text-color`
  `--paper-item-disabled`       | Mixin applied to disabled paper-items        | `{}`
  `--paper-item-focused`        | Mixin applied to focused paper-items         | `{}`
  `--paper-item-focused-before` | Mixin applied to :before focused paper-items | `{}`
  
  
  ##&lt;paper-item-body&gt;
  
  
  Use `<paper-item-body>` in a `<paper-item>` or `<paper-icon-item>` to make two- or
  three- line items. It is a flex item that is a vertical flexbox.
  
      <paper-item>
        <paper-item-body two-line>
          <div>Show your status</div>
          <div secondary>Your status is visible to everyone</div>
        </paper-item-body>
      </paper-item>
  
  The child elements with the `secondary` attribute is given secondary text styling.
  
  ### Styling
  
  The following custom properties and mixins are available for styling:
  
  Custom property | Description | Default
  ----------------|-------------|----------
  `--paper-item-body-two-line-min-height`   | Minimum height of a two-line item          | `72px`
  `--paper-item-body-three-line-min-height` | Minimum height of a three-line item        | `88px`
  `--paper-item-body-secondary-color`       | Foreground color for the `secondary` area  | `--secondary-text-color`
  `--paper-item-body-secondary`             | Mixin applied to the `secondary` area      | `{}`
  
  
  
  <!-- No docs for Polymer.PaperItemBehavior found. -->