Ballmac UI home

Scroll Progress

A thin reading-progress bar fixed to the top or bottom of the page, or to a scrollable panel, that fills on a soft spring (or exactly under reduced motion).

Designing calm software

Good interfaces make the next step obvious. They keep important information in view, hide what is not needed yet, and respond quickly enough that people never wonder whether something worked. Paragraph 1 of nine.

Good interfaces make the next step obvious. They keep important information in view, hide what is not needed yet, and respond quickly enough that people never wonder whether something worked. Paragraph 2 of nine.

Good interfaces make the next step obvious. They keep important information in view, hide what is not needed yet, and respond quickly enough that people never wonder whether something worked. Paragraph 3 of nine.

Good interfaces make the next step obvious. They keep important information in view, hide what is not needed yet, and respond quickly enough that people never wonder whether something worked. Paragraph 4 of nine.

Good interfaces make the next step obvious. They keep important information in view, hide what is not needed yet, and respond quickly enough that people never wonder whether something worked. Paragraph 5 of nine.

Good interfaces make the next step obvious. They keep important information in view, hide what is not needed yet, and respond quickly enough that people never wonder whether something worked. Paragraph 6 of nine.

Good interfaces make the next step obvious. They keep important information in view, hide what is not needed yet, and respond quickly enough that people never wonder whether something worked. Paragraph 7 of nine.

Good interfaces make the next step obvious. They keep important information in view, hide what is not needed yet, and respond quickly enough that people never wonder whether something worked. Paragraph 8 of nine.

Good interfaces make the next step obvious. They keep important information in view, hide what is not needed yet, and respond quickly enough that people never wonder whether something worked. Paragraph 9 of nine.

Installation

$ pnpm dlx shadcn@latest add @ballmac/scroll-progress

Usage

import { ScrollProgress } from "@/components/ballmac/scroll-progress"

The full example is in the Code tab above.

Examples

Bottom, thicker

A thicker bar along the bottom edge. Keep scrolling to fill it, line 1.

A thicker bar along the bottom edge. Keep scrolling to fill it, line 2.

A thicker bar along the bottom edge. Keep scrolling to fill it, line 3.

A thicker bar along the bottom edge. Keep scrolling to fill it, line 4.

A thicker bar along the bottom edge. Keep scrolling to fill it, line 5.

A thicker bar along the bottom edge. Keep scrolling to fill it, line 6.

A thicker bar along the bottom edge. Keep scrolling to fill it, line 7.

A thicker bar along the bottom edge. Keep scrolling to fill it, line 8.

API reference

PropTypeDefault
position

Which edge the bar sits on.

"top" | "bottom""top"
container

A scrollable element to track instead of the page. Give the bar `absolute` positioning inside its wrapper.

React.RefObject<HTMLElement | null>—
thickness

Bar thickness in pixels.

number3

Also accepts the standard attributes of its root element.

Accessibility

KeyAction
Screen readersDecorative (aria-hidden); the page's own scroll position is already exposed
Reduced motionNo spring smoothing

Quality scorecard

7/7

Every applicable check passes

Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 2 examples.

How we measure
  • Passed: Accessibility scan

    No serious or critical issues in light and dark, on a phone and a desktop (axe-core 4.13.0, WCAG 2.1 AA and best-practice rules).

  • Passed: Small screens

    No sideways scrolling at 360, 390 or 1280 px wide.

  • Passed: Reduced motion

    No endless animation to begin with.

  • Passed: Right to left

    Mirrors correctly in Arabic, Hebrew, Persian and Urdu layouts (0% of elements off the mirror, limit 15%).

  • Passed: Clean console

    No console errors or React hydration errors while loading.

  • Passed: Keyboard

    2 tab stops, each showing a visible change when it takes focus. 2 documented keys.

  • Not applicable: Loading, empty and error

    Does not show data or take submissions.

  • Passed: Automated tests

    Covered by scroll-progress.test.tsx.

  • For information: Footprint

    0.9 KB of source (gzip) in 1 file. Installs motion.

Automated checks find a subset of problems and do not replace testing with a screen reader and a keyboard in your own app. What they miss.

Use with AI

Render <ScrollProgress /> once. Pass container (a ref) to follow a scrollable element and add className='absolute' inside its wrapper. With the shadcn MCP server set up (guide), ask your agent:

Add the Ballmac UI Scroll Progress (@ballmac/scroll-progress) to this project with the shadcn MCP, then use it where it fits.

Use it for

  • Long articles and docs
  • Multi-section landing pages

Not for

  • Task or upload progress; use progress
  • Step indicators; use progress-steps

Registry JSON: https://ui.ballmac.com/r/scroll-progress.json

Credits

Free to use in personal and commercial projects.

Registry
shadcn/utils

Ballmac UI Pro

Need the whole screen, not one piece?

311 premium blocks (dashboards, settings, calendars, mail, shops, onboarding), a private shadcn registry and Figma tokens. Blocks that show data come with loading, empty and error states built in.

Not ready? Try three Pro blocks free

Leave your email and the blocks appear right here, ready to copy. Yours to use in any project.