EditorState 类提供了一些静态方法进行实例化：

• static EditorState.create(config) 静态方法：基于配置对象 config（它需要符合一种 TypeScript interface EditorStateConfig）创建一个新的 state 状态对象
  EditorStateConfig

  TypeScript interface EditorStateConfig 描述编辑器状态可接受哪些配置参数

  • schema（可选）属性：一个 schema 数据结构约束对象，用于设置编辑器所允许容纳的内容。在没有设置属性 doc 时才会使用该属性
  • doc（可选）属性：一个 node 节点对象（作为根节点），用于设置编辑器的起始内容

  注意

  以上两个可选属性 schema 和 doc 必须设置其中一个

  • selection（可选）属性：一个 selection 对象，用于设置编辑器的选区
  • storedMarks（可选）属性：一个数组（其元素是一系列 mark 对象），表示预设的样式标记（即对于之后输入的内容应用哪些样式标记）
  • plugins（可选）属性：一个数组（其元素是一系列 plugin 对象），用于设置编辑器所使用的插件

  提示

  可以通过注册插件 plugin 来为编辑器状态对象 state 新增字段/属性

• static EditorState.fromJSON(config, json, pluginFields?) 静态方法：基于配置参数 config 和 JSON 对象，创建一个新的 state 状态对象
  相关参数的具体说明如下：
  • 第一个参数 config 是一个对象，至少包含 schema 属性，以设置编辑器所允许容纳的内容；一般还会有 plugins 属性，它是一个数组（包含一系列 plugin 插件对象），这些插件会在初始化编辑器的状态时被调用
  • 第二个参数 json 是需要反序列化的 JSON 对象，它会被转换为编辑器的内容
  • 第三个（可选）参数 pluginFields 是一个对象。如果第二个参数 json JSON 对象中包含了 plugin 的 state 则需要设置该参数。该对象是用来基于插件的 key 和 JSON 对象的属性名的对应关系，指明 JSON 对象中的哪些字段对应（存储）哪个 plugin 的 state，在反序列 deserialize 过程中可以将 JSON 相应的属性值转换为 plugin 的 state
  提示

  如果设置了 pluginFields 参数，则在对应插件的属性 state（一个对象）中需要设置 fromJSON 方法（该方法传入的参数是 config、插件对应的 json 和根据 config 生成的编辑器 state）

  如果 JSON 对象的字段没有对应到任一个 plugin 的 key，则会直接调 plugin 的 state 的 init 方法（该方法传入的参数是 config 和根据 config 生成的编辑器的 state）

EditorState 类的实例化对象表示编辑器的一个 state 对象，以下称作「编辑器状态对象」

state 编辑器状态对象包含一些属性和方法：

• doc 属性：一个 node 节点对象，表示当前的文档（根节点）
• selection 属性：一个 selection 选区对象，表示当前用户选中的内容
• storedMarks 属性：一个数组（其中包含一系列 mark 样式标记对象），表示即将应用到下一次输入的内容的样式标记（例如预先开启了粗体的标记，再输入文本就直接显示为粗体的），如果没有预设的样式标记则该属性值为 null
• schema 属性：一个 schema 数据结构约束对象，表示编辑器可容纳哪些格式的内容
• plugins 属性：一个数组（其元素是一系列 plugin 对象），表示当前所激活的插件
• apply(tr) 方法：对当前编辑器状态应用一个事务 tr 并返回一个新的编辑器状态
• applyTransaction(rootTr) 方法：和方法 apply() 类似，也是将事务 rootTr 应用到当前编辑器状态，但它返回一个对象 { state: EditorState, transactions: [Transaction] } 包含（关于这次状态更新的）更详细的信息（其中属性 state 是新的编辑器状态，属性 transactions 是在此过程中通过插件所应用的诸多事务）
• tr 属性：基于当前编辑器状态创建一个 transaction 事务
• reconfigure(config) 属性：基于当前编辑器状态和传入（新的）配置参数 config（对编辑器的激活插件进行调整）创建一个新的状态。
  在配置参数 config 中包含一个属性 plugins，该属性值是一个数组（包含一系列 plugin 对象），更新编辑器状态时将会应用这些插件
  在两个状态 state 中都有的属性保持不变；对于配置参数 config 中舍弃的属性会在新的状态中移除；对于配置参数 config 中新增的属性会调用插件的 init() 方法来设置它们的初始值
