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

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

2025-06-03 15:23:44作者:魏献源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设计,为未来的功能扩展打下更好的基础。

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

项目优选

收起
kernelkernel
deepin linux kernel
C
27
11
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
472
3.49 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
65
19
flutter_flutterflutter_flutter
暂无简介
Dart
719
173
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
23
0
kernelkernel
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
213
86
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.27 K
696
rainbondrainbond
无需学习 Kubernetes 的容器平台,在 Kubernetes 上构建、部署、组装和管理应用,无需 K8s 专业知识,全流程图形化管理
Go
15
1
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
1