@ godxjp/ 块编辑器
在Tiptap v3(仅限麻省理工学院部分)上,GODX应用的一款Notion / note.com风格块编辑器. 它读和
写入 标记: 文档是 @godxjp/markdown/codec那又怎样 onValueChange 返回为
字节换字节 normalize(body) ——同名克能克组成一个服务器,用同名克能克来计算.
import { BlockEditor } from "@godxjp/block-editor";
<BlockEditor
aria-label="本文"
value={body}
onValueChange={setBody}
upload={async (file, { signal }) => ({ url: await media.put(file, { signal }), name: file.name })}
pickMedia={() => media.pick()}
suggestWikilinks={(query) => pages.search(query)}
renderEmbed={(target) => <PageEmbed target={target} />}
resolveUrl={(url) => (url.startsWith("asset:") ? media.url(url) : undefined)}
/>;
它会做什么
/块菜单 在护身符上(也)/从日本键盘取出:文本、标题、列表、, 待办、 引文、 呼号、 代码、 分隔符、 图像、 表格、 切换、 列—— 按键过滤 (单位:千美元)h2, (中文(简体) ),h2, (中文(简体) ),見出し),"输入Esc. 主机行经actions。 。 。 .- ++ 处理和+ 在指针下方的地块旁边(护身符的地块在触摸上):拖去移动, 单击可转换为 / 重复 / 移动 / 删除 。 从键盘: Alt+Shift+↑/↓移动一个块, Mod+/ 打开菜单 .
- 格式工具栏 在选中位置: 粗体、 斜体、 切换、 代码、 链接( 只标记 Markdown) ——没有下划线.
- 下标快捷键 (单位:千美元)
#, (中文(简体) ),-, (中文(简体) ),1., (中文(简体) ),>, (中文(简体) ),```, (中文(简体) ),---, (中文(简体) ),[[x]])和简洁文本 贴被读作"Markdown". - 上传: 粘贴 / 放下 / 选择一个文件 / 一个内含的占位符, 并有进展; 失败报价
重试/ 删除; 删除占位符中止主机
signal。 。 。 . - 指令块: 包件没有模型的容器指令(
:::poll[…]{…}, (中文(简体) ),::::form)是 One 原子块——被拖走,被删除并插入整个块——显示主机的预览 名称(directives),或它的源;"编辑源"编辑它的Markdown. 一个主机/横行 插入一个api.insertMarkdown(skeleton)。 。 。 . - 无损失: 编辑器没有模型的任何东西(raw HTML、脚注、错误的切换或 栏行)是显示其源的生块,可以作为源编辑.
- IME 安全 (菜单读到承诺的文件), 日/时/六,名称
textbox与 WAI -ARIA 弹出线布置在/财务报告和审定财务报表[[列表中,工具包的Prose作为编辑表面.
合同
| 道具 | |
|---|---|
value 编号 : defaultValue 编号 : onValueChange | 马克倒入,克尼克倒出 |
upload(file, { signal }) | → { url, name? } ——形状与 MarkdownEditor |
pickMedia() | → { url, name? } | null ——主机图书馆 |
suggestWikilinks(query) | → { target, label?, heading?, description? }[] |
renderEmbed(target) | 嵌入块 ![[target]] |
resolveUrl(url) | 显示存储的 URL (E)asset:<id>(中文(简体) ) |
directives | { [name]: (block, controls) => ReactNode | undefined } 预览 |
actions, (中文(简体) ), labels, (中文(简体) ), disabled, (中文(简体) ), readOnly, (中文(简体) ), autoFocus, (中文(简体) ), aria-*, (中文(简体) ), id |
// A poll is a block: the host previews it and inserts its skeleton from the `/` menu.
<BlockEditor
value={body}
onValueChange={setBody}
directives={{
// block: { name, label, attributes, source, body } — the codec's canonical Markdown
poll: (block) => <PollPreview question={block.label} options={block.body} />,
}}
actions={[
{
key: "poll",
label: "Poll",
icon: <ListChecks />,
run: (api) => api.insertMarkdown(":::poll[Question]{id=poll-1}\n- Option A\n- Option B\n:::"),
},
]}
/>
预览可以更改自己的块(gh#1479): controls.update(markdown) 替换块的
源与“编辑源”完全相同 —— 完成(仍一个指令:同一个块,一个倒出步骤;
任何其它东西都会取代它, controls.remove() 删除它,并 controls.editable 在一个
只读或已禁用编辑器。 一个主机的拾取者或配置形式以这种方式将结果写回:
directives={{
card: (block, { update, editable }) => (
<CardPreview id={block.attributes.card} onPick={editable ? (id) => update(`:::card{card=${id}}\n:::`) : undefined} />
),
}}
它的读写语法在 @godxjp/markdown读取("Grammar v1"和
代码"。 编辑器的图案通过测试 来绕行每个固定点:
serialize(editor.getJSON()) === normalize(markdown)。 。 。 .
RichText编辑器和直译RichText — HTML 字段
对于已经持有的列 HTML 语言 (库存前置产品描述),包件 并且使用固定工具栏——粗体、斜体、击打、内含码 —— H1-H3 发子弹 / 编号列表, 引用 \\ 撤消、 重做 —— 及其每个地方的形式 (gh# 1365).
import { RichTextEditor, TranslatableRichText } from "@godxjp/block-editor";
import { FormField } from "@godxjp/ui/data-entry";
<FormField label="説明" required>
<TranslatableRichText value={description} onValueChange={setDescription} errors={errors} />
</FormField>;
- 计划是疗养:
value(和一贴) 被解为,和onValueChange发射,只有p br h1 h2 h3 ul ol li blockquote strong em s code(单位:千美元)RICH_TEXT_ALLOWED_TAGS无 除整数以外的属性start打开<ol>。其他任何文字——脚本、链接、图像、样式、h4-h6表——都保留为正文. 一个空的躯体""。 。 。 . - A 类
value从外部( 重设、 本地化标签) 替换文档而不调用onValueChange,而永远不要当一个IME组成是开放的. - 它需要Form Field的车
id编号 :aria-*可编辑的;status编号 :aria-invalid画出相框. TranslatableRichText装箱的TranslatableField发动机绕着它——与TranslatableInput: 来自 AppProvider 的地块和第一个标签contentLocales,每个地点出错 标记、 窗体字段中的活性错误, 以及作为空地块的倒回方格文字 占位符 .