Scroll Progress
A thin glowing ember bar that fills as you read the page or any scroll container.
- Category: Navigation
- Licence: Charcoal UI Pro
- Built with: React 19, Tailwind CSS 4, Motion
- Dependencies: motion, clsx, tailwind-merge
Examples
Scroll Progress
API reference
| Prop | Type | Default | Description |
|---|---|---|---|
container | RefObject<HTMLElement> | — | Defaults to the page. |
className | string | — |
About Scroll Progress
Scroll Progress is a thin glowing bar that fills as the reader moves through the page or any scroll container. It is a quiet way to show how much of an article is left.
Scroll Progress is a navigation component for React 19, styled with Tailwind CSS 4 and animated with Motion. It drops into Next.js, Vite, Remix or Astro through the shadcn CLI as a single file you own.
When to use Scroll Progress
- Blog posts and long articles.
- Docs pages.
- Long landing pages and case studies.
- Reading modes in apps.
How it works
It reads scroll progress with Motion's useScroll and smooths it with a spring, transforming only scaleX so it never triggers layout. Pass a container ref to track a scrolling element instead of the page.
Links and buttons keep their roles, arrow keys move where a group is expected, the current item is marked with aria-current, and focus is always visible. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.
Customizing Scroll Progress
Every prop is documented in the API reference above with its type and default. The ones you will reach for first are listed here.
The Customize panel next to the preview lets you change heading live, and the Code tab updates to match, so the snippet you copy already carries your values.
- container (RefObject<HTMLElement>): Defaults to the page.
Goes well with Scroll Progress
These navigation pieces share its tokens and motion language, so they sit together on one page without clashing.
- Dock: A macOS-style React dock whose icons swell with pointer distance and show labels
- Expandable Tabs: Compact React icon tabs where the active tab expands to reveal its label
- Floating Nav: A floating React pill nav that hides on scroll down and returns on scroll up
- Context Menu: A React right-click context menu that opens at the pointer and stays on screen
- Bottom Nav: An animated React mobile tab bar with a sliding pill, hopping icons and badges
Install Scroll Progress
npx shadcn@latest add @charcoal/scroll-progressScroll Progress is part of Charcoal UI Pro. One seat unlocks all 300 Pro components, 107 landing-page sections and 100 full templates, for every personal and client project, with updates included. Add the @charcoal registry once with your access token, then the command above copies scroll-progress.tsx into components/ui and installs clsx, tailwind-merge.
You own the file you install: no runtime package, no lock-in, nothing to keep in sync. Change it however your product needs.
See Charcoal UI Pro pricing · Pro setup
Frequently asked questions
- How do I install Scroll Progress?
- Scroll Progress is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/scroll-progress. It copies scroll-progress.tsx into components/ui and installs motion, clsx, tailwind-merge.
- Is Scroll Progress free for commercial use?
- Scroll Progress needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.
- Does Scroll Progress work with Next.js?
- Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.
- Can an AI coding agent install Scroll Progress?
- Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Scroll Progress's props and get_install_command returns the exact command.