An alert dialog.

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

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

<nebula-alert>

A customizable alert dialog.

  • A full-screen overlay with backdrop and centered dialog
  • Supports optional title, icon, text and buttons
  • Supports WAI-ARIA for a11y

Installation

$ bower install -S arsnebula/nebula-alert

Getting Started

Import the package.

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

Add the element.

<nebula-alert
  title="Alert"
  icon="icons:warning"
  text="You have been warned."
  buttons='["OK"]'
  on-closed="_onClosed"
  result="{{alertResult">
</nebula-alert>

You can also easily create and display the element programatically using the show method. The element is appended and removed from the document.body automatically.

// create the element
const alert = document.createElement('nebula-alert')

// update any styles
alert.updateStyles({
  '--nebula-alert-color': 'white',
  '--nebula-alert-background-color': 'black',
  '--nebula-alert-border-color': 'silver',
})

// show the element - automatically appended to document.body
alert.show({
  title: 'Alert',
  icon: 'icons:warning',
  text: 'You have been warned',
  buttons: ['OK']
}).then(function(result) {
  console.log('The alert has been closed', result)
})

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

Install

Link to this version
ImportedReleased 23 April 2017ISC License
Framework Support
Polymer 1.0+
Polymer 2.0+
Browser Compatibility
Install with
bower install --save arsnebula/nebula-alert"#2.0.0"
Run the above Bower command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 2.0.0

Dependencies

  • polymer#Polymer/polymer#>=2.0.0-rc.1 <3.0
  • nebula-element-mixin#arsnebula/nebula-element-mixin#^2.0.0
  • nebula-icons#arsnebula/nebula-icons#^2.0.0
  • nebula-button#arsnebula/nebula-button#^2.0.0
  • nebula-dialog#arsnebula/nebula-dialog#^2.0.0
  • nebula-appbar-layout#arsnebula/nebula-appbar-layout#^2.0.0