@next-bricks/vs 1.18.13 → 1.18.14

package/dist/manifest.json

@@ -8,14 +8,17 @@
       "properties": [
         {
           "name": "name",
+          "description": "",
           "type": "string"
         },
         {
           "name": "label",
+          "description": "",
           "type": "string"
         },
         {
           "name": "value",
+          "description": "",
           "type": "string"
         },
         {
@@ -26,20 +29,23 @@
         },
         {
           "name": "theme",
-          "description": "主题，支持 `\"auto\" | \"vs\" | \"vs-dark\"`",
+          "description": "",
           "default": "\"auto\"",
           "type": "string"
         },
         {
           "name": "required",
+          "description": "",
           "type": "boolean"
         },
         {
           "name": "readOnly",
+          "description": "",
           "type": "boolean"
         },
         {
           "name": "automaticLayout",
+          "description": "",
           "type": "\"fit-container\" | \"fit-content\" | \"none\""
         },
         {
@@ -50,23 +56,25 @@
         },
         {
           "name": "completers",
-          "description": "仅对 language 为 brick_next_yaml 有效，设置第一层属性名的自动补全。",
+          "description": "",
           "attribute": false,
           "type": "monaco.languages.CompletionItem[]"
         },
         {
           "name": "advancedCompleters",
-          "description": "高级自动补全配置。\n- 设置为键值对时，仅对 language 为 brick_next_yaml 有效，设置任意的自动补全；\n- 设置为数组时，当前仅对 language 为 cel 有效。\n未来将统一改为数组格式，废弃键值对格式的配置。",
+          "description": "",
           "attribute": false,
           "type": "AdvancedCompleterMap | MixedCompleter[]"
         },
         {
           "name": "markers",
+          "description": "",
           "attribute": false,
           "type": "Marker[]"
         },
         {
           "name": "links",
+          "description": "",
           "attribute": false,
           "type": "string[]"
         },
@@ -78,59 +86,63 @@
         },
         {
           "name": "height",
+          "description": "",
           "attribute": false,
           "type": "string | number"
         },
         {
           "name": "message",
+          "description": "",
           "type": "string"
         },
         {
           "name": "placeholder",
+          "description": "",
           "type": "string"
         },
         {
           "name": "showExpandButton",
-          "description": "是否展示展开按钮",
+          "description": "",
           "type": "boolean"
         },
         {
           "name": "lineNumbers",
-          "description": "行数配置",
+          "description": "",
           "type": "monaco.editor.LineNumbersType"
         },
         {
           "name": "tokenConfig",
-          "description": "自定义高亮配置",
+          "description": "",
           "attribute": false,
           "type": "TokenConfig"
         },
         {
           "name": "customValidationInBrickNextYaml",
-          "description": "在 brick_next_yaml 中是否开启语义相关校验",
+          "description": "",
           "default": "false",
           "type": "boolean"
         },
         {
           "name": "showCopyButton",
-          "description": "是否展示复制按钮",
+          "description": "",
           "default": "true",
           "type": "boolean"
         },
         {
           "name": "glyphMargin",
-          "description": "显示字形边距",
+          "description": "",
           "default": "false",
           "type": "boolean"
         },
         {
           "name": "extraLibs",
-          "description": "额外声明的 lib 库",
+          "description": "",
           "attribute": false,
           "type": "ExtraLib[]"
         },
         {
           "name": "extraMarkers",
+          "description": "",
           "attribute": false,
           "type": "ExtraMarker[]"
         },
@@ -142,42 +154,49 @@
         },
         {
           "name": "spellCheck",
-          "description": "是否启用英语拼写检查",
+          "description": "",
           "default": "true",
           "type": "boolean"
         },
         {
           "name": "knownWords",
-          "description": "启用英语拼写检查时，除系统设置的词汇表外，指定其他的已知单词（小写）。",
+          "description": "",
           "attribute": false,
           "type": "string[]"
         },
         {
           "name": "domLibsEnabled",
-          "description": "是否启用 DOM 相关接口的自动提示。",
+          "description": "",
           "type": "boolean"
         },
         {
           "name": "uri",
+          "description": "",
           "type": "string"
         }
       ],
       "events": [
         {
           "name": "code.change",
+          "description": "",
           "detail": {
+            "description": "`string` — 当前编辑器的完整代码文本",
             "type": "string"
           }
         },
         {
           "name": "user.input",
+          "description": "",
           "detail": {
+            "description": "`any` — 用户输入的内容",
             "type": "any"
           }
         },
         {
           "name": "token.click",
+          "description": "",
           "detail": {
+            "description": "`string` — 被点击的 token 文本（如 `CTX`、`FN` 等命名空间关键字）",
             "type": "string"
           }
         }
@@ -185,7 +204,7 @@
       "slots": [],
       "methods": [],
       "parts": [],
-      "description": "构件代码编辑器",
+      "description": "",
       "category": "form-input-advanced"
     }
   ],

