paper-toast - Vaadin Add-on Directory
A Material Design popup toast[![Published on NPM](https://img.shields.io/npm/v/@polymer/paper-toast.svg)](https://www.npmjs.com/package/@polymer/paper-toast)
[![Build status](https://travis-ci.org/PolymerElements/paper-toast.svg?branch=master)](https://travis-ci.org/PolymerElements/paper-toast)
[![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://webcomponents.org/element/@polymer/paper-toast)
## <paper-toast>
`paper-toast` provides a subtle notification toast. Only one `paper-toast` will
be visible on screen.
Use `opened` to show the toast:
Example:
```html
```
Also `open()` or `show()` can be used to show the toast:
Example:
```html
Open Toast
...
openToast: function() {
this.$.toast.open();
}
```
Set `duration` to 0, a negative number or Infinity to persist the toast on screen:
Example:
```html
Show more
```
`` is affected by the [stacking context](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Positioning/Understanding_z_index/The_stacking_context) of its container. Adding `` inside elements that create a new stacking context - e.g. ``, `` or `` - might result in toasts partially obstructed or clipped. Add `` to the top level (``) element, outside the structure, e.g.:
```html
```
You can then use custom events to communicate with it from within child components, using `addEventListener` and `dispatchEvent`.
### 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`.
See: [Documentation](https://www.webcomponents.org/element/@polymer/paper-toast),
[Demo](https://www.webcomponents.org/element/@polymer/paper-toast/demo/demo/index.html).
## Usage
### Installation
```
npm install --save @polymer/paper-toast
```
### In an html file
```html
```
### In a Polymer 3 element
```js
import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/paper-toast/paper-toast.js';
class SampleElement extends PolymerElement {
static get template() {
return html`
`;
}
}
customElements.define('sample-element', SampleElement);
```
## Contributing
If you want to send a PR to this element, here are
the instructions for running the tests and demo locally:
### Installation
```sh
git clone https://github.com/PolymerElements/paper-toast
cd paper-toast
npm install
npm install -g polymer-cli
```
### Running the demo locally
```sh
polymer serve --npm
open http://127.0.0.1:/demo/
```
### Running the tests
```sh
polymer test --npm
```