Directory

← Back

nebula-toast

Display a toast notification.

Author

Contributors

Rating

[ This description is mirrored from README.md at github.com/arsnebula/nebula-toast on 2019-05-10 ]

Published on webcomponents.org Polymer Version Sauce Labs Build Status Gitter Chat Become a Patreon

<nebula-toast>

Display an animated toast notification.

  • Responsive design adapts to screen size
  • Can be positioned at the top or the bottom of the screen
  • Supports a11y for accessability
  • Customizable duration

Installation

$ bower install -S arsnebula/nebula-toast

Getting Started

Import the package.

<link rel="import" href="/bower_components/nebula-toast/nebula-toast.html"> 

Add the element.

<nebula-toast
  id="toast"
  text="Hello World"
  position="top"
  duration=5000
  opened="{{opened}}">
</nebula-toast>

Add and configure the element programatically using the show method. The element is appended and removed from the document.body automatically.

let toast = document.createElement('nebula-toast')
toast.show({
  text: 'Hello world',
  duration: 5000
}).then(function() {
  console.log('The toast has closed')
})

Style the element.

nebula-toast {
  color: white;
  background-color: darkred;
}

For more information, see the API documentation.

Contributing

We welcome and appreciate feedback from the community. Here are a few ways that you can show your appreciation for this package:

  • Give us a Star on GitHub from either webcomponents.org or directly on GitHub.

  • Submit a feature request, or a defect report on the Issues List.

  • Become a Patreon. It takes a lot of time and effort to develop, document, test and support the elements in our Nebula Essentials collection. Your financial contribution will help ensure that our entire collection continues to grow and improve.

If you are a developer, and are interested in making a code contribution, consider opening an issue first to describe the change, and discuss with the core repository maintainers. Once you are ready, prepare a pull request:

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Change Log

See CHANGELOG

License

See LICENSE

Compatibility

(Loading compatibility data...)

Was this helpful? Need more help?
Leave a comment or a question below. You can also join the chat on Discord or ask questions on StackOverflow.

Version

Dependencies

  • polymer#Polymer/polymer#^2.0.0
  • nebula-element-mixin#arsnebula/nebula-element-mixin#^2.0.0
Released
2017-05-22
Maturity
IMPORTED
License
ISC License

Compatibility

Framework
Polymer 2.0+
Polymer 1.0+ in 2.0.1
Browser
Browser Independent
Online