FORGE KUI / docs

嵌入代码编辑器

kui_ext_editor 提供独立的代码编辑器元素。

版本 3.61.7

接入方式

kui_ext_editor 提供独立的代码编辑器元素。集成时先部署扩展和依赖,再配置尺寸、文本、语言、主题与焦点。扩展与宿主分别遵循所选 SDK 包的编译与部署要求。

约束和排错

SDK 文档涉及选区、多光标、查找替换、语法高亮、LSP、Git 标记、snippet 与 ghost text。逐项查注册方法和参数,再选择实际应用所需部分。语言服务、Git 和补全数据由宿主按协议提供,不能把编辑器组件当作已经配置好的 IDE。

代码编辑与语法树

SDK 编辑器示例显示 TypeScript 文本、语法高亮和 tree-sitter 语法树。编辑器支持的文本语言与 KUI 宿主的脚本运行时分别配置。

KUI SDK 编辑器示例的实际画面

页面声明与配置

加载 kui_ext_editor 后,在页面中创建 kui-editor 并给出尺寸。language 和 theme 控制语言与主题,value 提供初始内容;data-language、data-theme 也有对应处理。

html
<kui-editor language="cpp" theme="mocha"
  style="width:100%;height:480px"
  value="int main() { return 0; }"></kui-editor>

编辑与工具能力

当前方法注册表包含光标与选择、多光标、撤销重做、查找替换、折叠和 gutter 装饰等入口。补全、LSP、Git 和建议文本需要应用侧的数据或服务,元素本身不会自动连接业务系统。

语法与部署

高亮效果取决于扩展构建、语言注册与语法依赖。部署后使用实际语言文件检查高亮、输入法、选择、滚动和字体。SDK 文档中的旧方法数量不用于当前能力计数,以现有方法注册表为准。

把编辑器接进业务

按下面的顺序验证一个最小场景,再接入完整应用。

  1. 先加载包内编辑器例子,确认扩展与资源完整。
  2. 分别测试初始文本、编辑后的读取、未保存提示和显式保存。
  3. 文件编码、换行和路径由宿主统一处理,不把编辑器文本当作已经写盘。
  4. 用短文件、长行、中文输入和错误诊断检查你的实际使用场景。

文档有误或遗漏?

反馈此页问题 →