mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
77 lines
2.5 KiB
Markdown
77 lines
2.5 KiB
Markdown
|
|
<!---
|
|
|
|
This README is automatically generated from the comments in these files:
|
|
paper-button.html
|
|
|
|
Edit those files, and our readme bot will duplicate them over here!
|
|
Edit this file, and the bot will squash your changes :)
|
|
|
|
-->
|
|
|
|
[](https://travis-ci.org/PolymerElements/paper-button)
|
|
|
|
_[Demo and API Docs](https://elements.polymer-project.org/elements/paper-button)_
|
|
|
|
|
|
##<paper-button>
|
|
|
|
|
|
Material design: [Buttons](https://www.google.com/design/spec/components/buttons.html)
|
|
|
|
`paper-button` is a button. When the user touches the button, a ripple effect emanates
|
|
from the point of contact. It may be flat or raised. A raised button is styled with a
|
|
shadow.
|
|
|
|
Example:
|
|
|
|
<paper-button>Flat button</paper-button>
|
|
<paper-button raised>Raised button</paper-button>
|
|
<paper-button noink>No ripple effect</paper-button>
|
|
<paper-button toggles>Toggle-able button</paper-button>
|
|
|
|
A button that has `toggles` true will remain `active` after being clicked (and
|
|
will have an `active` attribute set). For more information, see the `Polymer.IronButtonState`
|
|
behavior.
|
|
|
|
You may use custom DOM in the button body to create a variety of buttons. For example, to
|
|
create a button with an icon and some text:
|
|
|
|
<paper-button>
|
|
<iron-icon icon="favorite"></iron-icon>
|
|
custom button content
|
|
</paper-button>
|
|
|
|
### Styling
|
|
|
|
Style the button with CSS as you would a normal DOM element.
|
|
|
|
paper-button.fancy {
|
|
background: green;
|
|
color: yellow;
|
|
}
|
|
|
|
paper-button.fancy:hover {
|
|
background: lime;
|
|
}
|
|
|
|
paper-button[disabled],
|
|
paper-button[toggles][active] {
|
|
background: red;
|
|
}
|
|
|
|
By default, the ripple is the same color as the foreground at 25% opacity. You may
|
|
customize the color using the `--paper-button-ink-color` custom property.
|
|
|
|
The following custom properties and mixins are also available for styling:
|
|
|
|
Custom property | Description | Default
|
|
----------------|-------------|----------
|
|
`--paper-button-ink-color` | Background color of the ripple | `Based on the button's color`
|
|
`--paper-button` | Mixin applied to the button | `{}`
|
|
`--paper-button-disabled` | Mixin applied to the disabled button. Note that you can also use the `paper-button[disabled]` selector | `{}`
|
|
`--paper-button-flat-keyboard-focus` | Mixin applied to a flat button after it's been focused using the keyboard | `{}`
|
|
`--paper-button-raised-keyboard-focus` | Mixin applied to a raised button after it's been focused using the keyboard | `{}`
|
|
|
|
|