Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 2 KB

README.md

File metadata and controls

44 lines (31 loc) · 2 KB

<nodecg-toast> Published on webcomponents.org Build Status Coverage Status Polymer 2 only

An implementation of paper-toast designed to work well in NodeCG dashboard panels. Requires Polymer 2.

Motivation

NodeCG dashboard panels are iframes. Showing toasts inside these iframes isn't always the best way of notifying a user. nodecg-toast reaches outside of the iframe and places a paper-toast in the top document. nodecg-toast then acts as a proxy to this top-level paper-toast. The result is that the dashboard panel can interact with nodecg-toast just as it would any other paper-toast, but the toast gets shown on the dashboard itself, instead of just within the iframe of the current panel.

Installation

From your bundle's root directory:

bower install --save NodeCGElements/nodecg-toast

Usage

<nodecg-toast text="Look at me!"></nodecg-toast>

For more detailed documentation, refer to paper-toast.

Contributing

  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

Credits

Based entirely on paper-toast by the Polymer Project.

License

nodecg-toast is provided under the MIT license, which is available to read in the LICENSE file.