kyle-editor 1.0.4 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/api.md ADDED
@@ -0,0 +1,365 @@
1
+ # API 参考
2
+
3
+ ## 一、创建实例
4
+
5
+ ```js
6
+ import { KEditor } from 'kyle-editor'
7
+
8
+ const editor = new KEditor('#editor', { /* options */ })
9
+ // 或
10
+ const editor = KEditor.create(el, options) // el: 选择器 / HTMLElement / Vue ref.$el
11
+ ```
12
+
13
+ ---
14
+
15
+ ## 二、配置项 options
16
+
17
+ | 配置 | 类型 | 默认值 | 说明 |
18
+ |------|------|--------|------|
19
+ | `value` | `string` | `''` | 初始 HTML;留空时取挂载节点的 `innerHTML` |
20
+ | `placeholder` | `string` | `'开始撰写内容…'` | 空内容占位文案 |
21
+ | `height` | `number` | `460` | 编辑区可视高度(px),`0` 为自适应内容高度 |
22
+ | `minHeight` | `number` | `320` | 纸张最小高度 |
23
+ | `paperWidth` | `number` | `677` | 版心基准宽度(与公众号一致);`fluid` 模式下它是最小宽度 |
24
+ | `paperMode` | `'fluid' \| 'fixed'` | `'fluid'` | 宽屏时版心随容器生长(两侧留白恒定)/ 恒定 `paperWidth + 64` |
25
+ | `paperGap` | `number` | `24` | `fluid` 模式下单侧留白(px) |
26
+ | `paperMaxWidth` | `number` | `0` | `fluid` 模式下版心最大宽度,`0` = 不限 |
27
+ | `primaryColor` | `string` | `'#07c160'` | 主题色(CSS 变量 `--ke-primary`) |
28
+ | `toolbar` | `string[] \| false` | `DEFAULT_TOOLBAR` | 工具栏项,见下表;`false` 隐藏 |
29
+ | `customButtons` | `CustomButtonSpec[]` | `[]` | 自定义工具栏按钮(下拉选择 + 跳转链接),见下文 |
30
+ | `hideToolbar` | `boolean` | `false` | 隐藏工具栏 |
31
+ | `hideStatusbar` | `boolean` | `false` | 隐藏底部状态栏 |
32
+ | `readOnly` | `boolean` | `false` | 只读 |
33
+ | `autofocus` | `boolean` | `false` | 创建后自动聚焦 |
34
+ | `maxLength` | `number` | `0` | 超出后提示(软限制,不截断输入) |
35
+ | `wordCount` | `boolean` | `true` | 底部字数/媒体统计 |
36
+ | `sanitize` | `boolean` | `true` | 初始化与 `setContent` 时净化 HTML |
37
+ | `historyLimit` | `number` | `60` | 撤销栈深度 |
38
+ | `uploader` | `'mock' \| object \| fn \| ChunkUploader` | `'mock'` | 上传适配器,见 [upload-adapter.md](upload-adapter.md) |
39
+ | `upload` | `object` | `{chunkSize:1MB, concurrency:3, retries:2, fingerprint:'fast'}` | 分片参数 |
40
+ | `image.compress` | `object\|false` | `{maxWidth:1440, quality:0.85, minSize:300KB}` | 上传前大图压缩 |
41
+ | `maxImageSize` | `number` | `20MB` | 图片体积上限,超限拦截 |
42
+ | `maxVideoSize` | `number` | `512MB` | 视频体积上限 |
43
+ | `imageAccept` / `videoAccept` | `string` | 常见图/视频类型 | 文件选择器 `accept` |
44
+ | `paste.enabled` | `boolean` | `true` | 接管粘贴 |
45
+ | `paste.clean` | `boolean` | `true` | 粘贴内容净化(Word/WPS 自动清洗) |
46
+ | `paste.uploadFiles` | `boolean` | `true` | 粘贴截图/文件即上传 |
47
+ | `paste.localizeImages` | `boolean` | `false` | 尝试把外链图片下载后本地化 |
48
+
49
+ ### 工具栏项
50
+
51
+ `undo` `redo` `heading` `fontsize` `bold` `italic` `underline` `strike` `foreColor` `backColor`
52
+ `alignLeft` `alignCenter` `alignRight` `alignJustify` `ul` `ol` `quote` `link` `image` `video`
53
+ `table` `code` `hr` `clear` `source` `preview` `fullscreen`;分隔符 `'|'`,右对齐标记 `':tail'`。
54
+
55
+ > `preview` **不在默认工具栏里**(默认尾栏只有「源码 / 全屏」),需要时手动写回 `toolbar`,或直接调 `editor.openPreview()`。
56
+
57
+ 此外可放入 `customButtons` 里定义的**按钮 `name`**(如 `toolbar: ['bold', '|', 'tpl']`)。
58
+ **未传 `toolbar` 时,自定义按钮会自动插入工具栏**:写了 `position` 按 `position` 放,没写则追加到主区末尾(插在 `:tail` 之前)。
59
+
60
+ ```js
61
+ toolbar: ['undo', 'redo', '|', 'bold', 'italic', '|', 'image', 'video', ':tail', 'source']
62
+ ```
63
+
64
+ 工具栏始终单行显示,放不下时可**左右滑动**,并有四重提示保证可发现性:
65
+
66
+ | 提示 | 作用 |
67
+ | --- | --- |
68
+ | 常显滚动条 | 静止时也能从滑块长度看出「还有更多工具」 |
69
+ | 尾部左缘渐隐 + 阴影 | 明确表达「有工具正藏在这块底下」,滑到最右自动消失 |
70
+ | 左缘渐隐 | 已向右滑出时提示左边还有内容 |
71
+ | 首次引导气泡 | 「工具栏可左右滑动」,3.8s 后或首次滑动后消失,`localStorage` 记忆不重复弹 |
72
+
73
+ 鼠标还可**直接按住拖动**平移工具栏(光标变为抓握状);触屏沿用系统原生滑动。`:tail` 之后的「源码 / 全屏」(以及 `position:'tail'` 的自定义按钮)始终吸附在右端可见。
74
+
75
+ #### 下拉面板一览
76
+
77
+ | 按钮 | 点击行为 | 面板内容 |
78
+ |------|----------|----------|
79
+ | `heading` | 展开「段落样式」面板 | 正文 / 标题一 / 标题二 / 标题三,每档给出**真实字号预览 + 用途说明**(如「标题一 · 大标题 · 22px 加粗,全文主标题(建议只用一次)」),按钮文案跟随当前段落 |
80
+ | `fontsize` | 展开「字号」面板 | 12–32px 网格,当前字号高亮 |
81
+ | `foreColor` | **一次点击直接展开颜色面板** | 最近使用(本次会话)+ 主题颜色 + 标准颜色,色块带中文名称 tooltip,底部为取色器 + HEX 输入 + 应用;右上角「恢复默认」清除上色 |
82
+ | `backColor` | 同上(底色) | 推荐底色 + 主题颜色 + 自定义;按钮上的「A」用当前底色做高亮示意 |
83
+ | `image` / `video` | 展开插入面板 | 两个页签:**本地上传**(点击或拖拽到虚线区)/ **网络链接**(粘贴地址即可插入,附带可访问性校验提示) |
84
+ | `table` | 展开网格 | 10×8 规格选择,实时显示「N 列 × M 行」 |
85
+ | `link` | 展开表单 | 文字 / 地址 / 新窗口打开,已链接时提供「移除链接」 |
86
+
87
+ 面板统一样式:圆角卡片 + 标题栏 + 分区小标题 + 入场动画;打开时会自动记录正文选区,操作后还原,因此**先选文字再点颜色**一定生效。
88
+
89
+ #### 图片缩放
90
+
91
+ 点击正文中的图片会浮出气泡工具条(对齐 / 宽度 30%·60%·100% / 圆角 / 查看大图 / 替换 / 删除),同时图片**右下角出现圆形拖拽把手**:
92
+
93
+ - 按住把手左右拖动,实时按**容器宽度百分比**等比缩放,顶部浮层显示当前宽度(如 `58%`)
94
+ - 范围限制 15%–100%,不会拖出正文版心;松开即写入撤销栈,可 `⌘/Ctrl+Z` 回退
95
+ - 把手与浮层挂在编辑器容器上,**不进入内容区**,不会污染 `getHTML()` 导出与历史快照
96
+ - 视频卡片不支持拖拽缩放(保持固定比例),可用气泡工具条的「窄版 / 宽版」切换
97
+
98
+ #### 图片对齐
99
+
100
+ 选中图片后,**工具栏的「左对齐 / 居中 / 右对齐」与气泡工具条的对齐按钮效果完全一致**——都作用于图片本身(`img` 为块级元素,靠 `margin:auto` 定位),而非所在段落:
101
+
102
+ - 图片宽度为 100% 时居中无视觉差异,**先缩小(拖拽把手或宽度按钮)再居中**即可看到图片在正文中水平居中
103
+ - 对齐写入撤销栈,可 `⌘/Ctrl+Z` 回退;工具栏对齐按钮会随选中图片的对齐状态高亮
104
+
105
+ #### 快捷键
106
+
107
+ | 快捷键 | 作用 |
108
+ |--------|------|
109
+ | `⌘/Ctrl + B / I / U` | 加粗 / 斜体 / 下划线 |
110
+ | `⌘/Ctrl + K` | 插入链接 |
111
+ | `⌘/Ctrl + Shift + K` | 切换 HTML 源码模式 |
112
+ | `⌘/Ctrl + Z` / `Shift + Z` / `Y` | 撤销 / 重做 |
113
+ | `⌘/Ctrl + S` | 触发 `save` 事件 |
114
+ | `Esc` | 关闭面板 / 退出预览 |
115
+
116
+ ### 自定义工具栏按钮
117
+
118
+ 一个 `customButtons` 条目 = 一个工具栏按钮。`type: 'select'`(默认,下拉选择)或 `type: 'button'`(普通按钮)。
119
+
120
+ #### CustomButtonSpec
121
+
122
+ | 字段 | 类型 | 默认 | 说明 |
123
+ |------|------|------|------|
124
+ | `name` | `string` | — | **必填**,唯一标识;在 `toolbar` 数组里用它定位,也是事件载荷的 `name` |
125
+ | `position` | `number \| 'start' \| 'end' \| 'tail' \| string \| {before} \| {after}` | `'end'` | 按钮在工具栏中的位置,见下表(别名:`at` / `before` / `after` / `index`) |
126
+ | `type` | `'select' \| 'button'` | `'select'` | 下拉选择 / 普通按钮 |
127
+ | `title` | `string` | `text` | 按钮 tooltip,同时作为面板标题 |
128
+ | `text` | `string` | `''` | 按钮文字;下拉按钮选中后会换成选项文字 |
129
+ | `placeholder` | `string` | `text` | 未选中时的按钮文字 |
130
+ | `icon` | `string` | `''` | 内置图标名(`link`/`image`/`plus`…)或原始 SVG 字符串 |
131
+ | `width` | `number` | 自适应 | 面板宽度 px(限定 200–420) |
132
+ | `searchable` | `boolean` | `false` | 面板内搜索框(对 label/desc/value/group 客户端过滤) |
133
+ | `note` | `string` | `''` | 面板右上角说明文字(未搜索时显示) |
134
+ | `emptyText` | `string` | `'暂无数据'` | 空数据提示 |
135
+ | `cache` | `boolean` | `true` | 缓存接口结果;面板右上角刷新按钮可强制重拉 |
136
+ | `keepValue` | `boolean` | `true` | 记住选中项并回显到按钮文字 |
137
+ | `options` | `Option[]` | — | **数据源①** 静态配置 |
138
+ | `load` | `(editor) => Option[] \| Promise` | — | **数据源②** 自定义函数(优先级最高) |
139
+ | `url` | `string` | — | **数据源③** 接口地址,内部 `fetch` |
140
+ | `fetchOptions` | `object` | `{}` | `{method, headers, body, credentials, timeout, fetch, parser}`;`timeout` 默认 10000ms |
141
+ | `pick` | `(payload, editor) => any[]` | 自动 | 从响应里提取数组 |
142
+ | `link` | `\|` | — | 跳转链接配置,见下表 |
143
+ | `insert` | `'auto' \| 'link' \| 'html' \| 'text' \| false` | `'auto'` | 插入方式;`auto` = 链接 > `item.html` > 纯文本;`false` 不改正文 |
144
+ | `onSelect` | `(item, ctx) => any` | — | 选中回调;**返回 `false` 则跳过默认插入** |
145
+ | `onClick` | `({editor, name}) => any` | — | `type:'button'` 的点击回调 |
146
+ | `active` / `enabled` | `(state, editor) => boolean` | — | 按钮高亮 / 可用条件 |
147
+
148
+ **数据源优先级:`load` > `url` > `options`**。同时配置多项时只生效优先级最高的那个。
149
+
150
+ #### 按钮位置 `position`
151
+
152
+ | 写法 | 效果 |
153
+ |------|------|
154
+ | 不写 / `'end'` | 主区末尾,插在右侧吸附尾栏之前(多个未定位按钮共用一个分隔符) |
155
+ | `'start'` | 工具栏第一位 |
156
+ | `'tail'` | 尾栏末尾(与「源码 / 全屏」同区;未启用 `:tail` 时回退主区末尾) |
157
+ | `number` | 第 n 个按钮之前(0 起,按视觉顺序,分隔符不计数) |
158
+ | `'image'` 等按钮名 | 插到该按钮之前 |
159
+ | `{ before: name }` / `{ after: name }` | 显式锚点;锚点可以是内置按钮,也可以是另一个自定义按钮 |
160
+
161
+ 规则:
162
+ - 锚点找不到 → 自动回退主区末尾,不报错、不丢按钮。
163
+ - `toolbar` 数组里已写过该 `name` → 以数组位置为准(`position` 忽略);数组里没写的自定义按钮会按 `position` 自动补位。
164
+ - 显式定位不插入额外分隔符;仅默认追加时会带一个 `\|`。
165
+ - 运行时可用 `editor.moveButton(name, where)` 移动**任意**按钮(包括内置按钮)。
166
+
167
+ #### 选项对象
168
+
169
+ 字段自动归一,接口原始结构一般无需转换:
170
+
171
+ | 字段 | 别名(自动识别) | 说明 |
172
+ |------|------|------|
173
+ | `value` | `id` `key` `val` `code` | 唯一值,用于占位符与 `setButtonValue` |
174
+ | `label` | `text` `name` `title` | 主标题 |
175
+ | `desc` | `description` `sub` `subtitle` `tip` | 副标题说明 |
176
+ | `url` | `href` `link` `jumpUrl` `jump` | 该项自带地址(`link: true` 时使用) |
177
+ | `group` | — | 分组名,同组归到一个小标题下 |
178
+ | `html` | — | 选中后直接插入的 HTML(`insert: 'html'`) |
179
+ | `disabled` | — | 置灰不可选 |
180
+
181
+ 也支持纯字符串数组:`options: ['开场白', '结束语']`。
182
+
183
+ #### link 写法
184
+
185
+ | 写法 | 效果 |
186
+ |------|------|
187
+ | `link: true` | 用每项自带地址(`url`/`href` 字段) |
188
+ | `link: 'https://x.com/{value}'` | 地址模板 |
189
+ | `link: { url, text, target, mode, title }` | 完整配置 |
190
+ | `link: (item, editor) => ({ url, text, target })` | 完全动态 |
191
+
192
+ - `mode: 'insert'`(默认)在光标处插入 `<a>`;`target: '_blank'`(默认)时自动加 `rel="noopener noreferrer"`
193
+ - `mode: 'open'` 直接 `window.open(url, '_blank', 'noopener,noreferrer')`,不改动正文
194
+ - 模板占位符 `{value}` `{label}` 以及选项的**任意字段**都会被替换(取自原始对象)
195
+ - **安全**:地址经白名单校验,`javascript:` / `vbscript:` / `file:` / 危险 `data:` 一律不生成链接(退化为插入纯文本)
196
+
197
+ #### onSelect 的 ctx
198
+
199
+ ```js
200
+ onSelect: (item, ctx) => {
201
+ ctx.editor // 编辑器实例
202
+ ctx.item // 选中项(归一后)
203
+ ctx.link // 解析后的链接,无链接时为 null
204
+ ctx.insertLink(override) // 插入链接(可覆盖字段)
205
+ ctx.insertHtml(html) // 插入 HTML
206
+ ctx.insertText(text) // 插入纯文本
207
+ ctx.open(url, target) // 新窗口打开
208
+ return false // 已自行处理,跳过默认插入
209
+ }
210
+ ```
211
+
212
+ #### 实例方法
213
+
214
+ ```ts
215
+ editor.addButton(spec, { at? }) // 运行时新增;位置同 position(at / before / after / index),返回按钮 DOM
216
+ editor.moveButton(name, where) // 移动任意按钮(含内置),where 同 position 写法
217
+ editor.removeButton(name) // 移除并中断未完成的接口请求(随行分隔符一并清掉)
218
+ editor.setButtonOptions(name, items) // 外部灌入数据(成为权威数据,不被旧请求覆盖)
219
+ editor.getButtonValue(name) // 当前选中项
220
+ editor.setButtonValue(name, value)// 设置选中项,按钮文案同步
221
+ editor.toolbar.openCustom(name) // 代码打开面板
222
+ editor.toolbar.buttonNodes() // 当前工具栏按钮节点(按视觉顺序,不含分隔符)
223
+
224
+ editor.setPaper({ width, mode, gap, maxWidth }) // 运行时改版心
225
+ editor.paperOptions() // 读当前版心配置
226
+ ```
227
+
228
+ #### 示例
229
+
230
+ ```js
231
+ KEditor.create('#editor', {
232
+ customButtons: [
233
+ { name: 'column', text: '栏目', searchable: true, url: '/api/columns', link: true, insert: 'link' },
234
+ {
235
+ name: 'tpl', text: '模板', icon: 'plus',
236
+ options: [{ value: 'opening', label: '开场白', desc: '问候 + 导读', group: '通用' }],
237
+ link: { url: 'https://mp.weixin.qq.com/s/tpl-{value}', text: '【{label}】' },
238
+ onSelect: (item) => track('tpl', item.value),
239
+ },
240
+ { name: 'date', type: 'button', text: '日期', onClick: ({ editor }) => editor.commands.insertHTML('<p>2026-10-13</p>') },
241
+ ],
242
+ })
243
+ ```
244
+
245
+ ### 回调
246
+
247
+ | 回调 | 签名 | 说明 |
248
+ |------|------|------|
249
+ | `onChange(html, editor)` | | 内容变化(160ms 防抖) |
250
+ | `onReady(editor)` | | 实例可用 |
251
+ | `onError(error)` | | 内部异常 |
252
+ | `onUpload({stage, file, kind, url, percent, info})` | | `uploadstart/uploaddone/uploaderror/uploadcancel` |
253
+ | `beforeUpload(file, kind)` | 返回 `File` 改写、`false` 拦截 | 上传前钩子(加水印、二次校验等) |
254
+ ---
255
+
256
+ ## 三、实例属性与方法
257
+
258
+ ```ts
259
+ editor.id // 实例 id
260
+ editor.el // 最外层容器
261
+ editor.root // contenteditable 节点
262
+ editor.options // 合并后的配置
263
+ editor.commands // 指令集(可程序化调用)
264
+ editor.media // 上传/媒体管理
265
+ editor.uploader // ChunkUploader 实例
266
+ editor.history // 撤销栈
267
+ editor.readOnly / sourceMode / previewMode / fullscreen
268
+ ```
269
+
270
+ | 方法 | 说明 |
271
+ |------|------|
272
+ | `getHTML({clean?})` | 取当前 HTML,默认剔除编辑器内部属性、未完成占位块 |
273
+ | `getText()` | 纯文本 |
274
+ | `getJSON()` | `{html, text, counts}` |
275
+ | `setContent(html, {sanitize?, silent?})` | 覆盖内容 |
276
+ | `appendHTML(html)` | 在光标处插入 |
277
+ | `clear()` | 清空并取消所有上传 |
278
+ | `focus()` / `blur()` | 聚焦/失焦 |
279
+ | `setReadOnly(bool)` | 切换只读 |
280
+ | `undo()` / `redo()` | 撤销/重做(含光标位置恢复) |
281
+ | `insertImage(url, alt?)` / `insertVideo(url, label?)` | 按地址插入媒体(等同工具栏「网络链接」页签) |
282
+ | `upload(file, kind?)` | 手动触发一次上传(自动判断图片/视频) |
283
+ | `cancelUploads()` | 取消全部进行中任务 |
284
+ | `counts()` | `{chars, words, images, videos, uploading}` |
285
+ | `enterSource()` / `exitSource()` / `toggleSource()` | 源码模式 |
286
+ | `openPreview()` / `closePreview()` / `togglePreview()` | 预览模式(默认工具栏已无预览按钮,走 API 或自行配置 `toolbar`) |
287
+ | `toggleFullscreen()` | 全屏编辑 |
288
+ | `addButton(spec, place?)` / `moveButton(name, where)` / `removeButton(name)` | 工具栏按钮增 / 移 / 删(详见自定义工具栏按钮) |
289
+ | `setPaper({width?, mode?, gap?, maxWidth?})` / `paperOptions()` | 运行时改版心(宽屏留白策略) |
290
+ | `on(type, fn)` / `off(type, fn)` | 事件订阅,返回取消函数 |
291
+ | `destroy()` | 卸载实例、清理监听与临时 URL |
292
+
293
+ ### 事件
294
+
295
+ | 事件 | 载荷 | 触发时机 |
296
+ |------|------|----------|
297
+ | `ready` | `{editor}` | 实例挂载完成 |
298
+ | `change` | `{html, text}` | 内容变化 |
299
+ | `focus` / `blur` | | 编辑区聚焦/失焦 |
300
+ | `save` | `{html}` | ⌘/Ctrl + S |
301
+ | `uploadstart` | `{file, kind}` | 开始上传 |
302
+ | `uploaddone` | `{file, kind, url}` | 上传完成 |
303
+ | `uploaderror` | `{file, kind, error}` | 失败(已重试后) |
304
+ | `uploadcancel` | `{file, kind}` | 取消 |
305
+ | `insertmedia` | `{kind, url, node}` | 通过「网络链接」页签插入图片/视频 |
306
+ | `sourcechange` | `{mode: 'source'\|'visual'}` | 源码模式切换 |
307
+ | `customselect` | `{name, item, link, action, editor}` | 自定义下拉按钮选中一项;`action` 为 `'link'\|'html'\|'text'\|'open'\|'none'` |
308
+ | `customclick` | `{name, editor}` | `type:'button'` 自定义按钮被点击 |
309
+ | `error` | `{type, error, message}` | 内部异常(如自定义按钮 `onSelect` 抛错),同时走 `onError` |
310
+
311
+ ---
312
+
313
+ ## 四、指令集 commands
314
+
315
+ ```js
316
+ editor.commands.toggleMark('bold' | 'italic' | 'underline' | 'strike')
317
+ editor.commands.setFontSize(18)
318
+ editor.commands.setColor('fore' | 'back', '#07c160') // color=null 恢复默认
319
+ editor.commands.setAlign('left' | 'center' | 'right' | 'justify')
320
+ editor.commands.toggleList('ordered' | 'unordered')
321
+ editor.commands.setHeading('p' | 'h1' | 'h2' | 'h3')
322
+ editor.commands.toggleBlockquote()
323
+ editor.commands.createLink({ url, text, target })
324
+ editor.commands.removeLink()
325
+ editor.commands.insertTable(3, 2) // 列, 行
326
+ editor.commands.insertCodeBlock('const a = 1')
327
+ editor.commands.insertDivider()
328
+ editor.commands.insertHTML('<p>富文本片段</p>')
329
+ editor.commands.clearFormat()
330
+ editor.getState() // 当前选区状态(工具栏高亮用)
331
+ ```
332
+
333
+ ## 五、独立可用的工具函数
334
+
335
+ ```js
336
+ import { sanitizeHtml, formatHtml, escapeHtml, isSafeUrl, cleanWordHtml, mockAdapter, httpAdapter, simpleAdapter, ChunkUploader } from 'kyle-editor'
337
+
338
+ sanitizeHtml(dirtyHtml) // 白名单净化,返回安全 HTML
339
+ formatHtml(html) // 缩进美化(编辑器源码模式同款)
340
+ cleanWordHtml(wordHtml) // 粘贴前的 Word/WPS 清洗
341
+ isSafeUrl('javascript:1') // => false
342
+ ```
343
+
344
+ UMD / 默认导出上也挂了一批静态成员,`<script>` 引入时直接可用:
345
+
346
+ ```js
347
+ KEditor.version // '1.0.0'
348
+ KEditor.sanitizeHtml(html) // 白名单净化
349
+ KEditor.formatHtml(html) // 源码美化
350
+ KEditor.cleanWordHtml(html) // Word 清洗
351
+ KEditor.mockAdapter({speed}) // 内置分片模拟适配器
352
+ KEditor.httpAdapter(config) // 真实后端适配器
353
+ KEditor.simpleAdapter(fn) // 单次直传适配器
354
+ KEditor.chunkUploader(file, adapter, opts) // 分片调度器
355
+ KEditor.utils // { uid, escapeHtml }
356
+ KEditor.create(el, options) // 工厂方法,等价于 new KEditor(...)
357
+ KEditor.plugin // Vue 3 插件(仅 keditor-vue.umd.js)
358
+ ```
359
+
360
+ > TypeScript:包内自带 `types/index.d.ts` 与 `types/vue.d.ts`,`import KEditor from 'kyle-editor'` 即有完整提示,无需额外安装。
361
+
362
+ ## 六、安全说明
363
+
364
+ - 所有进入编辑器的外部 HTML(`value`、`setContent`、粘贴)都会经过 `sanitizeHtml`:标签/属性双白名单、`on*` 事件属性剔除、`javascript:`/`vbscript:`/`file:`/非法 `data:` 协议拦截、`style` 声明逐条过滤(丢弃 `expression`、`behavior` 等)。
365
+ - `getHTML({clean: false})` 会返回含编辑器内部属性的原始 HTML,请仅在调试时使用;入库前建议再跑一次 `sanitizeHtml`。
package/docs/index.md ADDED
@@ -0,0 +1,8 @@
1
+ /**
2
+ * 集成文档索引
3
+ * - [README.md](../README.md) — 快速开始
4
+ * - [integration.md](integration.md) — 三种集成方式(script / ESM / Vue3)
5
+ * - [api.md](api.md) — 配置项、实例方法、事件
6
+ * - [upload-adapter.md](upload-adapter.md) — 分片上传协议与后端接口约定
7
+ */
8
+ export default ['README.md', 'integration.md', 'api.md', 'upload-adapter.md']