a jQuery plugin for reading progress
HTML CSS JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
.gitignore
LICENSE
README.md
bower.json
gulpfile.js
index.html
jquery.readingTime.js
jquery.readingTime.min.js
package.json

README.md

readingTime, a jQuery plugin for reading progress

Usage

To use simply include plugin file (and jQuery) and call on main container like so:

<script src="//ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js"></script>
<script src="jquery.readingTime.min.js"></script>
<script>
$(function() {
	$(".container").readingTime();
});
</script>

You will need to do some basic styling, such as position the elements where you want on screen and giving a background color to the progress bar and such. I've included an example so you can see all of this in action (both scss and compiled css provided, as well as a gulp file to work with).

Options

wpm

Words Per Minute

wpm: 300

copyEl

Element that contains Copy

copyEl: '.copy',

remainingEl

Element (will be generated) that is the parent container to the progress bar and remaining text label

remainingEl: '.left',

CounterEl

Element that holds the text for how much time is left to finish reading the page.

counterEl: '.counter',

percEl

Element that creates the progress bar

percEl: '.perc'

Demo

CodePen Demo

Ideas, Forks, Issues

If you have any cool ideas, bugs you notice or anything else really, please Download, Fork, Commit, and send it my way.

License

The MIT License (MIT)

Copyright (c) 2015 Jon Stuebe

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.