Forms
Mentions
Captures multi-line text with suggestions triggered by @ mentions.
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.
View Mentions 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 { Mentions } from '@santi020k/lumen-astro'
---
<Mentions label="Comment" placeholder="@mention someone" options={['alice', 'bob', 'carol']} />import { Mentions } from '@santi020k/lumen-react'
export const Example = () => (
<>
<Mentions label="Comment" placeholder="@mention someone" options={['alice', 'bob', 'carol']} />
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-mentions label="Comment" placeholder="@mention someone" options={['alice', 'bob', 'carol']}></lumen-mentions>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 Mentionslumen add Mentionspnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add Mentions --target reactlumen add Mentions --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add Mentions --target elementslumen add Mentions --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 |
|---|---|---|---|
| options | Array<string | { label, value }> | [] | Defines the mention suggestions. |
| trigger | string | "@" | Sets the character that opens suggestions. |
| name, placeholder | string | - | Sets the native textarea field name and hint. |
| label | string | "Mentions" | Provides the textarea accessible name. |
| 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. |