Ballmac UI home

Back To Top

A floating button that appears after scrolling, draws a progress ring, scrolls smoothly (instantly under reduced motion) and moves focus to the content.

Release notes

Scroll down to reveal the button. The ring fills as you read.

  • Version 1.14

    Fixes, polish and small improvements across the app.

  • Version 1.13

    Fixes, polish and small improvements across the app.

  • Version 1.12

    Fixes, polish and small improvements across the app.

  • Version 1.11

    Fixes, polish and small improvements across the app.

  • Version 1.10

    Fixes, polish and small improvements across the app.

  • Version 1.9

    Fixes, polish and small improvements across the app.

  • Version 1.8

    Fixes, polish and small improvements across the app.

  • Version 1.7

    Fixes, polish and small improvements across the app.

  • Version 1.6

    Fixes, polish and small improvements across the app.

  • Version 1.5

    Fixes, polish and small improvements across the app.

  • Version 1.4

    Fixes, polish and small improvements across the app.

  • Version 1.3

    Fixes, polish and small improvements across the app.

  • Version 1.2

    Fixes, polish and small improvements across the app.

  • Version 1.1

    Fixes, polish and small improvements across the app.

Installation

$ pnpm dlx shadcn@latest add @ballmac/back-to-top

Usage

import { BackToTop } from "@/components/ballmac/back-to-top"

The full example is in the Code tab above.

Examples

Labelled

Scroll to show the labelled version, line 1.

Scroll to show the labelled version, line 2.

Scroll to show the labelled version, line 3.

Scroll to show the labelled version, line 4.

Scroll to show the labelled version, line 5.

Scroll to show the labelled version, line 6.

Scroll to show the labelled version, line 7.

Scroll to show the labelled version, line 8.

Scroll to show the labelled version, line 9.

Scroll to show the labelled version, line 10.

Scroll to show the labelled version, line 11.

Scroll to show the labelled version, line 12.

API reference

PropTypeDefault
threshold

Scroll distance in pixels after which the button appears.

number320
container

A scrollable element to watch and scroll instead of the page.

React.RefObject<HTMLElement | null>—
showProgress

Draw a ring around the button that fills with scroll progress.

booleantrue
focusTarget

CSS selector of the element that receives focus after scrolling. Defaults to `main`, then the page.

string—
label

Button text, used as the accessible name.

string—
showLabel

Show the label next to the arrow.

booleanfalse

Also accepts the standard attributes of its root element.

Accessibility

KeyAction
Enter / SpaceScrolls to the top and moves focus to the main content so focus is not lost when the button disappears
Reduced motionJumps instead of scrolling smoothly

Quality scorecard

7/7

Every applicable check passes

Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 2 examples.

How we measure
  • Passed: Accessibility scan

    No serious or critical issues in light and dark, on a phone and a desktop (axe-core 4.13.0, WCAG 2.1 AA and best-practice rules).

  • Passed: Small screens

    No sideways scrolling at 360, 390 or 1280 px wide.

  • Passed: Reduced motion

    No endless animation to begin with.

  • Passed: Right to left

    Mirrors correctly in Arabic, Hebrew, Persian and Urdu layouts (0% of elements off the mirror, limit 15%).

  • Passed: Clean console

    No console errors or React hydration errors while loading.

  • Passed: Keyboard

    2 tab stops, each showing a visible change when it takes focus. 2 documented keys.

  • Not applicable: Loading, empty and error

    Does not show data or take submissions.

  • Passed: Automated tests

    Covered by back-to-top.test.tsx.

  • For information: Footprint

    1.8 KB of source (gzip) in 1 file. Installs lucide-react, motion.

Automated checks find a subset of problems and do not replace testing with a screen reader and a keyboard in your own app. What they miss.

Use with AI

Render <BackToTop /> once. threshold sets when it appears; container follows a scrollable element; focusTarget chooses where focus lands. With the shadcn MCP server set up (guide), ask your agent:

Add the Ballmac UI Back To Top (@ballmac/back-to-top) to this project with the shadcn MCP, then use it where it fits.

Use it for

  • Long pages, feeds and docs
  • Panels with a lot of scrolling

Not for

  • Short pages
  • Infinite feeds where returning to the top loses work

Registry JSON: https://ui.ballmac.com/r/back-to-top.json

Credits

Free to use in personal and commercial projects.

Ballmac UI Pro

Need the whole screen, not one piece?

311 premium blocks (dashboards, settings, calendars, mail, shops, onboarding), a private shadcn registry and Figma tokens. Blocks that show data come with loading, empty and error states built in.

Not ready? Try three Pro blocks free

Leave your email and the blocks appear right here, ready to copy. Yours to use in any project.