Ruler-style scroll indicator with tick marks that fill in as the page scrolls and a live percentage readout.
npx shadcn@latest add @iconiq/scroll-progress"use client";
import { ScrollProgress } from "@/components/ui/scroll-progress";
export function ScrollProgressPreview() {
return <ScrollProgress position="right" />;
}positionWhich side or corner of the viewport the ruler docks to. The percentage label always reads inward, toward the page content.
Type "left" | "right" | "bottom-left" | "bottom-right"·Default "right"
tickCountNumber of tick marks drawn along the ruler.
Type number·Default 20
heightRuler height in pixels.
Type number·Default 160
widthRuler width in pixels — how far the tick marks extend.
Type number·Default 14
showLabelShow the numeric percentage readout beside the ruler.
Type boolean·Default true
containerTrack a scrollable element instead of the page. Only controls which element's scroll position is read — does not affect CSS positioning. Omit to track window scroll.
Type RefObject<HTMLElement | null>
positionModeOverride CSS position. Defaults to `"fixed"` so the ruler is always anchored to the viewport edge. Pass `"absolute"` to dock it inside a `relative` ancestor instead.
Type "fixed" | "absolute"·Default "fixed"
classNameExtra classes applied to the fixed outer wrapper.
Type string
Contact
Additionally, if you find any bug or issue, feel free to raise an issue.
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Animi alias similique eveniet corrupti cupiditate, saepe magni, distinctio at dolor dignissimos consequatur rerum quasi expedita soluta amet, fugiat quaerat commodi accusamus enim necessitatibus facere cumque dolores quisquam. Vero harum repellendus labore. Aut voluptates reiciendis odit rem quibusdam beatae, tenetur eveniet nisi consectetur nam sapiente dolorem explicabo nesciunt numquam quaerat temporibus illo laboriosam aliquam et perferendis.
Perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est qui dolorem ipsum quia dolor sit amet consectetur adipisci velit sed quia non numquam eius modi tempora incidunt.
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium. Totam rem aperiam eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit. Sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt, neque porro quisquam est qui dolorem ipsum quia dolor sit amet consectetur adipisci velit sed quia non numquam eius modi tempora incidunt.
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident. Similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio nam libero tempore cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus.
Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur vel illum qui dolorem eum fugiat quo voluptas nulla pariatur. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.
Nam libero tempore cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.
Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam nisi ut aliquid ex ea commodi consequatur. Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur vel illum dolorem eum fugiat quo voluptas nulla pariatur. Excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi id est laborum et dolorum fuga et harum rerum facilis est expedita distinctio.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium totam rem aperiam eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo nemo enim ipsam voluptatem sit aspernatur.
Ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam quis nostrum exercitationem ullam corporis suscipit laboriosam nisi ut aliquid ex ea commodi consequatur. Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur vel illum dolorem eum fugiat. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint molestiae non recusandae itaque earum.
Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est qui dolorem ipsum quia dolor sit amet consectetur adipisci velit sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem totam aperiam eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo nemo.