package/dist-types/code-editor/index.d.ts

@@ -52,102 +52,151 @@ export interface Marker {
 export type TokenConfig = {
     showDSKey?: boolean;
 };
+export interface CodeEditorEventsMap {
+    "code.change": CustomEvent<string>;
+    "user.input": CustomEvent<any>;
+    "token.click": CustomEvent<string>;
+}
+export interface CodeEditorEventsMapping {
+    onCodeChange: "code.change";
+    onUserInput: "user.input";
+    onTokenClick: "token.click";
+}
 /**
- * 构件代码编辑器
+ * @description 基于 Monaco Editor 的代码编辑器构件，支持多种编程语言（typescript、yaml、brick_next_yaml、cel 等）的语法高亮与自动补全，支持作为表单项使用，支持自动布局、拼写检查、Lint 校验、标记高亮等高级功能。
  * @category form-input-advanced
  */
 export declare class CodeEditor extends FormItemElementBase implements CodeEditorProps {
     #private;
+    /**
+     * @description 表单字段名，用于在表单提交时标识该字段。
+     */
     accessor name: string | undefined;
+    /**
+     * @description 表单字段标签，显示在编辑器上方作为说明文字。
+     */
     accessor label: string | undefined;
+    /**
+     * @description 编辑器的当前值（代码文本内容）。
+     */
     accessor value: string | undefined;
     /**
+     * @description 编辑器的编程语言，决定语法高亮和自动补全行为，支持 `typescript`、`javascript`、`yaml`、`brick_next_yaml`、`cel`、`cel_yaml`、`cel_str` 等。
      * @default "plaintext"
      */
     accessor language: string | undefined;
     /**
-     * 主题，支持 `"auto" | "vs" | "vs-dark"`
-     *
+     * @description 编辑器主题，`auto` 跟随系统主题自动切换，`vs` 为亮色，`vs-dark` 为暗色。
      * @default "auto"
      * @group ui
      */
     accessor theme: string | undefined;
+    /**
+     * @description 是否为表单必填项，启用后表单提交时会校验该字段不能为空。
+     */
     accessor required: boolean | undefined;
+    /**
+     * @description 是否为只读模式，启用后用户无法编辑代码内容。
+     */
     accessor readOnly: boolean | undefined;
+    /**
+     * @description 自动布局模式：`fit-content` 根据内容高度自动调整编辑器高度（由 `minLines`/`maxLines` 控制范围），`fit-container` 自动填满父容器尺寸，`none` 不自动调整。
+     */
     accessor automaticLayout: "fit-container" | "fit-content" | "none" | undefined;
     /**
+     * @description 编辑器最小行数，与 `automaticLayout: "fit-content"` 配合使用，控制编辑器的最小显示高度。
      * @default 3
      */
     accessor minLines: number | undefined;
     /**
-     * 仅对 language 为 brick_next_yaml 有效，设置第一层属性名的自动补全。
+     * @description 仅对 language 为 brick_next_yaml 有效，设置第一层属性名的自动补全。
      */
     accessor completers: monaco.languages.CompletionItem[] | undefined;
     /**
-     * 高级自动补全配置。
-     * - 设置为键值对时，仅对 language 为 brick_next_yaml 有效，设置任意的自动补全；
-     * - 设置为数组时，当前仅对 language 为 cel 有效。
-     * 未来将统一改为数组格式，废弃键值对格式的配置。
+     * @description 高级自动补全配置。设置为键值对时仅对 language 为 brick_next_yaml 有效，设置任意路径的自动补全；设置为数组时当前仅对 language 为 cel 等系列语言有效。未来将统一改为数组格式，废弃键值对格式。
      */
     accessor advancedCompleters: AdvancedCompleterMap | MixedCompleter[] | undefined;
+    /**
+     * @description 标记配置，用于在编辑器中对指定 token 进行高亮标注，并可关联错误/警告级别与提示信息，仅对 language 为 brick_next_yaml 有效。
+     */
     accessor markers: Marker[] | undefined;
+    /**
+     * @description 可点击链接的命名空间列表，在 language 为 brick_next_yaml 时，按住 Ctrl/Cmd 点击这些关键字可触发 `token.click` 事件。
+     */
     accessor links: string[] | undefined;
     /**
+     * @description 编辑器最大行数，与 `automaticLayout: "fit-content"` 配合使用，控制编辑器的最大显示高度（超出后出现滚动条）。
      * @default Infinity
      */
     accessor maxLines: number | undefined;
+    /**
+     * @description 固定高度（像素或 CSS 字符串），当 `automaticLayout` 不为 `fit-content` 时生效。
+     */
     accessor height: string | number | undefined;
+    /**
+     * @description 表单字段自定义校验提示信息。
+     */
     accessor message: string | undefined;
+    /**
+     * @description 编辑器为空时显示的占位提示文字。
+     */
     accessor placeholder: string | undefined;
     /**
-     * 是否展示展开按钮
+     * @description 是否展示展开/收起按钮，点击后编辑器全屏展开，按 Esc 键收起。
      */
     accessor showExpandButton: boolean | undefined;
     /**
-     * 行数配置
+     * @description 行号显示模式，`on` 显示行号，`off` 隐藏行号，也可传入函数自定义行号格式。
      */
     accessor lineNumbers: monaco.editor.LineNumbersType | undefined;
     /**
-     * 自定义高亮配置
+     * @description 自定义高亮配置，目前支持 `showDSKey` 选项，在 brick_next_yaml 中控制是否对 DS（数据源）相关的 key 进行高亮显示。
      */
     accessor tokenConfig: TokenConfig | undefined;
     /**
-     * 在 brick_next_yaml 中是否开启语义相关校验
+     * @description 在 brick_next_yaml 中是否开启嵌入 JavaScript 的语义相关校验（TypeScript 类型检查）。
      * @default false
      */
     accessor customValidationInBrickNextYaml: boolean | undefined;
     /**
-     * 是否展示复制按钮
+     * @description 是否展示复制按钮，点击后将编辑器内容复制到剪贴板。
      * @default true
      */
     accessor showCopyButton: boolean | undefined;
     /**
-     * 显示字形边距
+     * @description 是否显示字形边距（Glyph Margin），启用后在行号左侧留出额外空间，可用于显示调试断点等装饰器。
      * @default false
      */
     accessor glyphMargin: boolean | undefined;
     /**
-     * 额外声明的 lib 库
+     * @description 额外声明的 TypeScript/JavaScript lib 库，用于在 javascript/typescript/brick_next_yaml 中提供自定义类型声明和自动补全提示。
      */
     accessor extraLibs: ExtraLib[] | undefined;
+    /**
+     * @description 额外的编辑器标记（Marker），可在指定位置显示错误/警告/信息级别的诊断提示，与 `markers` 不同，支持通过行列坐标精确定位。
+     */
     accessor extraMarkers: ExtraMarker[] | undefined;
     /**
+     * @description 是否将编辑器的悬浮提示（如自动补全下拉框、悬停文档等）渲染到 body 层，避免被父容器 overflow 裁剪。
      * @default true
      */
     accessor fixedOverflowWidgets: boolean | undefined;
     /**
-     * 是否启用英语拼写检查
+     * @description 是否启用英语拼写检查，启用后会对代码中的英文单词进行拼写校验并标注错误。
      * @default true
      */
     accessor spellCheck: boolean | undefined;
     /**
-     * 启用英语拼写检查时，除系统设置的词汇表外，指定其他的已知单词（小写）。
+     * @description 启用拼写检查时，在系统词汇表之外额外指定的已知单词列表（全小写），这些单词不会被标记为拼写错误。
      */
     accessor knownWords: string[] | undefined;
     /**
-     * 是否启用 DOM 相关接口的自动提示。
+     * @description 是否启用 DOM 相关接口的 TypeScript 自动提示（lib: ["dom"]），启用后在 javascript/typescript 中可获得浏览器 DOM API 的类型声明。
      */
     accessor domLibsEnabled: boolean | undefined;
+    /**
+     * @description 编辑器模型的 URI 标识符，用于区分同一语言下的不同编辑器实例，影响 TypeScript/JavaScript 语言服务的作用域隔离。
+     */
     accessor uri: string | undefined;
     connectedCallback(): void;
     render(): React.JSX.Element;