Reading Progress Bar
Display page-scroll progress or progress within an independently scrollable container. Use it for long reading pages or a deliberate inner-scroll content panel, not for form steps, uploads, or cart rewards.
Setup and First Use
Before starting, enable the relevant element or feature family under Bricks → BricksUltimate → General Elements, save, and reopen the Bricks editor. Integrations also require their corresponding plugin to be active.
- Add (BU)Reading Progress Bar to the article template or intended page.
- Use body under Container selector for normal page scrolling. A custom selector must target an independently scrollable element with constrained dimensions and overflow; a normal article wrapper does not emit the required inner-scroll events.
- Choose Top or Bottom and set the bar Height.
- Set the track Bar Color and Progress Bar Color with enough contrast.
- Adjust Transition Speed(ms) and Z-Index for the site's header/overlay layout.
- Test the beginning, middle, and end of a long page, then repeat after images and dynamic content have loaded.
Controls and Settings
| Control | Purpose and usage |
|---|---|
| Container selector | body measures the document on window scroll. A custom CSS selector measures that element's own scrollTop, scrollHeight, and clientHeight. It is not an article-in-viewport progress calculation. |
| Height | Controls track/fill thickness; the control defaults to 5px. |
| Position | Places the bar at the top or bottom of the viewport presentation. |
| Transition Speed(ms) | Controls fill transition timing, not the visitor's scroll speed. |
| Z-Index | Adjust stacking relative to headers and overlays; avoid covering important controls. |
| Colors | Bar Color is the track; Progress Bar Color is the completed portion. |
Choose a Stable Measurement Area
With body, the measured document includes headers, related posts, and the footer. With a custom selector, the script listens to the selected element's own scroll event, not to the window. That element must actually scroll internally. Do not simply enter a normal article class and expect page-scroll progress to stop at the article end. A non-overflowing container has no useful scroll range.
Layout Changes and Scope
Late-loaded images, expanding accordions, and injected content can change the measured distance. Verify the final frontend layout rather than assuming the initial position is stable. This is a reading aid, not an accessibility requirement or proof that a visitor has read the text.
Practical Example
For a normal long article, use body and a thin top track. For a separately scrollable reading panel, give the panel constrained dimensions and overflow:auto, enter its unique selector, and confirm that scrolling inside that panel moves the fill.
Troubleshooting
- Bar stuck: check that the custom selector exists and its element scrolls internally, or use body for normal document scrolling.
- Completes after the article: body includes the rest of the page. Article-only progress during window scrolling is not provided by this custom-container mode.
- Appears behind the header: review stacking and position, not only its color.