aboutsummaryrefslogtreecommitdiff
path: root/catapult/third_party/polymer/components/paper-toast/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'catapult/third_party/polymer/components/paper-toast/README.md')
-rw-r--r--catapult/third_party/polymer/components/paper-toast/README.md72
1 files changed, 72 insertions, 0 deletions
diff --git a/catapult/third_party/polymer/components/paper-toast/README.md b/catapult/third_party/polymer/components/paper-toast/README.md
new file mode 100644
index 00000000..3c9287dd
--- /dev/null
+++ b/catapult/third_party/polymer/components/paper-toast/README.md
@@ -0,0 +1,72 @@
+
+<!---
+
+This README is automatically generated from the comments in these files:
+paper-toast.html
+
+Edit those files, and our readme bot will duplicate them over here!
+Edit this file, and the bot will squash your changes :)
+
+The bot does some handling of markdown. Please file a bug if it does the wrong
+thing! https://github.com/PolymerLabs/tedium/issues
+
+-->
+
+[![Build status](https://travis-ci.org/PolymerElements/paper-toast.svg?branch=master)](https://travis-ci.org/PolymerElements/paper-toast)
+
+_[Demo and API docs](https://elements.polymer-project.org/elements/paper-toast)_
+
+
+##&lt;paper-toast&gt;
+
+Material design: [Snackbars & toasts](https://www.google.com/design/spec/components/snackbars-toasts.html)
+
+`paper-toast` provides a subtle notification toast. Only one `paper-toast` will
+be visible on screen.
+
+Use `opened` to show the toast:
+
+Example:
+
+```html
+<paper-toast text="Hello world!" opened></paper-toast>
+```
+
+Also `open()` or `show()` can be used to show the toast:
+
+Example:
+
+```html
+<paper-button on-click="openToast">Open Toast</paper-button>
+<paper-toast id="toast" text="Hello world!"></paper-toast>
+
+...
+
+openToast: function() {
+ this.$.toast.open();
+}
+```
+
+Set `duration` to 0, a negative number or Infinity to persist the toast on screen:
+
+Example:
+
+```html
+<paper-toast text="Terms and conditions" opened duration="0">
+ <a href="#">Show more</a>
+</paper-toast>
+```
+
+### Styling
+
+The following custom properties and mixins are available for styling:
+
+| Custom property | Description | Default |
+| --- | --- | --- |
+| `--paper-toast-background-color` | The paper-toast background-color | `#323232` |
+| `--paper-toast-color` | The paper-toast color | `#f1f1f1` |
+
+This element applies the mixin `--paper-font-common-base` but does not import `paper-styles/typography.html`.
+In order to apply the `Roboto` font to this element, make sure you've imported `paper-styles/typography.html`.
+
+