third_party/polymer/v1_0/components-chromium/paper-fab/README.md

   1 paper-fab
   2 =========
   3
   4 Material Design: <a href="http://www.google.com/design/spec/components/buttons.html">Button</a>
   5
   6 `paper-fab` is a floating action button. It contains an image placed in the center and
   7 comes in two sizes: regular size and a smaller size by applying the attribute `mini`. When
   8 the user touches the button, a ripple effect emanates from the center of the button.
   9
  10 You may import `iron-icons` to use with this element, or provide a URL to a custom icon.
  11 See `iron-iconset` for more information about how to use a custom icon set.
  12
  13 Example:
  14
  15 ```html
  16 <link href="path/to/iron-icons/iron-icons.html" rel="import">
  17
  18 <paper-fab icon="add"></paper-fab>
  19 <paper-fab mini icon="favorite"></paper-fab>
  20 <paper-fab src="star.png"></paper-fab>
  21 ```
  22
  23 Styling
  24 -------
  25
  26 Style the button with CSS as you would a normal DOM element. If you are using the icons
  27 provided by `iron-icons`, the icon will inherit the foreground color of the button.
  28
  29 ```html
  30 <!-- make a blue "cloud" button -->
  31 <paper-fab icon="cloud" style="color: blue;"></paper-fab>
  32 ```
  33
  34 By default, the ripple is the same color as the foreground at 25% opacity. You may
  35 customize the color using this selector:
  36
  37 ```css
  38 /* make #my-button use a blue ripple instead of foreground color */
  39 #my-button::shadow #ripple {
  40   color: blue;
  41 }
  42 ```
  43
  44 The opacity of the ripple is not customizable via CSS.