angular-reading-indicator

Angular Reading Indicator Plugin
Homepage:
1 person uses it

angular-reading-indicator

AngularJS directive that shows progressbar with the current reading progress of a given article or the whole website with a reading time estimate.

Copyright (C) 2015, Dominic Rico-Gomez hello@coderocket.me

Build Status Coverage Status

Installation

You can choose your preferred method of installation: * Through bower: bower install angular-reading-indicator --save * Through npm: npm install angular-reading-indicator --save * From a CDN: jsDelivr * Download from github: angular-reading-indicator

Usage

Include both ng-reading-indicator.min.js and ng-reading-indicator.min.css in your application.

Add the module ngReadingIndicator as a dependency to your app module:

Configuration

Set your prefered options to customize the look of the progress bar and reading estimate. Available/Default options:

ngReadingIndicator directive

Use ng-reading-indicator directive to display the reading progress on top of the window:

If you want to display a different text then the headline use the "indicator-headline"-attribute.
If you want to use the progress bar just for one special element use the indicator-element-attribute and insert the classname (only the first element with class will be used, will be extendet to id in future release)

License

Released under the terms of the MIT License.

comments powered by Disqus
This page was last updated over 1 year ago.