Type @ to mention someone!
',\n});\n```\n\nType `@` to open the dropdown, navigate with arrow keys, press `Enter` to insert, and\n`Escape` to dismiss.\n`items` may also return a `Promise`, so suggestions can come from a remote API; pair\nthat with `debounce` on the trigger to rate-limit calls.\n\n> The inserted `span.mention`, the underline on the `@query` range still being typed,\n> and the default dropdown (the `dm-mention-suggestion` classes) are all styled by\n> `@domternal/theme` (`_mention.scss`). Import the theme, or supply your own `render`\n> factory if you want fully custom markup.\n\n## Commands and storage\n\nThe extension registers two chainable commands:\n\n```ts\n// Insert a mention at the current selection\neditor.commands.insertMention({ id: '1', label: 'Alice', type: 'user' });\n\n// Delete by id, or the mention immediately before the cursor when no id is passed\neditor.commands.deleteMention('1');\neditor.commands.deleteMention();\n```\n\nIt also exposes `editor.storage.mention.findMentions()`, which returns every mention\nin the document as `{ id, label, type, pos }`.\n\n## Multiple triggers\n\nPass a `triggers` array to mix, for example, `@` users and `#` tags. Each trigger has\nits own `name`, `items` source, and renderer:\n\n```ts\nMention.configure({\n triggers: [\n { char: '@', name: 'user', items: fetchUsers, render: createMentionSuggestionRenderer() },\n { char: '#', name: 'tag', items: fetchTags, render: createMentionSuggestionRenderer() },\n ],\n});\n```\n\n## Options\n\nPer-trigger options are `char`, `name`, `items`, `render`, `minQueryLength`,\n`allowSpaces`, `appendText` (default `' '`), `invalidNodes`, `debounce`,\n`decorationClass`, `decorationTag`, and `shouldShow`. Extension-level options, set\nalongside `suggestion` or `triggers`, are `deleteTriggerWithBackspace` (Backspace on a\nmention removes the trigger char with it, default `false`), `renderHTML`, `renderText`,\nand `HTMLAttributes`.\n\nFor a custom picker, drive the headless plugin directly with\n`createMentionSuggestionPlugin` and close it with\n`dismissMentionSuggestion(view, triggerName)`. For full details and framework wrapper\nexamples, see the [documentation](https://domternal.dev/v1/nodes/mention).\n\n## Localization\n\nThis package exports `mentionMessages` for typed custom catalogs. Optional German UI\nmessages are available from `@domternal/extension-mention/locales/de` as `deMessages` and\n`deSearchAliases`. Merge them with the core and other enabled feature catalogs. Missing\nentries fall back to English. Provider-supplied names and labels remain unchanged.\n","readmeFilename":"README.md"}