• toJSON(pluginField?) 方法：将当前的编辑器状态序列化为 JSON 对象
  （可选）参数 pluginField 可以是多种数据格式。如果想序列化时保留 plugin 的 state，则需要传入一个对象，以键值对的方式指定序列化得到 JSON 对象中哪个字段对应存储哪个 plugin 的 state（键名是 JSON 字段名，值是 plugin 实例对象）；也可以传入一个字符串或数字作为参数，则与 plugin 的 state 将会在转换过程中被忽略。
  提示

  如果想将编辑器状态序列化为 JSON 对象时，保留 plugin 的 state，则需要同时在相应的 plugin 的属性 state 中提供 toJSON(key) 方法（其入参 key 是插件的 key）

Transaction 类与操作编辑器内容相关

通过将一个 transaction 事务对象（可以调用状态对象的方法 state.apply(transaction) 生成一个事务对象）应用到当前（旧的）编辑器状态对象，才可以生成一个新的状态。

通过编辑器状态对象的属性 state.tr 基于编辑器当前的状态创建一个空的事务对象实例

Transaction 类的实例化对象 transaction 称作「事务对象」，一般简称为 tr

事务对象 transaction 包含一些属性和方法：

• time 属性：一个数字，该事务创建时的时间戳，和 Date.now() 的值相同
• setTime(time) 方法：根据传入的参数 time（它的值是数字）更新该事务的时间戳。返回该事务对象本身
• storedMarks 属性：一个数组（其中包含一系列 mark 样式标记对象，它们作为预设样式标记，即将应用到下一次输入的内容的样式标记），表示该事务要将预设样式标记修改为什么样子
• setStoredMarks(marks) 方法：将该事务的预设样式标记设置为参数 mark（它是是一个数组，其中每个元素都是 mark 样式标记对象）。返回该事务对象本身
• storedMarksSet 属性：一个布尔值，表示该事务是否设置调整了预设样式标记
• ensureMarks(marks) 方法：确保该事务中的预设样式标记与参数 marks（一个由一系列 mark 对象构成的数组）一致，如果不一致就对其进行修改，以保证与入参 marks 一致。返回该事务对象本身
  如果该事务没有对预设样式标记进行设置，则需要确保光标（选中内容）的样式标记与参数 marks 一致
• addStoredMark(mark) 方法：将参数 mark 样式标记对象添加到该事务的预设样式标记集合中。返回该事务对象本身
• removeStoredMark(mark) 方法：将给定的 mark 样式标记（可以是一个样式标记对象，或 markType 样式标记类型）从该事务的预设样式标记集合中移除。返回该事务对象本身
• selection 属性：一个 selection 选区对象，表示编辑器（在应用该事务后）选中的内容。它默认是对原来的选区经过该事务中不同 steps 步骤 map 映射后的结果。
  Tip

  可以调用方法 transaction.setSelection() 修改（通过 step 步骤映射）默认生成的选区

• setSelection(selection) 方法：将该事务的选区更新为参数 selection。它会覆盖原有的映射行为，决定应用事务后编辑器所选中的内容。返回该事务对象本身
• selectionSet 属性：一个布尔值，表示该事务是否显式地对选区进行调整操作
• replaceSelection(slice) 方法：用传入的 slice 切片对象替换当前选区选中的内容。返回该事务对象本身
• replaceSelectionWith(node, inheritMarks?) 方法：将选中内容替代为给定的 node 节点对象，如果第二个（可选）参数 inheritMarks 设置为 true，且替换插入的 node 节点的内容/片段是 inline 内联内容，则插入的内容将会继承该位置原有的样式标记。返回该事务对象本身
  提示

  在内部调用 transform 对象的方法 replaceRangeWith 对选中内容进行替换，ProseMirror 可能会自动调整替换范围（例如当选区的 from 和 to 相同且都位于父级节点的起始或结尾位置，而给定的 node 并不适合此位置时，则可能将给定的 node 放置到合适的祖先节点里，以满足 schema 的约束）

