@tensor_1/react 2.39.0 → 2.40.1

package/dist/rich-text.d.cts

@@ -2,8 +2,19 @@ import * as react from 'react';
 import { ReactNode } from 'react';
 import { E as EmojiPickerLabels, a as EmojiLocale } from './emoji-image-DjCKpdwE.cjs';
 export { l as emojiImageFileName } from './emoji-image-DjCKpdwE.cjs';
+export { M as MENTION_SCHEME, f as findMentions, e as formatMention, i as isMentionId, r as readMention } from './markdown-model-Cuwi6pIk.cjs';
 import './overlay-position-2Afke51l.cjs';
 
+/** A person the consumer offers in the `@` listbox. */
+interface MentionCandidate {
+    /** Stored in the text; letters, digits and `_ . -` only (see `isMentionId`). */
+    id: string;
+    /** The name inserted and shown. */
+    label: string;
+    /** A second line in the listbox (e.g. team or e-mail), never stored. */
+    description?: string;
+}
+
 type RichTextFeatures = 'full' | 'comment' | 'template';
 type RichTextHeadingLevel = 1 | 2 | 3;
 /** Every visible and accessible string of the editor. Placeholders are filled by the editor. */
@@ -43,6 +54,14 @@ interface RichTextLabels {
     emoji: string;
     /** Accessible name of the `:shortcode` suggestion list. */
     emojiSuggestions: string;
+    /** Accessible name of the `@` people list. */
+    mentionSuggestions: string;
+    /** Shown while `onMentionSearch` has not answered. */
+    mentionSearching: string;
+    /** Shown when `onMentionSearch` found nobody. */
+    mentionEmpty: string;
+    /** Shown when `onMentionSearch` failed. */
+    mentionFailed: string;
     undo: string;
     redo: string;
     /** Toggle to markdown source. */
@@ -85,6 +104,13 @@ interface RichTextEditorProps {
     onSubmitShortcut?: () => void;
     /** Emoji button and `:shortcode` suggestions. Default `true`. */
     emoji?: boolean;
+    /**
+     * People for the `@` list: called with the text typed after `@` (possibly empty) and
+     * answering the candidates to offer. The product owns the query and who may be
+     * mentioned; UIx never fetches. A picked person is inserted as one token, stored as
+     * `@[Name](mention:<id>)`. Without it, typing `@` does nothing special.
+     */
+    onMentionSearch?: (query: string) => Promise<ReadonlyArray<MentionCandidate>> | ReadonlyArray<MentionCandidate>;
     /**
      * Same-origin folder of fallback emoji PNGs for devices without a colour emoji font
      * (e.g. `/static/emoji`). Emoji the device cannot draw show as
@@ -153,4 +179,4 @@ interface RoundTripOptions {
  */
 declare function roundTripMarkdown(markdown: string, options?: RoundTripOptions): Promise<string>;
 
-export { DEFAULT_RICH_TEXT_LABELS, EmojiLocale, EmojiPickerLabels, RichTextEditor, RichTextEditorFallback, type RichTextEditorProps, type RichTextFeatures, type RichTextHeadingLevel, type RichTextLabels, type RoundTripOptions, roundTripMarkdown };
+export { DEFAULT_RICH_TEXT_LABELS, EmojiLocale, EmojiPickerLabels, type MentionCandidate, RichTextEditor, RichTextEditorFallback, type RichTextEditorProps, type RichTextFeatures, type RichTextHeadingLevel, type RichTextLabels, type RoundTripOptions, roundTripMarkdown };

package/dist/rich-text.d.ts

@@ -3,6 +3,9 @@ export { RoundTripOptions, roundTripMarkdown } from './rich-text/round-trip.js';
 export { EmojiLocale } from './emoji-model.js';
 export { EmojiPickerLabels } from './components/EmojiPicker.js';
 export { emojiImageFileName } from './emoji-image.js';
+export { MentionCandidate } from './rich-text/mention.js';
+export { MENTION_SCHEME, findMentions, formatMention, isMentionId, readMention } from './markdown-model.js';
 import 'react';
 import '@tiptap/extension-emoji';
 import './overlay-position.js';
+import '@tiptap/core';

package/dist/rich-text.js

@@ -1,10 +1,16 @@
 import { RichTextEditor, RichTextEditorFallback, DEFAULT_RICH_TEXT_LABELS } from "./components/RichTextEditor.js";
 import { roundTripMarkdown } from "./rich-text/round-trip.js";
 import { emojiImageFileName } from "./emoji-image.js";
+import { findMentions, formatMention, readMention, isMentionId, MENTION_SCHEME } from "./markdown-model.js";
 export {
   DEFAULT_RICH_TEXT_LABELS,
+  MENTION_SCHEME,
   RichTextEditor,
   RichTextEditorFallback,
   emojiImageFileName,
+  findMentions,
+  formatMention,
+  isMentionId,
+  readMention,
   roundTripMarkdown
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tensor_1/react",
-  "version": "2.39.0",
+  "version": "2.40.1",
   "description": "Thin React wrappers over the UIx v2 CSS component library.",
   "license": "UNLICENSED",
   "type": "module",