首页
/ 在UmiJS项目中正确使用Tiptap富文本编辑器

在UmiJS项目中正确使用Tiptap富文本编辑器

2025-05-05 19:14:53作者:俞予舒Fleming

Tiptap是一个基于ProseMirror的现代化富文本编辑器框架,提供了React、Vue等前端框架的封装。本文将详细介绍如何在UmiJS项目中正确集成Tiptap编辑器,并解决常见的配置问题。

常见错误分析

许多开发者在UmiJS项目中初次使用Tiptap时,会遇到"Schema is missing its top node type ('doc')"的错误。这个错误的核心原因是编辑器实例没有正确配置必要的扩展(extensions)。

解决方案

要解决这个问题,必须为编辑器提供至少一个文档节点类型和基本扩展。以下是完整的配置示例:

import { useEditor, EditorContent } from '@tiptap/react'
import StarterKit from '@tiptap/starter-kit'

const MarkdownEditor = () => {
    const editor = useEditor({
        extensions: [
            StarterKit,
        ],
        content: '<p>Hello World!</p>',
    })
    
    return (
        <EditorContent editor={editor} />
    )
}

关键配置说明

  1. StarterKit扩展:这是Tiptap提供的一个基础扩展包,包含了文档节点、段落、标题等基本功能
  2. content属性:设置编辑器的初始内容,可以是HTML字符串或JSON格式
  3. extensions数组:必须至少包含一个文档节点类型的扩展

进阶配置建议

在实际项目中,你可能需要添加更多功能:

import { useEditor, EditorContent } from '@tiptap/react'
import StarterKit from '@tiptap/starter-kit'
import Underline from '@tiptap/extension-underline'
import Link from '@tiptap/extension-link'

const RichTextEditor = () => {
    const editor = useEditor({
        extensions: [
            StarterKit,
            Underline,
            Link.configure({
                openOnClick: false,
            }),
        ],
        content: '<p>开始编辑你的内容...</p>',
    })
    
    return <EditorContent editor={editor} />
}

注意事项

  1. 确保已安装所有必要的依赖包,包括@tiptap/react和@tiptap/starter-kit
  2. 在UmiJS项目中,可能需要检查构建配置以确保ProseMirror相关代码能正确打包
  3. 对于复杂的编辑器需求,可以考虑自定义节点和扩展

通过以上配置,你就可以在UmiJS项目中顺利使用Tiptap富文本编辑器了。根据项目需求,你可以进一步探索Tiptap提供的各种扩展和自定义功能。

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

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
860
511
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
259
300
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
596
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K