Documentation
Data display
Note
Keeps supplementary information visually attached to nearby content.
01
See it in context
Preview
Compatibility
Requires Safari 16.4 or newer.
Related
The React adapter exposes the same prop names.
Tip
Keep supplementary details close to the content they clarify.
02
Copy a working example
Usage
---
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-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>
</>
)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><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>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.
pnpm add @santi020k/lumen-astropnpm add @santi020k/lumen-astrolumen add Notelumen add Notepnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add Note --target reactlumen add Note --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add Note --target elementslumen add Note --target elementsAPI 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. |