tiptap API 引言
Tiptap 是 ProseMirror 的一个友好的封装。尽管 Tiptap 尽力隐藏了 ProseMirror 的大部分复杂性,但它建立在其 API 之上,我们建议您阅读 ProseMirror 指南 以了解高级用法。
结构
ProseMirror 使用严格的 模式,定义文档允许的结构。文档是一个由标题、段落和其他称为节点的元素组成的树。标记可以附加到节点,例如强调其部分。命令 以程序方式更改文档。
内容
文档存储在状态中。所有更改都作为事务应用到状态上。状态包含有关当前内容、光标位置和选择的详细信息。您可以针对不同的 事件 进行挂钩,例如在应用事务之前对其进行修改。
扩展
扩展向编辑器添加 节点、标记 和/或 功能 。许多这些扩展将它们的命令绑定到常见的 键盘快捷键。
词汇表
ProseMirror 有自己的词汇,您可能会偶尔遇到这些词。以下是我们在文档中常用的一些常见词汇的简要概述。
词 | 描述 |
---|---|
模式 | 配置您的内容可能具有的结构。 |
文档 | 编辑器中的实际内容。 |
状态 | 描述当前编辑器内容和选择的所有内容。 |
事务 | 对状态的更改(更新选择、内容等)。 |
扩展 | 注册新功能。 |
节点 | 类型的内容,例如标题或段落。 |
标记 | 可应用于节点,例如用于行内格式化。 |
命令 | 在编辑器内部执行操作,以某种方式更改状态。 |
装饰 | 文档上的样式,例如突出显示错误。 |