121
GitHub
Data display

Icon

Renders Lucide icons with Lumen sizing and accessibility defaults.

FrameworksAstro · React · Elements

Registry commandlumen add Icon

InteractionNative markup

01

See it in context

Preview

02

Copy a working example

Usage

astro
---
import {
  Button,
  Icon,
  Input,
  InputGroup
} from '@santi020k/lumen-astro'
---

<InputGroup>
  <Icon name="search" decorative />
  <Input aria-label="Search docs" placeholder="Search docs" />
</InputGroup>

<Button variant="secondary">
  <Icon name="wand-sparkles" decorative />
  Generate
</Button>

<Icon name="circle-check" label="Synced" size="lg" />
---
import {
  Button,
  Icon,
  Input,
  InputGroup
} from '@santi020k/lumen-astro'
---

<InputGroup>
  <Icon name="search" decorative />
  <Input aria-label="Search docs" placeholder="Search docs" />
</InputGroup>

<Button variant="secondary">
  <Icon name="wand-sparkles" decorative />
  Generate
</Button>

<Icon name="circle-check" label="Synced" size="lg" />
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.

bash@santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
pnpm add @santi020k/lumen-astro
bashAstro wrapper
lumen add Icon
lumen add Icon

API 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.

AttributeValuesDefaultDescription
namestring-Renders any Lucide icon by name, including kebab-case names and Lucide aliases.
labelstring-Adds an accessible name and exposes the icon as an image.
decorativebooleantrue when unlabelledKeeps decorative icons hidden from assistive technology.
size"default" | "sm" | "lg" | "xl""default"Controls the icon box size.
class, classNamestring""Merges custom classes with the generated ui-* root classes.
...native attributesHTML attributes-Forwards standard attributes to the root element unless the component consumes them.