Display a loading or progress dialog.

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

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

<nebula-loader>

Display a loading progress overlay.

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

Installation

$ bower install arsnebula/nebula-loader

Getting Started

Import the package.

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

Add the element.

<nebula-loader
  title="Loader"
  icon="icons:refresh"
  progress=40
  text="40%">
</nebula-loader>

The element is also designed to be easy to create programatically. The show method will ensure the element is appended and removed from the document.body automatically. The method returns a promise that is resolved when the element is closed.

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

// show the element - automatically appended to document.body
loader.show({
  title: 'Loading',
  icon: 'icons:refresh',
  progress: 40,
  text: '40%' 
}).then(() => {
  console.log('Loader has been closed')
})

// update the progress as applicable (if showing progress bar)
loader.progress = 50
loader.text = '50%'

// cancel when finished background work
loader.close()

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 22 May 2017ISC License
Framework Support
Polymer 2.0+
Also supported:
Polymer 1 (2.0.0)
Browser Compatibility
Install with
bower install --save arsnebula/nebula-loader"#2.1.0"
Run the above Bower command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 2.1.0

Dependencies

  • polymer#Polymer/polymer#^2.0.0
  • nebula-element-mixin#arsnebula/nebula-element-mixin#^2.0.0
  • nebula-icons#arsnebula/nebula-icons#^2.0.0
  • nebula-progress#arsnebula/nebula-progress#^2.0.0
  • nebula-dialog#arsnebula/nebula-dialog#^2.0.0