HelixOverviewComponentsMapsGraphIntroductionInstallationDeriving a themeSandboxTheme builderVisual testingCortexDocsEngramActiveTraceActiveRecallActiveServicesInsightsGet in touchSource on GitHub
Loading the reference
Scroll ProgressView sourceEdit in SandboxView MarkdownCopy MarkdownOpen in ClaudeOpen in CursorA bar that fills as the page, or a box on it, is scrolled.Also called Reading progress, Scroll indicator, and Progress bar.ExperimentalSince 0.241.0FeedbackImportimport'@fusion.dev/helix/scroll-progress'Preview
API referenceRoothelix-scroll-progressA bar that fills as the page, or a box on it, is scrolled.
PropTypeDescriptionaxis"block"|"inline"The direction the scrolling runs: block, down a page, or inline,
along a row. Absent is block, and writes no attribute, so a served bar
and the bar after upgrade carry the same markup.forstringDefault""The id of the box that scrolls, looked up in the bar's own root, so a
bar inside a shadow root reads a box in that root.
ReadTypeDescriptionwhenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
PartDescriptionbarThe fill, scaled along its length by how far the page or the box is scrolled.trackThe full length the bar fills.
CSS PropertyDescription--scroll-progress-colorThe fill. Defaults to --helix-color-primary.--scroll-progress-sizeHow thick the bar is. Defaults to --helix-border-thick.--scroll-progress-track-colorThe ground under the fill. Transparent by default.--scroll-progress-valueHow far the page or the box is scrolled, from 0 at the start to 1 at the end. Written by the component.
Custom stateDescriptionsettledSet one frame after the first render. Transitions wait for it, so an element does not animate its own arrival.
Examples
NameDescriptionPreviewA bar that fills as the box under it is scrolled, empty at the top and full at the end.