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

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

2025-05-05 00:11:51作者:俞予舒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提供的各种扩展和自定义功能。

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

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
197
2.17 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
208
285
pytorchpytorch
Ascend Extension for PyTorch
Python
59
94
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
974
574
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
549
81
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
1.2 K
133