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

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

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

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

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
178
262
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
867
513
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
183
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
265
305
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
598
57
GitNextGitNext
基于可以运行在OpenHarmony的git,提供git客户端操作能力
ArkTS
10
3