Plate 编辑器

PreviousNext

Plate 编辑器的 API 参考文档。

一个自定义编辑器接口，扩展了基础的 Editor 接口，并包含 Plate 库特有的额外属性和方法。

核心属性

Attributes

  • id any

    编辑器的唯一标识符。

  • dom object

    包含编辑器 DOM 状态的对象。

  • plugins Record<string, AnyEditorPlatePlugin>

    按插件键名索引的插件记录。

  • meta object

    包含编辑器元数据的对象，通常来自插件或编辑器配置。

API 方法

Methods

Collapse all

  • getApi (plugin: PlatePlugin) => EditorApi & PlatePlugin['api']

    获取插件的类型化 API。

  • getTransforms (plugin: PlatePlugin) => EditorTransforms & PlatePlugin['transforms']

    获取插件的类型化转换方法。

  • getPlugin (plugin: PlatePlugin) => PlatePlugin

    通过键名或基础插件获取编辑器插件实例。

  • getType (plugin: PlatePlugin) => string

    获取与插件关联的节点类型。

  • init (options: InitOptions) => Promise<void>

    初始化编辑器值、选择和规范化。接受自动选择、选择、规范化和值的选项。

选项方法

Methods

Collapse all

  • getOption (plugin: PlatePlugin, optionKey: string) => any

    获取插件的特定选项值。

  • getOptions (plugin: PlatePlugin) => any

    获取插件的所有选项。

  • setOption (plugin: PlatePlugin, optionKey: string, value: any) => void

    设置插件的特定选项值。

  • setOptions (plugin: PlatePlugin, options: (draft: object) => void | Partial<object>) => void

    设置插件的多个选项。

  • getOptionsStore (plugin: PlatePlugin) => any

    获取插件的 zustand-x 选项存储。

核心插件 API

DebugPlugin

API

Collapse all

  • editor.api.debug.log (...args: any[]) => void

    在 'log' 级别记录消息。

  • editor.api.debug.info (...args: any[]) => void

    在 'info' 级别记录消息。

  • editor.api.debug.warn (...args: any[]) => void

    在 'warn' 级别记录消息。

  • editor.api.debug.error (...args: any[]) => void

    在 'error' 级别记录消息。

HtmlPlugin

API

Collapse all

  • editor.api.html.deserialize (options: { element: HTMLElement }) => Descendant[]

    将 HTML 内容反序列化为 Plate 节点。

ReactPlugin

Transforms

Collapse all

  • editor.tf.reset () => void

    重置编辑器状态，如果编辑器之前有焦点则保持焦点。

SlateReactExtensionPlugin

API

Collapse all

  • editor.api.redecorate () => void

    重新装饰编辑器。

Transforms

Collapse all

  • editor.tf.setValue (value: Value) => void

    替换编辑器值。更多信息请参阅受控值。

Plate ControllerPlate Editor