Story Progress
Segmented, auto-advancing progress like Instagram stories, with pause support.
- Category: Feedback
- Licence: Charcoal UI Pro
- Built with: React 19, Tailwind CSS 4, Motion
- Dependencies: motion, clsx, tailwind-merge
Examples
Story Progress
API reference
| Prop | Type | Default | Description |
|---|---|---|---|
count | number | — | |
index / defaultIndex | number | — | |
onIndexChange | (index: number) => void | — | |
duration | number | 4 | |
paused | boolean | — | |
onComplete | () => void | — |
About Story Progress
Story Progress is the segmented, auto-advancing bar from Instagram stories, with pause on hold. Use it for tours, slides and onboarding sequences.
Story Progress is a feedback 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 Story Progress
- Story-style product tours.
- Onboarding slides.
- Media slideshows.
- Release highlights.
How it works
Each segment fills over the duration and hands off to the next. Pausing freezes the active segment, and onComplete fires after the last.
State changes are announced through live regions or the right ARIA roles, so screen-reader users hear what sighted users see. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.
Customizing Story 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 duration live, and the Code tab updates to match, so the snippet you copy already carries your values.
- count (number).
- index / defaultIndex (number).
- duration (number, default 4).
- paused (boolean).
Goes well with Story Progress
These feedback pieces share its tokens and motion language, so they sit together on one page without clashing.
- Typing Indicator: A React typing indicator: a bubble with rippling dots that tells screen readers who is typing
- Countdown: An animated React countdown timer whose digits roll as they tick
- Confetti: React confetti that bursts from any point on a throwaway canvas
- Ripple: A React press ripple that spreads from the exact point you pressed
- Success Check: A React spinner that resolves into a drawn check or a shaking cross
Install Story Progress
npx shadcn@latest add @charcoal/story-progressStory 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 story-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
- Can users pause story progress?
- Yes. Pressing and holding pauses the active segment, just like stories on social apps, and releasing resumes it.
- How do I install Story Progress?
- Story 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/story-progress. It copies story-progress.tsx into components/ui and installs motion, clsx, tailwind-merge.
- Is Story Progress free for commercial use?
- Story 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 Story 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 Story Progress?
- Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Story Progress's props and get_install_command returns the exact command.