# ScrollProgress

> Thin reading-progress bar that fills as the page — or a target element — scrolls, driven by a zero-JS CSS scroll-timeline where supported and a throttled scroll listener everywhere else, with an optional accessible progressbar label.

- Package: `fancy-ui-react` (React 18/19 + Tailwind CSS v4)
- Category: Navigation
- Tags: scroll, progress, reading-progress, navigation, scroll-timeline, micro-interaction
- Types: `ScrollProgressProps`
- Docs: https://fancy-ui.rama.app/docs/components/scroll-progress
- Source: https://github.com/RamaHerbin/fancy-ui/tree/main/react/src/components/scroll-progress

## Import

```tsx
import { ScrollProgress } from 'fancy-ui-react';
```

Setup (once per project): `npm install fancy-ui-react`, then put these lines in your main CSS file (the stylesheet import goes right after `@import "tailwindcss";`):

```css
@import "tailwindcss";
@import "fancy-ui-react/tailwind.css";
```

and import the component styles once in the app entry: `import "fancy-ui-react/styles.css";`. Full guide: https://fancy-ui.rama.app/llms.txt

The names below are the ones to write in React; when one differs from the Svelte name, the Svelte name follows in parentheses. `class` becomes `className`, a callback takes the name the React port declares (`onclick` becomes `onClick`), snippets become `ReactNode` props (render functions when they take arguments) and the default snippet is `children`. Divergences: https://github.com/RamaHerbin/fancy-ui/tree/main/react#divergences-from-the-svelte-api

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `target` | `HTMLElement \| null` | `null` | An element to track instead of the document. Forces JS mode — reactively, so a target that only becomes available after mount is still picked up correctly. |
| `position` | `"top" \| "bottom" \| "inline"` | `"top"` | "top"/"bottom" pin the bar to that viewport edge (position: fixed); "inline" renders it in normal flow. |
| `label` | `string` | — | Announces the bar as role="progressbar" with this accessible name. Forces JS mode; omitted, the bar is aria-hidden. |
| `className` (Svelte `class`) | `string` | — | Additional CSS classes |
| `ref` | `HTMLDivElement \| null` | `null` | Bindable reference to the root element |

## Example

No React example is published for this component yet: start from the import above and the props table. The full examples are Svelte-only, on https://fancy-ui.rama.app/docs/components/scroll-progress.md.