• deleteSelection() 方法：删除选区选中的内容。返回该事务对象本身
• insertText(text, from, to) 方法：用给定的 text 文本节点对象的内容，替换从 from 到 to 范围的文档内容；如果没有指定范围，就将 text 文本节点对象的内容替换当前选区的内容。返回该事务对象本身
• setMeta(key, value) 方法：为该事务设置元信息。第一个参数 key 可以是一个字符串、plugin 插件对象或 pluginKey 表示插件的键名，作为新增的元信息的属性名；第二个参数 value 是新增的元信息的值。返回该事务对象本身
  提示

  因为一个事务可能会被不同的 plugin 设置不同的 metadata 信息，因此需要区分。所以参数 key 不仅可以是简单的一个字符串，还可以传递 plugin 或 PluginKey。

• getMeta(key) 方法：获取特定的元信息。其入参 key 可以是一个字符串、plugin 插件对象或 pluginKey 表示插件的键名，其返回值是给定键名的相应元信息
• isGeneric 属性：一个布尔值，表示该事务是否含有元信息，如果不包含任何元信息，则该属性值为 true
  提示

  通过该属性可以判断该事务是否包含额外的元信息，如果没有就可以放心对该事务扩展修改

  例如与其他的 step 操作步骤进行合并，如果事务有元信息，则它可能是对于某个插件有特殊用途的，不能简单地与其他 step 进行合并

• scrollIntoView() 方法：表示应用该事务后（更新完 state 编辑器状态后），编辑器要将选区滚动到视图窗口中。返回该事务对象本身
• scrollIntoView 属性：一个布尔值，表示该事务是否调用了 scrollIntoView() 方法将选区滚动到视图窗口中。

type Command = fn(
  // 编辑器状态对象
  state: EditorState,
  // dispatch 方法用来分发该指令
  // 该方法可以接受一个 tr 事务作为参数，它用以更新编辑器状态
  dispatch⁠?: fn(tr: Transaction),
  // 编辑器的视图对象
  view⁠?: EditorView
) → boolean
// 最后返回一个布尔值，表示该指令是否触发成功（即 tr 事务是否执行成功）

ProseMirror 的 Selection 概念和 web 原生的 Selection 概念类似，表示文档中的一个选区，但具体的实现有所不同。

Selection 是一个 TypeScript abstract class 抽象类，它给出了一些抽象方法和具体的方法

通过方法 new Selection($anchor, $head, ranges) 进行实例化，获取一个选区对象（实际上需要先继承该类，再可以对其子类进行实例化），各参数的具体说明如下：

• 第一、二个参数 $anchor 和 $head 都是一个 resolvedPos 对象，分别表示选区的锚点（锚定「不动」的一端，即框选开始时光标的位置）和动点（即框选结束时光标的位置，如果选区变化会在这一侧发生）
• 第三个（可选）参数 ranges 是一个数组（一般仅含有一个元素的），该元素是一个 SelectionRange 对象，表示文档中的一个选区对应于文档中的范围，如果省略该参数 ProseMirror 会根据 $anchor 和 $head 构建出该对象
  SelectionRange

  SelectionRange 类表示一个选区所对应于文档中的范围

  通过方法 new SelectionRange($from, $to) 实例化，将其称为「选区范围」，它接受两个 resolvedPos 对象 $from 和 $to 作为参数，分别表示该选区范围的 lower boundary 下界（在文档中较前的位置）和 upper boundary 上界（在文档中较后的位置）

也可以使用该类所提供的一些静态方法进行实例化（实际上需要先继承该类，再可以通过调用其子类的相应的静态方法进行实例化）：

• static Selection.findFrom($pos, dir, textOnly?) 静态方法：在给定位置 $pos（一个resolvedPos 对象）的一侧寻找一个合法/合适的地方创建一个文本选区（该文本选区处于光标状态）或节点选区（该节点是叶子节点）。如果没有找到可用的地方来创建选区则返回 null
  第二个参数 dir 的正负值决定寻找的方向，如果是正值就从位置 $pos 开始向右侧寻找；如果是负值就向左侧寻找
  第三个（可选）参数 textOnly 是一个布尔值，以判断是否只寻找适合于创建文本选区（该文本选区处于光标状态）的地方
  提示

  该方法一般是在执行粘贴或其他操作后调用的，在该场景中可能不知道要将光标放到哪个合适的位置，该方法会自动寻找一个合适的位置，而不需要显式地手动设置

  另一个类似的静态方法是 Selection.near()

