Layout
Affix
Keeps important controls visible after their original position scrolls out of view.
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 Affix 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 { Affix, Button } from '@santi020k/lumen-astro'
---
<Affix offset={64}>
<Button>Sticky Button</Button>
</Affix>import { Affix, Button } from '@santi020k/lumen-react'
export const Example = () => (
<>
<Affix offset={64}>
<Button>Sticky Button</Button>
</Affix>
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-affix offset="64">
<lumen-button>Sticky Button</lumen-button>
</lumen-affix>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-astroScroll horizontally to read more
lumen add AffixScroll horizontally to read more
pnpm add @santi020k/lumen-reactScroll horizontally to read more
lumen add Affix --target reactScroll horizontally to read more
pnpm add @santi020k/lumen-elementsScroll horizontally to read more
lumen add Affix --target elementsScroll horizontally to read more
API 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.
Scroll horizontally to compare
| Attribute | Values | Default | Description |
|---|---|---|---|
| position | "top" | "bottom" | "top" | Selects the viewport edge used for sticky positioning. |
| offset, offsetTop, offsetBottom | number | 0 | Sets the sticky inset in pixels; edge-specific values override offset. |
| 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. |