Data display
Icon
Renders Lucide icons with Lumen sizing and accessibility defaults.
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.
Project workspace
Quick actionsDecorative icons inherit nearby labelsStandalone icons provide an accessible label
View Icon 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 {
Button,
Icon,
Input,
InputGroup
} from '@santi020k/lumen-astro'
---
<div data-icon-preview>
<div data-icon-preview-header>
<div data-icon-preview-mark aria-hidden="true">
<Icon name="panels-top-left" decorative size="lg" />
</div>
<div>
<p>Project workspace</p>
<strong>Quick actions</strong>
</div>
<span data-icon-preview-status>
<Icon name="circle-check" decorative />
Synced
</span>
</div>
<div data-icon-preview-toolbar>
<InputGroup>
<Icon name="search" decorative />
<Input aria-label="Search documentation" placeholder="Search documentation..." />
</InputGroup>
<Button>
<Icon name="wand-sparkles" decorative />
Generate
</Button>
<Button aria-label="Open settings" size="icon" variant="outline">
<Icon name="settings-2" decorative />
</Button>
</div>
<div data-icon-preview-legend aria-label="Icon accessibility examples">
<span>
<Icon name="info" decorative />
Decorative icons inherit nearby labels
</span>
<span>
<Icon name="bell" aria-label="Notifications" />
Standalone icons provide an accessible label
</span>
</div>
</div>import {
Button,
Icon,
Input,
InputGroup
} from '@santi020k/lumen-react'
export const Example = () => (
<>
<div data-icon-preview>
<div data-icon-preview-header>
<div data-icon-preview-mark aria-hidden="true">
<Icon name="panels-top-left" decorative size="lg" />
</div>
<div>
<p>Project workspace</p>
<strong>Quick actions</strong>
</div>
<span data-icon-preview-status>
<Icon name="circle-check" decorative />
Synced
</span>
</div>
<div data-icon-preview-toolbar>
<InputGroup>
<Icon name="search" decorative />
<Input aria-label="Search documentation" placeholder="Search documentation..." />
</InputGroup>
<Button>
<Icon name="wand-sparkles" decorative />
Generate
</Button>
<Button aria-label="Open settings" size="icon" variant="outline">
<Icon name="settings-2" decorative />
</Button>
</div>
<div data-icon-preview-legend aria-label="Icon accessibility examples">
<span>
<Icon name="info" decorative />
Decorative icons inherit nearby labels
</span>
<span>
<Icon name="bell" aria-label="Notifications" />
Standalone icons provide an accessible label
</span>
</div>
</div>
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<div data-icon-preview>
<div data-icon-preview-header>
<div data-icon-preview-mark aria-hidden="true">
<lumen-icon name="panels-top-left" decorative size="lg"></lumen-icon>
</div>
<div>
<p>Project workspace</p>
<strong>Quick actions</strong>
</div>
<span data-icon-preview-status>
<lumen-icon name="circle-check" decorative></lumen-icon>
Synced
</span>
</div>
<div data-icon-preview-toolbar>
<lumen-input-group>
<lumen-icon name="search" decorative></lumen-icon>
<lumen-input aria-label="Search documentation" placeholder="Search documentation..."></lumen-input>
</lumen-input-group>
<lumen-button>
<lumen-icon name="wand-sparkles" decorative></lumen-icon>
Generate
</lumen-button>
<lumen-button aria-label="Open settings" size="icon" variant="outline">
<lumen-icon name="settings-2" decorative></lumen-icon>
</lumen-button>
</div>
<div data-icon-preview-legend aria-label="Icon accessibility examples">
<span>
<lumen-icon name="info" decorative></lumen-icon>
Decorative icons inherit nearby labels
</span>
<span>
<lumen-icon name="bell" aria-label="Notifications"></lumen-icon>
Standalone icons provide an accessible label
</span>
</div>
</div>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 Iconlumen add Iconpnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add Icon --target reactlumen add Icon --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add Icon --target elementslumen add Icon --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 |
|---|---|---|---|
| name | string | - | Renders any Lucide icon by name, including kebab-case names and Lucide aliases. |
| label | string | - | Adds an accessible name and exposes the icon as an image. |
| decorative | boolean | true when unlabelled | Keeps decorative icons hidden from assistive technology. |
| size | "default" | "sm" | "lg" | "xl" | "default" | Controls the icon box size. |
| 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. |