• static Selection.near($pos, bias?) 静态方法：在给定位置 $pos（一个resolvedPos 对象）附近寻找一个合法/合适的地方创建一个文本选区（该文本选区处于光标状态）或节点选区（该节点是叶子节点）
  第二个（可选）参数 bias 是一个数值（默认值为 1），设置优先寻找的方向。如果 bias 为正数则优先向右侧寻找；如果参数 bias 为负值则优先向左侧寻找
• static Selection.atStart(doc) 静态方法：在给定文档 doc（一个节点对象，根节点，表示文档）的开头开始去寻找一个合法/合适的地方创建一个文本选区（该文本选区处于光标状态）或节点选区（该节点是叶子节点）。如果没有寻找到可用的选区，则返回一个 allSelection 全选选区
• static Selection.atEnd(doc) 静态方法：在给定文档 doc（一个节点对象，根节点，表示文档）的结尾开始去寻找一个合法/合适的地方创建一个文本选区（该文本选区处于光标状态）或节点选区（该节点是叶子节点）。

另外还提供了一些静态方法用于将选区序列化为 JSON 对象或将 JSON 对象反序列化为一个选区对象：

• static Selection.fromJSON(doc, json) 静态方法：反序列化一个给定的 json 对象，在文档 doc（一个节点对象，根节点，表示文档）中构建一个选区
  Tip

  ProseMirror 内置的 TextSelection 文本选区子类，NodeSelection 节点选区子类均有预设的静态方法 subClass.fromJSON()

  而对于自定义的选区子类，该静态方法也必须自己来定义

• static Selection.jsonID(id, selectionSubClass) 静态方法：为 Selection 子类 selectionSubClass 注册一个唯一的标识符。其返回值是该选区子类
  第一个参数 id 是一个字符串，用以表示该选区子类，这个标识符需要是唯一的且有区分度（不容易与其他模块序列化为 JSON 对象时的名称冲突）；第二个参数是对应的选区子类
  这个标识符会用于将选区子类序列化为 JSON 对象时，作为 JSON 对象的属性 type 的值。这样在调用上一个静态方法 Selection.fromJSON() 时，ProseMirror 会基于标识符将 JSON 对象反序列化为对应的选区示例

该类给出了一些抽象方法和具体的方法：

• $anchor 属性：一个 resolvedPos 对象，表示该选区的锚点，选区锚定「不动」的一端，即框选开始时光标的位置
• $head 属性：一个 resolvedPos 对象，表示该选区的动点，即框选结束时光标的位置，如果选区变化会在这一侧发生
• ranges 属性：一个数组（一般仅含有一个元素的），该元素是一个 SelectionRange 对象，它表示选区所对应于文档中的范围
• anchor 属性：一个数字（符合 index schema 规则，表示文档的位置），表示该选区的锚点的位置
• head 属性：一个数字（符合 index schema 规则，表示文档的位置），表示该选区的动点的位置
• $from 属性：一个 resolvedPos 对象，表示该选区所覆盖的文档范围的 lower boundary 下界（在文档中较前的位置）
• $to 属性：一个 resolvedPos 对象，表示该选区所覆盖的文档范围的 upper boundary 上界（在文档中较后的位置）
• from 属性：一个数字（符合 index schema 规则，表示文档的位置），表示该选区所覆盖的文档范围的 lower boundary 下界的位置
• to 属性：一个数字（符合 index schema 规则，表示文档的位置），表示该选区所覆盖的文档范围的 upper boundary 上界的位置
• empty 属性：一个布尔值，表示该选区是否包含内容
• abstract eq(selection) 抽象方法：返回一个布尔值，表示当前选区与给定的选区 selection 是否相等
• abstract map(doc, mapping) 抽象方法：通过一个 mapping mappable 对象将选区映射到新文档 doc 上（doc 是一个节点对象，根节点，表示一个文档），返回映射后的选区对象
  提示

  可以通过 tr.doc 获取到新文档

• content() 方法：获取该选区的内容，并构建为一个 slice 切片对象
• replace(tr, content?) 方法：用给定的内容 content（一个 slice 切片对象）替换当前选区（选中的内容）。如果第二个（可选）参数 content 没有指定，则将当前选区删除。该操作步骤会 append 添加到给定的 tr 事务中
  替换后的光标位置

  替换后会自动将新的选区（光标状态）设置在插入的内容的后面。

  如果插入的内容是一个 inline 节点，则该节点后面（向右）寻找合适的选区位置。如果不是 inline 节点，则向左寻找。

