@zhenryx/react-editor 0.1.4 → 0.1.5
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/README.md +215 -200
- package/dist/index.cjs +10 -8
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +12 -4
- package/dist/index.d.mts +12 -4
- package/dist/index.mjs +10 -8
- package/dist/index.mjs.map +1 -1
- package/package.json +62 -62
package/README.md
CHANGED
|
@@ -1,200 +1,215 @@
|
|
|
1
|
-
# @zhenryx/react-editor
|
|
2
|
-
|
|
3
|
-
基于 contentEditable 的 React 19 富文本编辑器,内容以 **Markdown** 为唯一数据源:
|
|
4
|
-
|
|
5
|
-
- 普通编辑器:标题 / 加粗 / 斜体 / 删除线 / 列表 / 引用 / 代码块 / 表格 / 图片 / 链接 / 分割线
|
|
6
|
-
- 左侧目录自动收集 h1~h4,可收起为吸附按钮
|
|
7
|
-
- 工具栏溢出横向滚动,不换行
|
|
8
|
-
- 提供「切换到 Markdown 编辑器」可选入口
|
|
9
|
-
- 编辑结果通过 `onChange` 回传 Markdown,方便继续兼容 Markdown 存储
|
|
10
|
-
|
|
11
|
-
## 安装
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
npm install @zhenryx/react-editor
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
```tsx
|
|
18
|
-
import { RichTextEditor } from '@zhenryx/react-editor'
|
|
19
|
-
import '@zhenryx/react-editor/style.css'
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
## 基本用法
|
|
23
|
-
|
|
24
|
-
```tsx
|
|
25
|
-
import { useState } from 'react'
|
|
26
|
-
import { RichTextEditor } from '@zhenryx/react-editor'
|
|
27
|
-
import { renderMarkdown } from './your-markdown-renderer'
|
|
28
|
-
import '@zhenryx/react-editor/style.css'
|
|
29
|
-
|
|
30
|
-
export default function Editor() {
|
|
31
|
-
const [markdown, setMarkdown] = useState('')
|
|
32
|
-
|
|
33
|
-
return (
|
|
34
|
-
<RichTextEditor
|
|
35
|
-
markdown={markdown}
|
|
36
|
-
onChange={setMarkdown}
|
|
37
|
-
renderMarkdown={renderMarkdown}
|
|
38
|
-
onUploadImage={async (file) => {
|
|
39
|
-
const form = new FormData()
|
|
40
|
-
form.append('file', file)
|
|
41
|
-
const res = await fetch('/api/upload', { method: 'POST', body: form })
|
|
42
|
-
const data = await res.json()
|
|
43
|
-
return data.url
|
|
44
|
-
}}
|
|
45
|
-
onSwitchToMarkdown={() => {
|
|
46
|
-
// 由调用方切换自己的 Markdown 编辑器
|
|
47
|
-
}}
|
|
48
|
-
/>
|
|
49
|
-
)
|
|
50
|
-
}
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
## Props
|
|
54
|
-
|
|
55
|
-
| 属性 | 类型 | 必填 | 说明 |
|
|
56
|
-
| --- | --- | --- | --- |
|
|
57
|
-
| `markdown` | `string` | 是 | 当前内容(Markdown) |
|
|
58
|
-
| `onChange` | `(markdown: string) => void` | 是 | 内容变化时回传 Markdown |
|
|
59
|
-
| `onUploadImage` | `(file: File) => Promise<string>` | 是 | 上传图片并返回可访问 URL |
|
|
60
|
-
| `renderMarkdown` | `(markdown: string) => string` | 否 | Markdown → HTML 渲染器;建议传入,不传时退化为纯文本段落 |
|
|
61
|
-
| `onSwitchToMarkdown` | `() => void` | 否 | 显示「使用 Markdown 编辑器」按钮并触发该回调 |
|
|
62
|
-
| `switchLabel` | `string` | 否 | 切换按钮文案,默认「使用 Markdown 编辑器」 |
|
|
63
|
-
| `placeholder` | `string` | 否 | 正文占位文案,默认「开始写正文…」 |
|
|
64
|
-
| `className` | `string` | 否 | 追加到根节点 `.rre-root` |
|
|
65
|
-
| `features` | `RichTextEditorFeatures` | 否 | 按按钮控制功能开关,不传 = 全部开启 |
|
|
66
|
-
| `onInsertCodeRequest` | `(request: CodeInsertRequest) => void` | 否 | 自定义「代码」入口:提供后工具栏代码按钮不再弹内置面板,直接把选区交给宿主弹窗 |
|
|
67
|
-
|
|
68
|
-
### features 字段
|
|
69
|
-
|
|
70
|
-
每个字段传 `false` 即可隐藏对应按钮;分组内按钮全部隐藏时,分隔线自动消失。
|
|
71
|
-
|
|
72
|
-
| 字段 | 对应按钮 |
|
|
73
|
-
| --- | --- |
|
|
74
|
-
| `undo` / `redo` | 撤销 / 重做 |
|
|
75
|
-
| `format` | 格式下拉(正文 / 标题一~四) |
|
|
76
|
-
| `bold` / `italic` / `strike` | 加粗 / 斜体 / 删除线 |
|
|
77
|
-
| `list` / `orderedList` | 无序 / 有序列表 |
|
|
78
|
-
| `quote` / `hr` | 引用 / 水平线 |
|
|
79
|
-
| `code` / `table` | 代码块 / 表格 |
|
|
80
|
-
| `image` / `link` | 图片 / 链接 |
|
|
81
|
-
| `toc` | 左侧目录与收起吸附按钮 |
|
|
82
|
-
| `history` | 历史快照 |
|
|
83
|
-
| `color` / `background` | 文字颜色 / 背景色 |
|
|
84
|
-
| `other` | 其他样式(倾斜 / 下划线 / 删除线) |
|
|
85
|
-
| `align` | 对齐(左 / 中 / 右 / 两端) |
|
|
86
|
-
| `video` / `formula` | 视频 / LaTeX 公式 |
|
|
87
|
-
| `template` | 模板 |
|
|
88
|
-
| `wide` | 宽屏 |
|
|
89
|
-
| `todo` | 待办清单(Markdown 编辑器) |
|
|
90
|
-
| `codeRun` | 代码运行(JS 沙箱) |
|
|
91
|
-
| `save` | 保存草稿按钮 |
|
|
92
|
-
| `sidebar` / `outline` / `syntax` | Markdown 右侧栏 / 目录 / 语法 |
|
|
93
|
-
| `importMd` / `exportMd` | Markdown 导入 / 导出(更多操作) |
|
|
94
|
-
|
|
95
|
-
```tsx
|
|
96
|
-
<RichTextEditor
|
|
97
|
-
markdown={markdown}
|
|
98
|
-
onChange={setMarkdown}
|
|
99
|
-
renderMarkdown={renderMarkdown}
|
|
100
|
-
onUploadImage={upload}
|
|
101
|
-
features={{
|
|
102
|
-
image: false,
|
|
103
|
-
table: false,
|
|
104
|
-
toc: false,
|
|
105
|
-
}}
|
|
106
|
-
/>
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
## Markdown 编辑器
|
|
110
|
-
|
|
111
|
-
同时导出 `MarkdownEditor` 和 `MarkdownRichEditor`:
|
|
112
|
-
|
|
113
|
-
```tsx
|
|
114
|
-
import { MarkdownRichEditor } from '@zhenryx/react-editor'
|
|
115
|
-
|
|
116
|
-
<MarkdownRichEditor
|
|
117
|
-
markdown={markdown}
|
|
118
|
-
onChange={setMarkdown}
|
|
119
|
-
renderMarkdown={renderMarkdown}
|
|
120
|
-
onUploadImage={upload}
|
|
121
|
-
onSave={saveDraft}
|
|
122
|
-
fileBaseName="article"
|
|
123
|
-
/>
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
- 顶部 Markdown / 比对 / 预览 / 使用普通编辑器
|
|
127
|
-
- 列表:无序 / 有序 / 待办
|
|
128
|
-
- 代码块:语言选择
|
|
129
|
-
- 更多格式:引用 / 代码运行(仅 JavaScript,iframe 沙箱)
|
|
130
|
-
- 更多插入:视频 / 表格
|
|
131
|
-
- 更多操作:撤销 / 重做 / 导入 md / 导出 md
|
|
132
|
-
- 右侧栏:收起 / 目录 / 语法(不含 AI、营销组件)
|
|
133
|
-
- 按要求不实现模板与资源绑定
|
|
134
|
-
|
|
135
|
-
### 统一插入代码(0.1.4)
|
|
136
|
-
|
|
137
|
-
`RichTextEditor` / `MarkdownEditor` 都支持 `onInsertCodeRequest`:提供后工具栏的「代码」按钮把当前选区交出去,由宿主弹窗决定内容与呈现方式,再调用 `request.insert(payload)` 写回编辑器。
|
|
138
|
-
|
|
139
|
-
```tsx
|
|
140
|
-
import type { CodeInsertRequest } from '@zhenryx/react-editor'
|
|
141
|
-
|
|
142
|
-
let pending: CodeInsertRequest | null = null
|
|
143
|
-
|
|
144
|
-
<RichTextEditor
|
|
145
|
-
markdown={markdown}
|
|
146
|
-
onChange={setMarkdown}
|
|
147
|
-
onUploadImage={upload}
|
|
148
|
-
onInsertCodeRequest={(request) => { pending = request; setCodeDialogOpen(true) }}
|
|
149
|
-
/>
|
|
150
|
-
|
|
151
|
-
// 弹窗点确定:
|
|
152
|
-
pending?.insert({
|
|
153
|
-
refId: 12, // 代码库片段 id;有值时写 [[kbcode:12]] 引用
|
|
154
|
-
code: '...',
|
|
155
|
-
language: 'html',
|
|
156
|
-
display: 'file', // block / file
|
|
157
|
-
fileName: 'index.html',
|
|
158
|
-
})
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
- `request.mode`:`rich`(富文本)或 `markdown`,决定写回 HTML 还是围栏代码。
|
|
162
|
-
- `selectedText`:触发时的选中文本,可用于预填。
|
|
163
|
-
- `CodeInsertPayload.display = 'file'` 在 Markdown 里输出 `kbdisplay=file kbname=...` 围栏;`refId` 输出 `[[kbcode:id]]` / `[[kbcode:id:file]]`。
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
1
|
+
# @zhenryx/react-editor
|
|
2
|
+
|
|
3
|
+
基于 contentEditable 的 React 19 富文本编辑器,内容以 **Markdown** 为唯一数据源:
|
|
4
|
+
|
|
5
|
+
- 普通编辑器:标题 / 加粗 / 斜体 / 删除线 / 列表 / 引用 / 代码块 / 表格 / 图片 / 链接 / 分割线
|
|
6
|
+
- 左侧目录自动收集 h1~h4,可收起为吸附按钮
|
|
7
|
+
- 工具栏溢出横向滚动,不换行
|
|
8
|
+
- 提供「切换到 Markdown 编辑器」可选入口
|
|
9
|
+
- 编辑结果通过 `onChange` 回传 Markdown,方便继续兼容 Markdown 存储
|
|
10
|
+
|
|
11
|
+
## 安装
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @zhenryx/react-editor
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
```tsx
|
|
18
|
+
import { RichTextEditor } from '@zhenryx/react-editor'
|
|
19
|
+
import '@zhenryx/react-editor/style.css'
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## 基本用法
|
|
23
|
+
|
|
24
|
+
```tsx
|
|
25
|
+
import { useState } from 'react'
|
|
26
|
+
import { RichTextEditor } from '@zhenryx/react-editor'
|
|
27
|
+
import { renderMarkdown } from './your-markdown-renderer'
|
|
28
|
+
import '@zhenryx/react-editor/style.css'
|
|
29
|
+
|
|
30
|
+
export default function Editor() {
|
|
31
|
+
const [markdown, setMarkdown] = useState('')
|
|
32
|
+
|
|
33
|
+
return (
|
|
34
|
+
<RichTextEditor
|
|
35
|
+
markdown={markdown}
|
|
36
|
+
onChange={setMarkdown}
|
|
37
|
+
renderMarkdown={renderMarkdown}
|
|
38
|
+
onUploadImage={async (file) => {
|
|
39
|
+
const form = new FormData()
|
|
40
|
+
form.append('file', file)
|
|
41
|
+
const res = await fetch('/api/upload', { method: 'POST', body: form })
|
|
42
|
+
const data = await res.json()
|
|
43
|
+
return data.url
|
|
44
|
+
}}
|
|
45
|
+
onSwitchToMarkdown={() => {
|
|
46
|
+
// 由调用方切换自己的 Markdown 编辑器
|
|
47
|
+
}}
|
|
48
|
+
/>
|
|
49
|
+
)
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Props
|
|
54
|
+
|
|
55
|
+
| 属性 | 类型 | 必填 | 说明 |
|
|
56
|
+
| --- | --- | --- | --- |
|
|
57
|
+
| `markdown` | `string` | 是 | 当前内容(Markdown) |
|
|
58
|
+
| `onChange` | `(markdown: string) => void` | 是 | 内容变化时回传 Markdown |
|
|
59
|
+
| `onUploadImage` | `(file: File) => Promise<string>` | 是 | 上传图片并返回可访问 URL |
|
|
60
|
+
| `renderMarkdown` | `(markdown: string) => string` | 否 | Markdown → HTML 渲染器;建议传入,不传时退化为纯文本段落 |
|
|
61
|
+
| `onSwitchToMarkdown` | `() => void` | 否 | 显示「使用 Markdown 编辑器」按钮并触发该回调 |
|
|
62
|
+
| `switchLabel` | `string` | 否 | 切换按钮文案,默认「使用 Markdown 编辑器」 |
|
|
63
|
+
| `placeholder` | `string` | 否 | 正文占位文案,默认「开始写正文…」 |
|
|
64
|
+
| `className` | `string` | 否 | 追加到根节点 `.rre-root` |
|
|
65
|
+
| `features` | `RichTextEditorFeatures` | 否 | 按按钮控制功能开关,不传 = 全部开启 |
|
|
66
|
+
| `onInsertCodeRequest` | `(request: CodeInsertRequest) => void` | 否 | 自定义「代码」入口:提供后工具栏代码按钮不再弹内置面板,直接把选区交给宿主弹窗 |
|
|
67
|
+
|
|
68
|
+
### features 字段
|
|
69
|
+
|
|
70
|
+
每个字段传 `false` 即可隐藏对应按钮;分组内按钮全部隐藏时,分隔线自动消失。
|
|
71
|
+
|
|
72
|
+
| 字段 | 对应按钮 |
|
|
73
|
+
| --- | --- |
|
|
74
|
+
| `undo` / `redo` | 撤销 / 重做 |
|
|
75
|
+
| `format` | 格式下拉(正文 / 标题一~四) |
|
|
76
|
+
| `bold` / `italic` / `strike` | 加粗 / 斜体 / 删除线 |
|
|
77
|
+
| `list` / `orderedList` | 无序 / 有序列表 |
|
|
78
|
+
| `quote` / `hr` | 引用 / 水平线 |
|
|
79
|
+
| `code` / `table` | 代码块 / 表格 |
|
|
80
|
+
| `image` / `link` | 图片 / 链接 |
|
|
81
|
+
| `toc` | 左侧目录与收起吸附按钮 |
|
|
82
|
+
| `history` | 历史快照 |
|
|
83
|
+
| `color` / `background` | 文字颜色 / 背景色 |
|
|
84
|
+
| `other` | 其他样式(倾斜 / 下划线 / 删除线) |
|
|
85
|
+
| `align` | 对齐(左 / 中 / 右 / 两端) |
|
|
86
|
+
| `video` / `formula` | 视频 / LaTeX 公式 |
|
|
87
|
+
| `template` | 模板 |
|
|
88
|
+
| `wide` | 宽屏 |
|
|
89
|
+
| `todo` | 待办清单(Markdown 编辑器) |
|
|
90
|
+
| `codeRun` | 代码运行(JS 沙箱) |
|
|
91
|
+
| `save` | 保存草稿按钮 |
|
|
92
|
+
| `sidebar` / `outline` / `syntax` | Markdown 右侧栏 / 目录 / 语法 |
|
|
93
|
+
| `importMd` / `exportMd` | Markdown 导入 / 导出(更多操作) |
|
|
94
|
+
|
|
95
|
+
```tsx
|
|
96
|
+
<RichTextEditor
|
|
97
|
+
markdown={markdown}
|
|
98
|
+
onChange={setMarkdown}
|
|
99
|
+
renderMarkdown={renderMarkdown}
|
|
100
|
+
onUploadImage={upload}
|
|
101
|
+
features={{
|
|
102
|
+
image: false,
|
|
103
|
+
table: false,
|
|
104
|
+
toc: false,
|
|
105
|
+
}}
|
|
106
|
+
/>
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
## Markdown 编辑器
|
|
110
|
+
|
|
111
|
+
同时导出 `MarkdownEditor` 和 `MarkdownRichEditor`:
|
|
112
|
+
|
|
113
|
+
```tsx
|
|
114
|
+
import { MarkdownRichEditor } from '@zhenryx/react-editor'
|
|
115
|
+
|
|
116
|
+
<MarkdownRichEditor
|
|
117
|
+
markdown={markdown}
|
|
118
|
+
onChange={setMarkdown}
|
|
119
|
+
renderMarkdown={renderMarkdown}
|
|
120
|
+
onUploadImage={upload}
|
|
121
|
+
onSave={saveDraft}
|
|
122
|
+
fileBaseName="article"
|
|
123
|
+
/>
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
- 顶部 Markdown / 比对 / 预览 / 使用普通编辑器
|
|
127
|
+
- 列表:无序 / 有序 / 待办
|
|
128
|
+
- 代码块:语言选择
|
|
129
|
+
- 更多格式:引用 / 代码运行(仅 JavaScript,iframe 沙箱)
|
|
130
|
+
- 更多插入:视频 / 表格
|
|
131
|
+
- 更多操作:撤销 / 重做 / 导入 md / 导出 md
|
|
132
|
+
- 右侧栏:收起 / 目录 / 语法(不含 AI、营销组件)
|
|
133
|
+
- 按要求不实现模板与资源绑定
|
|
134
|
+
|
|
135
|
+
### 统一插入代码(0.1.4)
|
|
136
|
+
|
|
137
|
+
`RichTextEditor` / `MarkdownEditor` 都支持 `onInsertCodeRequest`:提供后工具栏的「代码」按钮把当前选区交出去,由宿主弹窗决定内容与呈现方式,再调用 `request.insert(payload)` 写回编辑器。
|
|
138
|
+
|
|
139
|
+
```tsx
|
|
140
|
+
import type { CodeInsertRequest } from '@zhenryx/react-editor'
|
|
141
|
+
|
|
142
|
+
let pending: CodeInsertRequest | null = null
|
|
143
|
+
|
|
144
|
+
<RichTextEditor
|
|
145
|
+
markdown={markdown}
|
|
146
|
+
onChange={setMarkdown}
|
|
147
|
+
onUploadImage={upload}
|
|
148
|
+
onInsertCodeRequest={(request) => { pending = request; setCodeDialogOpen(true) }}
|
|
149
|
+
/>
|
|
150
|
+
|
|
151
|
+
// 弹窗点确定:
|
|
152
|
+
pending?.insert({
|
|
153
|
+
refId: 12, // 代码库片段 id;有值时写 [[kbcode:12]] 引用
|
|
154
|
+
code: '...',
|
|
155
|
+
language: 'html',
|
|
156
|
+
display: 'file', // block / file
|
|
157
|
+
fileName: 'index.html',
|
|
158
|
+
})
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
- `request.mode`:`rich`(富文本)或 `markdown`,决定写回 HTML 还是围栏代码。
|
|
162
|
+
- `selectedText`:触发时的选中文本,可用于预填。
|
|
163
|
+
- `CodeInsertPayload.display = 'file'` 在 Markdown 里输出 `kbdisplay=file kbname=...` 围栏;`refId` 输出 `[[kbcode:id]]` / `[[kbcode:id:file]]`。
|
|
164
|
+
|
|
165
|
+
### HTML 预览沙箱(0.1.5)
|
|
166
|
+
|
|
167
|
+
`MarkdownEditor` / `MarkdownRichEditor` 支持 `htmlPreviewSandbox`(默认 `true`):预览 iframe 默认带 `sandbox="allow-scripts"`。部分 Chrome 版本下 sandbox iframe 会吞掉交互,可在宿主里传 `htmlPreviewSandbox={false}` 去掉 sandbox;内容仍带 CSP(`default-src 'none'` + 仅允许内联样式/脚本),但脚本会与宿主同源,需自行评估安全。
|
|
168
|
+
|
|
169
|
+
```tsx
|
|
170
|
+
<MarkdownRichEditor
|
|
171
|
+
markdown={markdown}
|
|
172
|
+
onChange={setMarkdown}
|
|
173
|
+
onUploadImage={upload}
|
|
174
|
+
htmlPreviewSandbox={false}
|
|
175
|
+
/>
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
直接调用 `enhanceHtmlCodeBlocks(container, { sandbox: false })` 也可以达到同样效果。
|
|
179
|
+
|
|
180
|
+
富文本的颜色 / 背景 / 对齐 / 下划线 / 视频会以受限内联 HTML 写入 Markdown;渲染器需放行 `<u>`、`<span style="color/background-color/text-align/display">` 和 `<video src controls>`。
|
|
181
|
+
|
|
182
|
+
## 样式
|
|
183
|
+
|
|
184
|
+
必须引入:
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
import '@zhenryx/react-editor/style.css'
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
组件根类名为 `.rre-root`,内部样式均以 `rre-` 前缀隔离,不依赖宿主项目的 CSS 变量。
|
|
191
|
+
|
|
192
|
+
## 数据约定
|
|
193
|
+
|
|
194
|
+
- `onChange` 输出的始终是 Markdown。
|
|
195
|
+
- 普通编辑器支持的格式都可逆转换为 Markdown:标题、粗体、斜体、删除线、列表、任务清单、引用、代码块(保留语言)、表格、链接、图片、分割线。
|
|
196
|
+
- 颜色、对齐、公式、视频等 Markdown 无法表达的样式不会写入数据。
|
|
197
|
+
- 代码块兼容知识库 `renderMarkdown` 输出的 `.kb-code` / `.kb-code-lang` 包装。
|
|
198
|
+
|
|
199
|
+
## 本地开发
|
|
200
|
+
|
|
201
|
+
```bash
|
|
202
|
+
npm install
|
|
203
|
+
npm run dev # tsdown --watch
|
|
204
|
+
npm run typecheck
|
|
205
|
+
npm run build # dist/:esm + cjs + d.ts + style.css + sourcemap
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
## 发布
|
|
209
|
+
|
|
210
|
+
```bash
|
|
211
|
+
npm run build
|
|
212
|
+
npm publish --access public
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
发布后把宿主项目的依赖从本地 `file:` 改成 `^0.1.5` 即可。
|
package/dist/index.cjs
CHANGED
|
@@ -2410,7 +2410,7 @@ try { ${richRun.code.replace(/<\/script/gi, "<\\/script")} } catch (e) { send('e
|
|
|
2410
2410
|
* 为 Markdown 渲染出的 HTML 代码块增加「源码 / 预览 / 复制 / 全屏 / 刷新」。
|
|
2411
2411
|
* 只处理 language-html / language-htm,普通代码块完全不动。
|
|
2412
2412
|
*/
|
|
2413
|
-
const CSP = "default-src 'none'; style-src 'unsafe-inline'; script-src 'unsafe-inline'; img-src data: https: http:; font-src data: https: http:;";
|
|
2413
|
+
const CSP = "default-src 'none'; style-src 'unsafe-inline'; script-src 'unsafe-inline'; img-src data: https: http:; font-src data: https: http:; form-action 'none'; base-uri 'none';";
|
|
2414
2414
|
function buildDoc(code) {
|
|
2415
2415
|
const meta = "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">";
|
|
2416
2416
|
const style = `<style>html,body{margin:0;padding:0;background:#fff;color:#111827;font:14px/1.7 -apple-system,BlinkMacSystemFont,'Segoe UI','PingFang SC','Microsoft YaHei',sans-serif}img{max-width:100%}a{color:#2563eb}</style>`;
|
|
@@ -2430,7 +2430,8 @@ function makeButton(label, className) {
|
|
|
2430
2430
|
function languageOf(code) {
|
|
2431
2431
|
return ((code.className || "").match(/language-([\w-]+)/)?.[1] || "").toLowerCase();
|
|
2432
2432
|
}
|
|
2433
|
-
function enhanceHtmlCodeBlocks(container) {
|
|
2433
|
+
function enhanceHtmlCodeBlocks(container, options = {}) {
|
|
2434
|
+
const useSandbox = options.sandbox !== false;
|
|
2434
2435
|
container.querySelectorAll("pre > code").forEach((code) => {
|
|
2435
2436
|
const pre = code.closest("pre");
|
|
2436
2437
|
if (!pre) return;
|
|
@@ -2471,7 +2472,7 @@ function enhanceHtmlCodeBlocks(container) {
|
|
|
2471
2472
|
if (iframe) return iframe;
|
|
2472
2473
|
iframe = document.createElement("iframe");
|
|
2473
2474
|
iframe.className = "kb-html-preview-frame";
|
|
2474
|
-
iframe.setAttribute("sandbox", "allow-scripts");
|
|
2475
|
+
if (useSandbox) iframe.setAttribute("sandbox", "allow-scripts");
|
|
2475
2476
|
iframe.setAttribute("title", "HTML 预览");
|
|
2476
2477
|
iframe.srcdoc = buildDoc(source);
|
|
2477
2478
|
preview.appendChild(iframe);
|
|
@@ -2514,7 +2515,7 @@ function enhanceHtmlCodeBlocks(container) {
|
|
|
2514
2515
|
const close = makeButton("关闭", "kb-html-action-btn");
|
|
2515
2516
|
bar.append(label, close);
|
|
2516
2517
|
fullFrame = document.createElement("iframe");
|
|
2517
|
-
fullFrame.setAttribute("sandbox", "allow-scripts");
|
|
2518
|
+
if (useSandbox) fullFrame.setAttribute("sandbox", "allow-scripts");
|
|
2518
2519
|
fullFrame.setAttribute("title", "HTML 全屏预览");
|
|
2519
2520
|
panel.append(bar, fullFrame);
|
|
2520
2521
|
fullMask.appendChild(panel);
|
|
@@ -2597,7 +2598,7 @@ function markdownHeadings(markdown) {
|
|
|
2597
2598
|
};
|
|
2598
2599
|
});
|
|
2599
2600
|
}
|
|
2600
|
-
function MarkdownEditor({ markdown, onChange, onUploadImage, renderMarkdown = defaultRenderMarkdown, onSwitchToRichEditor, switchLabel = "使用普通编辑器", onSave, fileBaseName = "article", features, initialView = "split", placeholder = "# 从这里开始写 Markdown…", className = "", onInsertCodeRequest }) {
|
|
2601
|
+
function MarkdownEditor({ markdown, onChange, onUploadImage, renderMarkdown = defaultRenderMarkdown, onSwitchToRichEditor, switchLabel = "使用普通编辑器", onSave, fileBaseName = "article", features, initialView = "split", placeholder = "# 从这里开始写 Markdown…", className = "", onInsertCodeRequest, htmlPreviewSandbox = true }) {
|
|
2601
2602
|
const feature = (key) => features?.[key] !== false;
|
|
2602
2603
|
const [view, setView] = (0, react.useState)(initialView);
|
|
2603
2604
|
const [uploading, setUploading] = (0, react.useState)(false);
|
|
@@ -2637,7 +2638,7 @@ function MarkdownEditor({ markdown, onChange, onUploadImage, renderMarkdown = de
|
|
|
2637
2638
|
(0, react.useEffect)(() => {
|
|
2638
2639
|
const pv = previewRef.current;
|
|
2639
2640
|
if (!pv) return;
|
|
2640
|
-
const run = () => enhanceHtmlCodeBlocks(pv);
|
|
2641
|
+
const run = () => enhanceHtmlCodeBlocks(pv, { sandbox: htmlPreviewSandbox });
|
|
2641
2642
|
run();
|
|
2642
2643
|
const observer = new MutationObserver(run);
|
|
2643
2644
|
observer.observe(pv, {
|
|
@@ -2645,7 +2646,7 @@ function MarkdownEditor({ markdown, onChange, onUploadImage, renderMarkdown = de
|
|
|
2645
2646
|
subtree: true
|
|
2646
2647
|
});
|
|
2647
2648
|
return () => observer.disconnect();
|
|
2648
|
-
}, []);
|
|
2649
|
+
}, [htmlPreviewSandbox]);
|
|
2649
2650
|
(0, react.useEffect)(() => {
|
|
2650
2651
|
const pv = previewRef.current;
|
|
2651
2652
|
if (!pv) return;
|
|
@@ -3381,7 +3382,7 @@ try { ${codeRun.code.replace(/<\/script/gi, "<\\/script")} } catch (e) { send('e
|
|
|
3381
3382
|
}
|
|
3382
3383
|
// src/MarkdownRichEditor.tsx
|
|
3383
3384
|
/** 普通编辑器 + Markdown 编辑器,一个组件内切换 */
|
|
3384
|
-
function MarkdownRichEditor({ mode, defaultMode = "rich", onModeChange, markdownView, markdownSwitchLabel = "使用普通编辑器", renderRichMarkdown, onSave, fileBaseName, richSwitchLabel = "使用 Markdown 编辑器", className = "", markdownClassName = "", richClassName = "", ...props }) {
|
|
3385
|
+
function MarkdownRichEditor({ mode, defaultMode = "rich", onModeChange, markdownView, markdownSwitchLabel = "使用普通编辑器", renderRichMarkdown, onSave, fileBaseName, richSwitchLabel = "使用 Markdown 编辑器", htmlPreviewSandbox, className = "", markdownClassName = "", richClassName = "", ...props }) {
|
|
3385
3386
|
const [innerMode, setInnerMode] = (0, react.useState)(defaultMode);
|
|
3386
3387
|
const current = mode ?? innerMode;
|
|
3387
3388
|
function changeMode(next) {
|
|
@@ -3390,6 +3391,7 @@ function MarkdownRichEditor({ mode, defaultMode = "rich", onModeChange, markdown
|
|
|
3390
3391
|
}
|
|
3391
3392
|
if (current === "markdown") return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(MarkdownEditor, {
|
|
3392
3393
|
...props,
|
|
3394
|
+
htmlPreviewSandbox,
|
|
3393
3395
|
className: markdownClassName,
|
|
3394
3396
|
initialView: markdownView,
|
|
3395
3397
|
switchLabel: markdownSwitchLabel,
|