sigilUI

Scroll Progress

Indicate how far the user has scrolled through content.

@sigil-ui/componentsReact

Preview

Live preview Interactive

Import

import { ScrollProgress } from "@sigil-ui/components";

Usage

<div className="w-full"><p>Reading progress · 64%</p><ScrollProgress fixed={false} value={64} height={8} aria-label="Reading progress" className="w-full bg-[var(--s-surface)]" /></div>

Props

PropTypeDefaultDescription
position"top" | "bottom"topPosition on screen.
heightnumber3Bar height in pixels.
fixedbooleantrueWhether to use fixed positioning.
valuenumber—Controlled progress value from 0 to 100. Defaults to document scroll progress.

Token integration

CSS VariablePurpose
--s-primaryPrimary