@layers-app/editor 2.2.12 → 2.2.14

package/dist/index.d.ts

@@ -85,7 +85,7 @@ export { deleteNode }
 
 export { Dropzone }
 
-export declare const Editor: <USER_DATA extends object, CHILD_PAGE extends PageData>({ initialContent, onChange, outputFormat, mode, maxHeight, onBlur, onFocus, fetchUploadMedia, fileChunkUploadApi, isOfficePreviewAvailable, onPreviewOffice, fetchPromptResult, fetchSmartPastePrompt, fetchSmartPasteStreamPrompt, fetchDeleteMedia, fetchRestoreMedia, pageId, commentController, maxFileSize, contentModalUploadImage, maxImageSizeError, debounce: debounceMs, disable, ws, excludeNodes, imagePickerSettings, childPages, linkablePages, language, shiftEnterInsertNewLine, editorRef, placeholder, plugins, onTrack, onCopySuccess, onCopyError, }: EditorProps<USER_DATA, CHILD_PAGE>) => JSX_2.Element;
+export declare const Editor: <USER_DATA extends object, CHILD_PAGE extends PageData>({ initialContent, onChange, outputFormat, mode, maxHeight, onBlur, onFocus, fetchUploadMedia, fileChunkUploadApi, isOfficePreviewAvailable, onPreviewOffice, fetchPromptResult, fetchSmartPastePrompt, fetchSmartPasteStreamPrompt, fetchDeleteMedia, fetchRestoreMedia, pageId, commentController, maxFileSize, contentModalUploadImage, maxImageSizeError, debounce: debounceMs, disable, ws, excludeNodes, imagePickerSettings, childPages, linkablePages, language, shiftEnterInsertNewLine, editorRef, placeholder, plugins, onTrack, onCopySuccess, onCopyError, mentionSearch, onMentionsChange, getMentionUserInfo, }: EditorProps<USER_DATA, CHILD_PAGE>) => JSX_2.Element;
 
 declare interface EditorProps<USER_DATA extends object = object, PAGE_DATA extends PageData = PageData> {
     initialContent: Root | string;
@@ -129,6 +129,9 @@ declare interface EditorProps<USER_DATA extends object = object, PAGE_DATA exten
     onTrack?: EditorTrackFn;
     onCopySuccess?: (message: string) => void;
     onCopyError?: (message: string) => void;
+    mentionSearch?: MentionSearchFn;
+    onMentionsChange?: (mentions: MentionRef[]) => void;
+    getMentionUserInfo?: MentionUserInfoFn;
 }
 
 declare type EditorTrackFn = (event: string, params?: Record<string, unknown>) => void;
@@ -229,6 +232,31 @@ declare type ImagePickerSettings = {
     galleryCollection?: ImagePickerGalleryCollection[];
 };
 
+export declare type MentionRef = {
+    userId: string;
+    name: string;
+    anchorId?: string;
+    preview?: string;
+};
+
+export declare type MentionSearchFn = (trigger: string, query: string) => Promise<MentionUser[]>;
+
+export declare type MentionUser = {
+    value: string;
+    id: string;
+    avatarUrl?: string;
+};
+
+export declare type MentionUserInfoFn = (userId: string) => MentionUserPreview | Promise<MentionUserPreview | null> | null;
+
+export declare type MentionUserPreview = {
+    id: string;
+    name: string;
+    avatarUrl?: string;
+    roleLabel?: string;
+    isYou?: boolean;
+};
+
 declare type Mode = 'comment' | 'default' | 'editor';
 
 export { NodeKey }