Scroll To Top
A back-to-top button that appears once you've scrolled, with a ring that fills as you read down. Works on the page or any scrolling container.
- Category: React Navigation Components
- Licence: Charcoal UI Pro
- Built with: React 19, Tailwind CSS 4, Motion
- Dependencies: motion, clsx, tailwind-merge
Examples
Scroll To Top
API reference
| Prop | Type | Default | Description |
|---|---|---|---|
container | RefObject<HTMLElement> | — | Defaults to the page. |
threshold | number | 240 | Px before it shows. |
className | string | — |
About Scroll To Top
Scroll To Top appears once you have scrolled down, with a ring that fills as you read. Clicking it glides back to the top. It works on the page or inside any scrolling container.
Scroll To Top is a navigation component for React 19, styled with Tailwind CSS 4 and animated with Motion. It drops into Next.js, Vite, Remix or Astro through the shadcn CLI as a single file you own.
When to use Scroll To Top
- Long articles and docs.
- Product listings and feeds.
- Changelogs and release notes.
- Scrolling panels in apps.
How it works
Motion's useScroll tracks the page or the container you pass, and the ring is an SVG circle driven by the progress. Reduced motion jumps to the top instead of gliding.
Links and buttons keep their roles, arrow keys move where a group is expected, the current item is marked with aria-current, and focus is always visible. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.
Customizing Scroll To Top
Every prop is documented in the API reference above with its type and default. The ones you will reach for first are listed here.
The Customize panel next to the preview lets you change threshold live, and the Code tab updates to match, so the snippet you copy already carries your values.
- container (RefObject<HTMLElement>): Defaults to the page.
- threshold (number, default 240): Px before it shows.
Goes well with Scroll To Top
These navigation pieces share its tokens and motion language, so they sit together on one page without clashing.
- Dock: A macOS-style React dock whose icons swell with pointer distance and show labels
- Expandable Tabs: Compact React icon tabs where the active tab expands to reveal its label
- Floating Nav: A floating React pill nav that hides on scroll down and returns on scroll up
- Context Menu: A React right-click context menu that opens at the pointer and stays on screen
- Bottom Nav: An animated React mobile tab bar with a sliding pill, hopping icons and badges
Install Scroll To Top
npx shadcn@latest add @charcoal/scroll-to-topScroll To Top is part of Charcoal UI Pro. One seat unlocks all 393 Pro components, 112 landing-page sections and 100 full templates, for every personal and client project, with updates included. Add the @charcoal registry once with your access token, then the command above copies scroll-to-top.tsx into components/ui and installs clsx, tailwind-merge.
You own the file you install: no runtime package, no lock-in, nothing to keep in sync. Change it however your product needs.
See Charcoal UI Pro pricing · Pro setup
Frequently asked questions
- How do I install Scroll To Top?
- Scroll To Top is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/scroll-to-top. It copies scroll-to-top.tsx into components/ui and installs motion, clsx, tailwind-merge.
- Is Scroll To Top free for commercial use?
- Scroll To Top needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.
- Does Scroll To Top work with Next.js?
- Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.
- Can an AI coding agent install Scroll To Top?
- Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Scroll To Top's props and get_install_command returns the exact command.