• replaceWith(tr, node) 方法：用给定的 node 节点对象替代当前选区（选中的内容）。该操作步骤会 append 添加到给定的 tr 事务中
  提示

  对于编辑器存在多个选区范围的情况，如果调用以上方法替换选中的内容，则除了第一个选区范围会替换插入给定的节点，而其他选区范围所选中的内容都会被删除掉

  而替换操作采用的是 transform 对象的方法 replaceRangeWith 实现的，ProseMirror 可能会自动调整替换范围（例如当选区的 from 和 to 相同且都位于父级节点的起始或结尾位置，而给定的 node 并不适合此位置时，则可能将给定的 node 放置到合适的祖先节点里，以满足 schema 的约束）

• abstract toJSON() 抽象方法：将选区转换为 JSON 对象。
  提示

  在子类中给出该方法的具体实现时，需要确保生成的 JSON 对象中具有属性 type 它值是该选区子类的 jsonID（使用方法 Selection.jsonID() 所注册的唯一 ID），以表示该 JSON 对象代表哪一种 Selection 子类

  例如 ProseMirror 的内置选区子类 TextSelection 文本选区，调用其 toJSON() 方法获得的 JSON 对象会包含一个 type 属性，其值是 text，因为该内置选区子类在注册时将其 ID 设置为 Selection.jsonID("text", TextSelection)

• getBookmark() 方法：获取该选区的标签，返回一个对象（它符合一种 TypeScript interface SelectionBookmark）来表示该选区，将其看作是选区的一个更「轻量级」的替代者，以便保存到历史记录中
  SelectionBookmark

  TypeScript interface SelectionBookmark 用于约束一个对象，它作为选区的标签，可以将其理解为选区的一个「替身」，一般用于实现编辑器的历史记录功能，追踪选区的变化和恢复选区。该对象需要具有以下属性和方法

  • map(mapping) 方法：通过一个位置映射管道 mapping 的处理，更新当前的选区标签，返回一个经过映射的 selectionBookmark 对象
  • resolve(doc) 方法：将该选区标签解析为给定文档 doc（一个节点对象，根节点，表示文档）的一个选区对象
    注意

    在该方法的具体实现代码里，可能需要做一些错误检查，因为经过位置映射管道 mapping 映射处理，如果该选区标签变得不可用的话，则需要为该解析操作设置 fall back 后备方案，通常将文本选区的静态方法 TextSelection.between() 所生成的文本选区，作为标签解析所得的默认选区

  该对象可以让选区信息更易于存储，而且可以在不直接访问 doc 文档内容的情况下对其进行映射转换，然后在需要时可以在给定的文档中将标签 resolve 解析为真正的选区。

  
  该方法默认实现是将当前选区先转换为一个文本选区，然后调用文本选区的相应方法生成标签。也可以为不同类型的选区子类自定义该方法，以生成不同的标签，让历史记录支持存储更丰富的选区类型
• visible 属性：一个布尔值，以控制在创建该类型的选区时，是否对用户可见，默认值为 true

ProseMirror 支持插件系统来扩展编辑器的功能。

它是 state 编辑器状态对象的一部分，可以影响编辑器的 state 和 view（即为编辑器状态添加额外的字段，以及控制视图如何响应用户操作）

通过 new Plugin(spec) 实例化一个插件对象，其中配置参数 spec 是一个对象（它需要符合一种 TypeScript interface PluginSpec）

Plugin 类的实例化对象表示一个 plugin 对象，以下称作「插件对象」

const myPlugin = new Plugin({
  props: {
    handleKeyDown(view, event) {
      console.log("A key was pressed!")
      return false // We did not handle this
    }
  }
});

const state = EditorState.create({schema, plugins: [myPlugin]});

// 或者在实例化编辑器视图 view 时添加插件
// const view = new EditorView(editorContainerDOM, {
//   plugins: [myPlugin]
// });

plugin 插件对象包含一些属性和方法：

• spec 属性：一个对象（它符合一种 TypeScript interface PluginSpec），表示该插件的详细配置
• props 属性：一个对象（它符合一种 TypeScript interface EditorProps），该插件对于编辑器视图的配置（就是在 spec.props 里设置的一系列事件处理函数）
• getState(state) 方法：获取该插件的特有的状态（该值是从编辑器的状态对象中抽取的，由于插件的状态也是编辑器状态对象的一部分）。入参 state 是编辑器状态对象