Forms

Mentions

Captures multi-line text with suggestions triggered by @ mentions.

View preview API reference Figma behavior note

FrameworksAstro · React · Elements

Registry commandlumen add Mentions

InteractionNative markup

Design sourceBehavior-only contract

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.

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

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

lumen add Mentions

pnpm add @santi020k/lumen-react

pnpm add @santi020k/lumen-react

lumen add Mentions --target react

lumen add Mentions --target react

pnpm add @santi020k/lumen-elements

pnpm add @santi020k/lumen-elements

lumen add Mentions --target elements

lumen add Mentions --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
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.