ARIA PROGRESSBAR
About
HTML, CSS and JS UI-component for user-friendly and accessible progress bars. Go to demo page or check on npm.
- User-friendly and accessible
- Less than 2KB (minified).
- Compatible with amd and require.js
Dependencies
jQuery
Developed and tested with jQuery 3.2.1
Settings / Options
| Name | Default | Type | Description |
|---|---|---|---|
| progressClass | progress | string | The class of the progress bar wrapper. |
| progressBarClass | progress__bar | string | The class of the progress bar. |
| maxVal | 100 | int | The maximum value of the progress bar (task % = 100% - task completed!). |
| textLabel | {X} percent completed | string | String used to generate a user-readable version of the progress value (see https://www.w3.org/TR/wai-aria-1.1/#aria-valuetext for more informations) ({X} will be automatically replaced with the current progress value). |
| destroyDelay | 300 | int >= 0 | Interval in ms: Delay the call of destroy() when task is complete and progress is 100% (the time is needed to complete the CSS transition of the progress bar). |
| destroyFadeOutSpeed | 300 | int >= 0 | Speed of jQuery fade-out animation, performed when destroy() is called, before removing the element from DOM. |
Installation
Download the package from GitHub and get the compiled files from the dist folder.
The plugin is also available on npm:
npm install t-aria-progressbar Usage
- Include the JS script aria-progressbar.js - or the minified production script aria-progressbar.min.js- in the head or the body of your HTML file.
- Include the CSS file aria-progressbar.css in the head of your HTML file or include the SCSS files in your project.
- Initialise the widget within an inline script tag, or in an external JS file.
JS: Initialise
Initialise the plugin as follows:
$('#progress-container').ariaProgressbar({ option1: value1, option2: value2 });Methods
The plugin supports following methods: update, destroy.
Update:
To update a progress bar call ariaProgressbar and pass 'update' as first parameter and the value indicating the current task progress as second parameter. If the progress value is indeterminate, simply do not perform any call to the update method. By not calling update the attribute aria-valuenow will be omitted and the widget will conform the requirements of the WAI-ARIA specification. For more infos check (https://www.w3.org/TR/wai-aria/roles#progressbar)[https://www.w3.org/TR/wai-aria/roles#progressbar]).
$('#my-progressbar').ariaProgressbar('update', 10);Destroy
The destroy method removes the progress bar from DOM. The method is automatically called from the widget, when the progress value passed to update is equal to maxVal. If, for any reason, the widget must be removed before the task is completed (e.g. user interrupts process), then use the destroy method to remove the widget:
$('#my-progressbar').ariaProgressbar('destroy');Custom events
This plugin triggers the following events:
- ariaProgressbar.initialised after the progress bar is initialised.
- ariaProgressbar.updated when the progress bar is updated.
- ariaProgressbar.destroy when the progress bar is removed from DOM.
The custom events are triggered on window and return the progress bar data object as argument.
//add event listener $(window).on('ariaProgressbar.initialised', function(event, el){ //perform an action el.progressbar.addClass('my-custom-class'); });LICENSE
This project is licensed under the terms of the MIT license.
See LICENSE.md for detailed informations.
