VibeUI
РусEng
Sign in
All1346Button124Input99Select40Card145Table33Dialog39Tabs14Badge33Avatar54Toast25Accordion32Alert35Button group77Calendar48Carousel28Chart36Checkbox & toggles59Code Block31Combobox62Command15Device Mockup10Dropdown menu32Empty20Loading32Navigation48Popover39Slider20Specialized inputs64Stepper29Tree19Typography4

Navigation

Reading Progress

A documentation sidebar that answers two questions at once: the highlight says where you are, the vertical bar says how much text is left.

React + Tailwind, shadcn-compatible: press “Copy for AI” and your Cursor or Claude Code agent installs it with the shadcn CLI.

What you can change

  • the column heading through title
  • the sections through sections: id, title and text
  • the accent colour through accent

A link for your AI agent: preview, code and instructions.

Preview

1440pxHost theme
Reading Progress — A documentation sidebar that answers two questions at once: the highlight says where you are, the vertical bar says how much text is left.

Use it with AI

  1. 1. Copy the link.
  2. 2. Write to your agent in your own words and drop the link into the sentence.
  3. 3. The agent opens the link and installs the component from the registry.
AI
1Pick it here

put this on the home page as the hero:

https://vibeui.club/c/scrollspy-004?lang=en&theme=dark

2Paste into the chat
3Get it in your project

Not sure where to paste it? Step-by-step guide

Show the full instructions

What the link says, spelled out. Use it when your agent cannot open links — paste this text instead.

Loading…

How to use

<Scrollspy004
  title="Documentation"
  sections={[
    { id: "install", title: "Install", text: "One command copies the component into the project" },
    { id: "theming", title: "Theming", text: "Colours live in local variables" },
  ]}
/>

A sample call. The agent installs the component itself from the registry via the “Copy for AI” link.

Settings

Heading
title · default: Documentation
Accent
accent · default: theme colour
Background
background · default: theme colour

More in Navigation

FAQ

How do I add Reading Progress with Cursor or Claude Code?
Press “Copy for AI” on this page and paste it into your agent's chat. The instruction contains the shadcn CLI install command, the dependencies and what to keep, so the agent installs this exact component instead of recreating a lookalike.
What does Reading Progress depend on?
No npm packages beyond React and Tailwind CSS.
What can I change in Reading Progress?
Adapt: the column heading through title; the sections through sections: id, title and text; the accent colour through accent. Keep as installed: the local --vibeui-scrollspy-004-* palette — do not swap it for your theme tokens; computing progress from scrolling: "third of six" is not half of the text; role="progressbar" with aria-valuenow — a bar without a role tells a screen reader nothing.
Is Reading Progress free?
Yes. The preview is open without an account; with a free account you can copy up to 20 components a month.

For developers

npx shadcn@latest add https://vibeui.club/r/pro/scrollspy-004.json

This command needs a signed link: sign in and open “Component source” below — it issues a working link valid for 30 minutes. All install options

Technical notes

The component is self-contained: one file, no dependencies, the palette in local variables --vibeui-scrollspy-004-*. Client-side ("use client") — IntersectionObserver and a scroll handler are needed. The observer finds the active section, while the read percentage is computed from the reading area's scrollTop and scrollHeight and goes into CSS through the variable --vibeui-scrollspy-004-progress: the share of the text and the section number are different quantities, because sections differ in length. The bar is marked with role="progressbar" and aria-valuenow, the links stay plain anchors.

Tags

  • scrollspy
  • docs
  • progress
  • sidebar
Component source

The same file your agent installs. Here in case you would rather copy it by hand.

Loading…