@cgboiler/biz-basic 1.0.40 → 1.0.41

package/es/index.d.ts

@@ -5,6 +5,6 @@ declare namespace _default {
 }
 export default _default;
 export function install(app: any): void;
-export const version: "1.0.39";
+export const version: "1.0.40";
 import RichTextEditor from './rich-text-editor';
 export { RichTextEditor };

package/es/index.js

@@ -1,5 +1,5 @@
 import RichTextEditor from "./rich-text-editor";
-const version = "1.0.39";
+const version = "1.0.40";
 function install(app) {
   const components = [
     RichTextEditor

package/es/rich-text-editor/types.d.ts

@@ -1,12 +1,42 @@
+/**
+ * 文件说明：
+ * - 定义富文本编辑器相关的类型声明（Mention/HashTag 数据结构、事件负载等）。
+ * - 新增：`HashTagExitEvent` 用于在 `hashTag-exit` 事件中传递“退出原因（空格/换行等）”与是否为非连续输入。
+ */
 import { ExtractPropTypes } from 'vue';
+/**
+ * MentionData
+ * - 功能：@ 提及的数据结构。
+ * - 字段说明：
+ *   - userId: string 用户唯一标识。
+ *   - name: string 显示名称。
+ */
 export interface MentionData {
     userId: string;
     name: string;
 }
+/**
+ * HashTagData
+ * - 功能：# 标签的数据结构。
+ * - 字段说明：
+ *   - hashTagId: string 标签唯一标识。
+ *   - name: string 标签显示名称。
+ */
 export interface HashTagData {
     hashTagId: string;
     name: string;
 }
+/**
+ * HashTagExitEvent
+ * - 功能：在 `hashTag-exit` 事件中传递退出原因与是否为非连续输入。
+ * - 字段说明：
+ *   - reason: 退出原因；可取值 'space' | 'enter' | 'tab' | 'escape' | 'unknown'。
+ *   - nonContiguous: 是否属于“非连续输入”导致的退出（如空格、回车、Tab）。
+ */
+export interface HashTagExitEvent {
+    reason: 'space' | 'enter' | 'tab' | 'escape' | 'unknown';
+    nonContiguous: boolean;
+}
 export declare const richTextEditorProps: {
     modelValue: {
         type: StringConstructor;

package/es/rich-text-editor/useExtensions.d.ts

@@ -1,2 +1,11 @@
 import { Extension } from '@tiptap/core';
+/**
+ * useExtensions
+ * - 功能：构建并返回 TipTap 编辑器使用的扩展集合。
+ * - 参数说明：
+ *   - props: 组件属性对象，至少应包含占位符 `placeholder` 等。
+ *   - emit: 事件发送函数，用于向父组件触发富文本相关事件（如 hashTag-triggered / hashTag-input / hashTag-exit）。
+ * - 返回值：Extension[] 扩展数组，用于初始化 TipTap 编辑器。
+ * - 异常：无显式抛出；若内部命令执行失败（例如插入内容时）可能由 TipTap 抛出异常，应在上层统一处理。
+ */
 export declare function useExtensions({ props, emit }: any): (import("@tiptap/core").Node<any, any> | import("@tiptap/core").Node<import("@tiptap/extension-mention").MentionOptions<any, import("@tiptap/extension-mention").MentionNodeAttrs>, any> | Extension<import("@tiptap/starter-kit").StarterKitOptions, any> | Extension<any, any> | import("@tiptap/core").Mark<import("@tiptap/extension-text-style").TextStyleOptions, any> | Extension<import("@tiptap/extension-text-style").ColorOptions, any> | Extension<import("tiptap-markdown").MarkdownOptions, import("tiptap-markdown").MarkdownStorage> | import("@tiptap/core").Node<import("@tiptap/extension-image").ImageOptions, any> | Extension<import("@tiptap/extension-table").TableKitOptions, any> | Extension<import("@tiptap/extensions").PlaceholderOptions, any> | Extension<import("@tiptap/extension-list").ListKitOptions, any>)[];

package/es/rich-text-editor/useExtensions.js

@@ -37,10 +37,12 @@ function useExtensions({ props, emit }) {
       render() {
         let activeRange = null;
         let activeEditor = null;
+        let exitCause = "unknown";
         return {
           onStart({ editor, range, command, query }) {
             activeRange = range;
             activeEditor = editor;
+            exitCause = "unknown";
             emit("hashTag-triggered", (data) => {
               try {
                 (activeEditor || editor).chain().focus().deleteRange(activeRange || range).insertContentAt((activeRange || range).from, {
@@ -59,10 +61,41 @@ function useExtensions({ props, emit }) {
             activeEditor = editor || activeEditor;
             emit("hashTag-input", query != null ? query : "");
           },
+          /**
+           * onKeyDown
+           * - 功能：在建议态期间侦测用户键盘行为并记录“非连续输入”的退出原因。
+           * - 参数说明：
+           *   - event: KeyboardEvent 当前键盘事件对象。
+           * - 返回值：boolean 始终返回 false，交由默认逻辑处理（从而触发 onExit）。
+           * - 异常：无。
+           */
+          onKeyDown({ event }) {
+            if (event.key === "Enter") {
+              exitCause = "enter";
+              return false;
+            }
+            if (event.key === " ") {
+              exitCause = "space";
+              return false;
+            }
+            if (event.key === "Tab") {
+              exitCause = "tab";
+              return false;
+            }
+            if (event.key === "Escape") {
+              exitCause = "escape";
+              return false;
+            }
+            return false;
+          },
           onExit() {
             activeRange = null;
             activeEditor = null;
-            emit("hashTag-exit");
+            const payload = {
+              reason: exitCause,
+              nonContiguous: exitCause === "space" || exitCause === "enter" || exitCause === "tab"
+            };
+            emit("hashTag-exit", payload);
           }
         };
       }

package/lib/index.d.ts

@@ -5,6 +5,6 @@ declare namespace _default {
 }
 export default _default;
 export function install(app: any): void;
-export const version: "1.0.39";
+export const version: "1.0.40";
 import RichTextEditor from './rich-text-editor';
 export { RichTextEditor };

package/lib/index.js

@@ -36,7 +36,7 @@ __export(stdin_exports, {
 module.exports = __toCommonJS(stdin_exports);
 var import_rich_text_editor = __toESM(require("./rich-text-editor"));
 __reExport(stdin_exports, require("./rich-text-editor"), module.exports);
-const version = "1.0.39";
+const version = "1.0.40";
 function install(app) {
   const components = [
     import_rich_text_editor.default

package/lib/rich-text-editor/types.d.ts

@@ -1,12 +1,42 @@
+/**
+ * 文件说明：
+ * - 定义富文本编辑器相关的类型声明（Mention/HashTag 数据结构、事件负载等）。
+ * - 新增：`HashTagExitEvent` 用于在 `hashTag-exit` 事件中传递“退出原因（空格/换行等）”与是否为非连续输入。
+ */
 import { ExtractPropTypes } from 'vue';
+/**
+ * MentionData
+ * - 功能：@ 提及的数据结构。
+ * - 字段说明：
+ *   - userId: string 用户唯一标识。
+ *   - name: string 显示名称。
+ */
 export interface MentionData {
     userId: string;
     name: string;
 }
+/**
+ * HashTagData
+ * - 功能：# 标签的数据结构。
+ * - 字段说明：
+ *   - hashTagId: string 标签唯一标识。
+ *   - name: string 标签显示名称。
+ */
 export interface HashTagData {
     hashTagId: string;
     name: string;
 }
+/**
+ * HashTagExitEvent
+ * - 功能：在 `hashTag-exit` 事件中传递退出原因与是否为非连续输入。
+ * - 字段说明：
+ *   - reason: 退出原因；可取值 'space' | 'enter' | 'tab' | 'escape' | 'unknown'。
+ *   - nonContiguous: 是否属于“非连续输入”导致的退出（如空格、回车、Tab）。
+ */
+export interface HashTagExitEvent {
+    reason: 'space' | 'enter' | 'tab' | 'escape' | 'unknown';
+    nonContiguous: boolean;
+}
 export declare const richTextEditorProps: {
     modelValue: {
         type: StringConstructor;

package/lib/rich-text-editor/useExtensions.d.ts

@@ -1,2 +1,11 @@
 import { Extension } from '@tiptap/core';
+/**
+ * useExtensions
+ * - 功能：构建并返回 TipTap 编辑器使用的扩展集合。
+ * - 参数说明：
+ *   - props: 组件属性对象，至少应包含占位符 `placeholder` 等。
+ *   - emit: 事件发送函数，用于向父组件触发富文本相关事件（如 hashTag-triggered / hashTag-input / hashTag-exit）。
+ * - 返回值：Extension[] 扩展数组，用于初始化 TipTap 编辑器。
+ * - 异常：无显式抛出；若内部命令执行失败（例如插入内容时）可能由 TipTap 抛出异常，应在上层统一处理。
+ */
 export declare function useExtensions({ props, emit }: any): (import("@tiptap/core").Node<any, any> | import("@tiptap/core").Node<import("@tiptap/extension-mention").MentionOptions<any, import("@tiptap/extension-mention").MentionNodeAttrs>, any> | Extension<import("@tiptap/starter-kit").StarterKitOptions, any> | Extension<any, any> | import("@tiptap/core").Mark<import("@tiptap/extension-text-style").TextStyleOptions, any> | Extension<import("@tiptap/extension-text-style").ColorOptions, any> | Extension<import("tiptap-markdown").MarkdownOptions, import("tiptap-markdown").MarkdownStorage> | import("@tiptap/core").Node<import("@tiptap/extension-image").ImageOptions, any> | Extension<import("@tiptap/extension-table").TableKitOptions, any> | Extension<import("@tiptap/extensions").PlaceholderOptions, any> | Extension<import("@tiptap/extension-list").ListKitOptions, any>)[];

package/lib/rich-text-editor/useExtensions.js

@@ -69,10 +69,12 @@ function useExtensions({ props, emit }) {
       render() {
         let activeRange = null;
         let activeEditor = null;
+        let exitCause = "unknown";
         return {
           onStart({ editor, range, command, query }) {
             activeRange = range;
             activeEditor = editor;
+            exitCause = "unknown";
             emit("hashTag-triggered", (data) => {
               try {
                 (activeEditor || editor).chain().focus().deleteRange(activeRange || range).insertContentAt((activeRange || range).from, {
@@ -91,10 +93,41 @@ function useExtensions({ props, emit }) {
             activeEditor = editor || activeEditor;
             emit("hashTag-input", query != null ? query : "");
           },
+          /**
+           * onKeyDown
+           * - 功能：在建议态期间侦测用户键盘行为并记录“非连续输入”的退出原因。
+           * - 参数说明：
+           *   - event: KeyboardEvent 当前键盘事件对象。
+           * - 返回值：boolean 始终返回 false，交由默认逻辑处理（从而触发 onExit）。
+           * - 异常：无。
+           */
+          onKeyDown({ event }) {
+            if (event.key === "Enter") {
+              exitCause = "enter";
+              return false;
+            }
+            if (event.key === " ") {
+              exitCause = "space";
+              return false;
+            }
+            if (event.key === "Tab") {
+              exitCause = "tab";
+              return false;
+            }
+            if (event.key === "Escape") {
+              exitCause = "escape";
+              return false;
+            }
+            return false;
+          },
           onExit() {
             activeRange = null;
             activeEditor = null;
-            emit("hashTag-exit");
+            const payload = {
+              reason: exitCause,
+              nonContiguous: exitCause === "space" || exitCause === "enter" || exitCause === "tab"
+            };
+            emit("hashTag-exit", payload);
           }
         };
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cgboiler/biz-basic",
-  "version": "1.0.40",
+  "version": "1.0.41",
   "description": "",
   "main": "lib/index.js",
   "module": "es/index.js",