Anchor
Links to sections within a long page and exposes the page’s local structure.
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.
Introduction
Anchor links keep long-form content easy to scan.
Usage
Choose labels that describe the destination section.
View Anchor 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 { Anchor } from '@santi020k/lumen-astro'
---
<Anchor
items={[
{ depth: 2, href: '#section-1', label: 'Introduction' },
{ depth: 3, href: '#section-2', label: 'Usage' }
]}
/>
<div class="anchor-example-content">
<section id="section-1">
<h2>Introduction</h2>
<p>Anchor links keep long-form content easy to scan.</p>
</section>
<section id="section-2">
<h3>Usage</h3>
<p>Choose labels that describe the destination section.</p>
</section>
</div>import { Anchor } from '@santi020k/lumen-react'
export const Example = () => (
<>
<Anchor
items={[
{ depth: 2, href: '#section-1', label: 'Introduction' },
{ depth: 3, href: '#section-2', label: 'Usage' }
]}
/>
<div className="anchor-example-content">
<section id="section-1">
<h2>Introduction</h2>
<p>Anchor links keep long-form content easy to scan.</p>
</section>
<section id="section-2">
<h3>Usage</h3>
<p>Choose labels that describe the destination section.</p>
</section>
</div>
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-anchor
items={[
{ depth: 2, href: '#section-1', label: 'Introduction' },
{ depth: 3, href: '#section-2', label: 'Usage' }
]}></lumen-anchor>
<div class="anchor-example-content">
<section id="section-1">
<h2>Introduction</h2>
<p>Anchor links keep long-form content easy to scan.</p>
</section>
<section id="section-2">
<h3>Usage</h3>
<p>Choose labels that describe the destination section.</p>
</section>
</div>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 Anchorlumen add Anchorpnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add Anchor --target reactlumen add Anchor --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add Anchor --target elementslumen add Anchor --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 |
|---|---|---|---|
| items | Array<{ href, label, depth?, index?, description? }> | [] | Defines compact or rich in-page navigation items with optional hierarchy and supporting content. |
| activationOffset | number | 96 | Sets the viewport-top offset in pixels used to activate sections during scrolling. |
| 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. |