01
See it and copy it
Framework example
Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.
View BackToTop code
Framework usage
Switch targets to compare the adapter code. This live preview runs the Astro example. React and Elements use their own behavior APIs; complete the matching framework setup before copying an example.---
import { BackToTop } from '@santi020k/lumen-astro'
---
<BackToTop aria-label="Back to top">↑ Top</BackToTop>import { BackToTop } from '@santi020k/lumen-react'
export const Example = () => (
<>
<BackToTop aria-label="Back to top">↑ Top</BackToTop>
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-back-to-top aria-label="Back to top">↑ Top</lumen-back-to-top>02
Choose your target
Add this component
Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.
pnpm add @santi020k/lumen-astropnpm add @santi020k/lumen-astrolumen add BackToToplumen add BackToToppnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add BackToTop --target reactlumen add BackToTop --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add BackToTop --target elementslumen add BackToTop --target elementsAPI reference
Lumen-specific props and runtime attributes for the Astro primitive. Use the framework differences above and the copyable examples for React composition and Elements attributes; the public adapter types define their supported contracts.
| Attribute | Values | Default | Description |
|---|---|---|---|
| type | "button" | "submit" | "reset" | "button" | Sets the native button type. |
| data-ui-back-to-top | boolean attribute | generated | Marks the button for scroll-to-top behavior from the UIPrimitives runtime. |
| class, className | string | "" | Merges custom classes with the generated ui-* root classes. |
| ...native attributes | HTML attributes | - | Forwards standard attributes to the root element unless the component consumes them. |