Data display

Note

Keeps supplementary information visually attached to nearby content.

View preview API reference View in Figma

FrameworksAstro · React · Elements

Registry commandlumen add Note

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.

Compatibility

Requires Safari 16.4 or newer.

The React adapter exposes the same prop names.

Tip

Keep supplementary details close to the content they clarify.

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 { Note } from '@santi020k/lumen-astro'
---

<div style="display: grid; gap: 0.75rem; max-width: 28rem;">
  <Note label="Compatibility">Requires Safari 16.4 or newer.</Note>
  <Note borderPosition="right" label="Related">The React adapter exposes the same prop names.</Note>
  <Note borderPosition="none" label="Tip">Keep supplementary details close to the content they clarify.</Note>
</div>

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

export const Example = () => (
  <>
    <div style={{ display: 'grid', gap: '0.75rem', maxWidth: '28rem' }}>
      <Note label="Compatibility">Requires Safari 16.4 or newer.</Note>
      <Note borderPosition="right" label="Related">The React adapter exposes the same prop names.</Note>
      <Note borderPosition="none" label="Tip">Keep supplementary details close to the content they clarify.</Note>
    </div>
  </>
)

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

  defineLumenElements()
</script>

<div style="display: grid; gap: 0.75rem; max-width: 28rem;">
  <lumen-note label="Compatibility">Requires Safari 16.4 or newer.</lumen-note>
  <lumen-note borderPosition="right" label="Related">The React adapter exposes the same prop names.</lumen-note>
  <lumen-note borderPosition="none" label="Tip">Keep supplementary details close to the content they clarify.</lumen-note>
</div>

Edit Note 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 Note

lumen add Note

pnpm add @santi020k/lumen-react

pnpm add @santi020k/lumen-react

lumen add Note --target react

lumen add Note --target react

pnpm add @santi020k/lumen-elements

pnpm add @santi020k/lumen-elements

lumen add Note --target elements

lumen add Note --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
label	string	-	Adds an emphasized label above the note content.
borderPosition	"left" \| "right" \| "none"	"left"	Positions the accent border, or removes it entirely.
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.