首页
/ Plate核心库重大更新:渲染组件API重构与编辑器初始化优化

Plate核心库重大更新:渲染组件API重构与编辑器初始化优化

2025-06-03 00:43:30作者:魏献源Searcher

Plate是一个基于Slate的富文本编辑器框架,提供了高度可定制化的组件和插件系统。本次发布的@udecode/plate-core@48.0.0版本带来了两项重要变更:渲染组件API的重大重构和编辑器初始化流程的优化。

渲染组件API重构

本次更新对PlateElement、PlateLeaf和PlateText等核心渲染组件进行了彻底的重构,主要变化包括:

属性传递方式变更

HTML属性现在统一通过attributes属性传递,而不是直接作为组件的顶级属性。这种变更使得属性传递更加规范化,与Slate的渲染模式保持一致。

迁移示例:

// 旧版写法
<PlateElement {...props} ref={ref} contentEditable={false}>
  {children}
</PlateElement>

// 新版写法
<PlateElement
  {...props}
  ref={ref}
  attributes={{
    ...props.attributes,
    contentEditable: false,
  }}
>
  {children}
</PlateElement>

简化属性配置

移除了nodeProps属性,将其功能合并到attributes中。同时,插件中的node.props配置现在直接返回属性对象,不再需要嵌套在nodeProps对象中。

// 旧版配置
node: {
  props: ({ element }) => ({
    nodeProps: {
      colSpan: element?.attributes?.colspan,
      rowSpan: element?.attributes?.rowspan,
    },
  });
}

// 新版配置
node: {
  props: ({ element }) => ({
    colSpan: element?.attributes?.colspan,
    rowSpan: element?.attributes?.rowspan,
  });
}

组件简化

移除了asChild属性,统一使用as属性来指定渲染组件。同时移除了elementToAttributesleafToAttributestextToAttributes等属性,简化了组件API。

类型定义优化

移除了PlateRenderElementPropsPlateRenderLeafPropsPlateRenderTextProps等类型,统一使用PlateElementPropsPlateLeafPropsPlateTextProps作为标准类型。

编辑器初始化流程优化

本次更新还改进了编辑器的初始化流程,增加了更多控制选项:

新增组件覆盖选项

createPlateEditorusePlateEditor现在支持通过components选项直接覆盖编辑器组件,这是对原有override.components的简化别名。

延迟初始化支持

新增skipInitialization选项,允许开发者跳过编辑器的初始设置流程(包括设置初始children、selection以及规范化初始值)。这在需要手动控制初始化时机的高级场景中非常有用。

新增API方法

新增了editor.api.shouldNormalizeNode方法,用于控制何时应该执行规范化操作。这在编辑器尚未准备好时特别有用,可以避免不必要的规范化操作。

新增初始化转换

新增了editor.tf.init转换方法,专门用于执行编辑器的初始化工作。当使用skipInitialization选项时,开发者可以手动调用此方法来触发初始化流程。

升级建议

对于现有项目,升级到48.0.0版本需要进行以下调整:

  1. 检查所有使用PlateElement、PlateLeaf和PlateText的地方,按照新的属性传递方式进行修改
  2. 更新插件配置中的node.props定义,移除nodeProps包装
  3. 如果使用了延迟初始化功能,确保在适当的时候调用editor.tf.init
  4. 更新类型引用,使用新的标准类型名称

这些变更虽然需要一定的迁移工作,但将带来更一致、更灵活的API设计,为未来的功能扩展打下更好的基础。

登录后查看全文
热门项目推荐
相关项目推荐