Data display

Badge

Labels status, type, plan, or count information.

View preview API reference View in Figma

FrameworksAstro · React · Elements

Registry commandlumen add Badge

InteractionNative markup

Design sourceLinked component node

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.

Pro planAstroBetaDeployedReview neededBuild failed

Framework usage

Switch targets to compare the adapter code. The preview stays visually stable because all three packages share the same tokens and ui-* class contract.

---
import { Badge } from '@santi020k/lumen-astro'
---

<div style="display: flex; gap: 0.5rem; flex-wrap: wrap; align-items: center;">
  <Badge>Pro plan</Badge>
  <Badge variant="secondary">Astro</Badge>
  <Badge variant="outline">Beta</Badge>
  <Badge variant="success">Deployed</Badge>
  <Badge variant="warning">Review needed</Badge>
  <Badge variant="destructive">Build failed</Badge>
</div>

import { Badge } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <div style={{ display: 'flex', gap: '0.5rem', flexWrap: 'wrap', alignItems: 'center' }}>
      <Badge>Pro plan</Badge>
      <Badge variant="secondary">Astro</Badge>
      <Badge variant="outline">Beta</Badge>
      <Badge variant="success">Deployed</Badge>
      <Badge variant="warning">Review needed</Badge>
      <Badge variant="destructive">Build failed</Badge>
    </div>
  </>
)

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<div style="display: flex; gap: 0.5rem; flex-wrap: wrap; align-items: center;">
  <lumen-badge>Pro plan</lumen-badge>
  <lumen-badge variant="secondary">Astro</lumen-badge>
  <lumen-badge variant="outline">Beta</lumen-badge>
  <lumen-badge variant="success">Deployed</lumen-badge>
  <lumen-badge variant="warning">Review needed</lumen-badge>
  <lumen-badge variant="destructive">Build failed</lumen-badge>
</div>

Edit Badge in browser

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-astro

pnpm add @santi020k/lumen-astro

lumen add Badge

lumen add Badge

pnpm add @santi020k/lumen-react

pnpm add @santi020k/lumen-react

lumen add Badge --target react

lumen add Badge --target react

pnpm add @santi020k/lumen-elements

pnpm add @santi020k/lumen-elements

lumen add Badge --target elements

lumen add Badge --target elements

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.

Attribute	Values	Default	Description
variant	"default" \| "secondary" \| "outline" \| "destructive" \| "success" \| "warning"	"default"	Controls the badge tone.
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.