Skip to content
GaudiGaudi Design System home

Search documentation

Search every page, heading and paragraph.

ReadingIndicator

Reading progress as a classic top bar, a vertical ruler with a moving percentage, or a movable circular meter.

CoreBasics@gaudi/design-system/core/ReadingIndicatorView in StorybookSource

Installation

pnpm add github:ahmadassaf/design-system

Import from @gaudi/design-system. Load @gaudi/design-system/global.css once and add transpilePackages: ['@gaudi/design-system'] in Next.js.

import { ReadingIndicator } from '@gaudi/design-system/core/ReadingIndicator';

Usage

import { ReadingIndicator } from '@gaudi/design-system/core/ReadingIndicator';
// Render once near the page root.<ReadingIndicator />

Examples

Playground

Storybook

Bar, ruler and ring

Storybook

Article range

Storybook

Top of page

Storybook

API

11 props

Accessibility

Exposes a named progressbar without live announcements on every scroll. The indicator does not capture scrolling or text selection; only the optional ring handle receives input. Reduced motion removes the number transition. Progress measures scroll position, not comprehension.

Notes

  • Resizes and content growth are measured automatically. A non-scrollable document is complete (100%); an unresolved target starts at 0%.
  • Reserve a side gutter for the ruler and room for the ring so they do not cover reading text. Set style.top to place a fixed bar below a site header. For a top bar with no extra configuration, render <ReadingIndicator /> once in the page.
  • The ruler and ring are independently implemented interpretations of the Skiper UI scroll progress references; no remote assets or registry code are loaded.