WP Reading Progress

Description

The reading progress bar is a great user experience on longreads. Especially if it accurately depicts the reading progress in the article text, and nothing else. This is standard on single blog posts and enabled by default.

Customization:

  • Location top of screen, bottom of screen or below a sticky menu.

  • Choose color of the reading progress bar.

  • Have the bar start at 0% even when part of the article is visible.

  • Select post types you wish the bar to appear, or individual posts.

Behaviour:

  • The reading progress bar has smooth initializing since part of the text may already be visible, after that a lightweight update-function ensures quick response while scrolling.

  • The bar can attach itself to any (sticky) element that you can define as an admin, the first selected visible element will be used.

  • When there is no (longer a) visible element to attach to, the bar displays at the top.

  • If there is no single article identified (by class names or id) it uses the whole page to calculate progress.

This is my 6th WordPress plugin but my first one freely available to everybody. I hope you enjoy using it as much as I enjoy building it!

Regards,
Joeri (ruige hond)

Screenshots

  • Example of the reading progress bar on my photography blog
  • WP Reading Progress settings page
  • Activate the bar for an individual post (if that post type is not enabled)

Installation

  1. Install the plugin by clicking ‘Install now’ below, or the ‘Download’ button, and put the WP-reading-progress folder in your plugins folder

  2. By default it only works on single blog posts and uses an orange colour

  3. Go to settings->WP Reading Progress to customize it

Upon uninstall WP Reading Progress removes its own options and post_meta data (if any) leaving no traces.

Reviews

March 11, 2021 1 reply
This Plugin works fine with Generatepress Theme. If u use the sticky navigation, then u can set: ".navigation-stick" in the top field and it works.
November 25, 2020
Maybe someone find it helpful: if you are using WordPress and an Avada-Theme and you try to arrange the WP Reading Progress-Bar under a sticky menu insert ".fusion-header" and there you go... BIG BIG thanks to Joeri. He replied super fast and helped me fixing my issue. Great plugin, super useful and easy to manage. Cheers, Phil
Read all 12 reviews

Contributors & Developers

“WP Reading Progress” is open source software. The following people have contributed to this plugin.

Contributors

“WP Reading Progress” has been translated into 6 locales. Thank you to the translators for their contributions.

Translate “WP Reading Progress” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.4.0: compatible with fixed menus that consist of different elements depending on screen size, as long as they have a common selector

1.3.8: refactor javascript slightly smaller, make scroll eventlistener passive

1.3.7: added aria-role and aria-value updating for screenreaders

1.3.6: moved css to head to avoid render blocking, added option ‘no css’ if you want to handle it yourself

1.3.5: improved get top position custom function to include edge cases, debounced resize event

1.3.4: removed jQuery dependency

1.3.3: fixed implode deprecated notice

1.3.2: fix getBoundingClientRect does not work on iOS 8 and 9 (at least), now using custom function for it

1.3.1: some optimizations regarding the on scroll function

1.3.0: now positions itself snugly to element using top-margin or fixed automatically to top when element is not in viewport or gone

1.2.5: improved fallback for mobile, added rtl support (html tag must contain dir=”rtl”)

1.2.4: added regular post type to settings, added fallback find post by id when not found by class names, added option to display on specific posts only

1.2.3: fixed bug initializing window height to 0 on page load in some cases

1.2.2: increased compatibility with themes regarding looking for single article

1.2.1: added option to start bar at 0%, slightly optimized progress function

1.2.0: improved behaviour upon resize of the window

1.1.0: now identifies single post reading area for all post-types, fallback to body when not found in DOM

1.0.3: fixed translation, corrected license indication

1.0.2: translated to Dutch

1.0.1: minified javascript and css, fixed issue of bar sometimes momentarily disappearing on mobile device while scrolling

1.0.0: release