Documentation
01
See it in context
Preview
02
Copy a working example
Usage
Astro examples assume UIPrimitives is mounted once in your root layout. Do not add the runtime next to each component instance.
---
import { BackToTop } from '@santi020k/lumen-astro'
---
<BackToTop aria-label="Back to top">↑ Top</BackToTop>---
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>
</>
)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><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>03
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. React props follow the same names; Elements use equivalent kebab-case attributes where custom elements expose them.
| 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. |