Core UI
Back to Top Button
Floating button that fades in past a scroll threshold and scrolls to top, instantly under reduced motion.
$ velocityx add back-to-top
Built for react.
Needs react already installed
as a peer dependency.
An Astro-only project needs @astrojs/react wired up first — this won't run on its own in plain Astro.
Full docs for Back to Top Button →
Needs a licence key —
subscribe here, then
velocityx loginonce.
Props
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| threshold | number px scrolled before showing, | No | 480 |
File this creates
The CLI writes this path into your project, relative to its root — nothing else moves.
components/velocity/back-to-top/BackToTop.jsxUsing the Back to Top Button component
Install it with velocityx add back-to-top.
The CLI writes the source straight into your project — no runtime dependency, no registry
lock-in, and it themes itself from the same primary-*/accent-* scale as the rest of the library.
Related components
More from Core UI.
Expand/collapse FAQ list with measured-height animation, single or multi-open modes, and arrow-key navigation between headers.
reactBottom consent bar with accept-all, reject-all, and an inline expandable preferences checklist, persisted to localStorage.
reactScrollable data table with a sticky header row and client-side column sorting that cycles ascending, descending, and unsorted.
reactSticky header that crossfades from transparent to a blurred solid bar after a scroll threshold, with primary links and a CTA.
react