在 React 中使用 TipTap 构建 RichText 编辑器（带提及）-js教程-PHP中文网

在 React 中使用 TipTap 构建 RichText 编辑器（带提及）

Barbara Streisand

发布： 2024-11-25 11:48:15

原创

693 人浏览过

Building a RichText Editor with TipTap in React (with Mentions)

如果您想使用功能强大、可自定义的 RichText 编辑器增强您的 React 应用程序，TipTap 是一个绝佳的选择。本教程将指导您将 TipTap 集成到您的项目中并添加提及功能以获得动态用户体验。

你将构建什么

在本教程结束时，您将拥有：

使用 TipTap 构建的功能齐全的 RichText 编辑器。
支持@触发的提及，并配有动态建议列表。
深入了解解决占位符可见性和光标保留等边缘情况。

有关 TipTap 的更多信息，请访问官方文档或探索他们的 GitHub 存储库。

第 1 步：安装依赖项
在深入之前，请安装所需的库：

npm install @tiptap/react @tiptap/starter-kit @tiptap/extension-mention

登录后复制

第 2 步：创建基本 RichText 编辑器

首先创建一个 RichTextEditor 组件。这是一个简单的实现：

import { useEditor, EditorContent } from '@tiptap/react';  

import StarterKit from '@tiptap/starter-kit';  

export const RichTextEditor = ({ content, onChange }) => {  
  const editor = useEditor({  
    extensions: [StarterKit],  
    content: content,  
    onUpdate: ({ editor }) => {  
      onChange(editor.getHTML());  
    },  
  });  
  return <EditorContent editor={editor} />;  
};

登录后复制

第 3 步：添加提及

提及增强了用户交互性，尤其是在聊天或协作应用程序中。实施它们：

安装并配置提及扩展

修改 RichTextEditor 组件以包含 Mention 扩展：

import Mention from '@tiptap/extension-mention';  

export const RichTextEditor = ({ content, onChange, mentions }) => {  
  const editor = useEditor({  
    extensions: [  
      StarterKit,  
      Mention.configure({  
        HTMLAttributes: { class: 'mention' },  
        suggestion: {  
          items: ({ query }) =>  
            mentions.filter(item => item.display.toLowerCase().includes(query.toLowerCase())).slice(0, 5),  
          render: () => {  
            let component;  
            let popup;  
            return {  
              onStart: (props) => {  
                popup = document.createElement('div');  
                popup.className = 'mention-popup';  
                document.body.appendChild(popup);  
                component = {  
                  updateProps: () => {  
                    popup.innerHTML = `  
                      <div>



<h3>
  
  
  Step 4: Style the Mentions Popup
</h3>

<p>Mentions should be visually distinct. Add the following styles to enhance usability:<br>
</p>

<pre class="brush:php;toolbar:false">.mention-popup {  
  background: white;  
  border-radius: 8px;  
  box-shadow: 0px 2px 8px rgba(0, 0, 0, 0.1);  
  padding: 8px;  
  position: absolute;  
  z-index: 1000;  
}  
.mention-popup .items {  
  display: flex;  
  flex-direction: column;  
}  
.mention-popup .item {  
  padding: 8px;  
  cursor: pointer;  
  border-radius: 4px;  
}  

.mention-popup .item:hover,  
.mention-popup .item.is-selected {  
  background: #f0f0f0;  
}

登录后复制

第 5 步：我在实施过程中遇到的极端情况

光标跳跃：为了避免打字时光标跳跃，请确保内容更新保留光标的位置：

const editor = useEditor({  
  extensions: [StarterKit],  
  content,  
  onUpdate: ({ editor }) => {  
    const selection = editor.state.selection;  
    onChange(editor.getHTML());  
    editor.commands.setTextSelection(selection);  
  },  
});

登录后复制

占位符不可见：

使用占位符扩展在编辑器为空时显示提示：

import Placeholder from '@tiptap/extension-placeholder';  
const editor = useEditor({  
  extensions: [  
    StarterKit,  
    Placeholder.configure({ placeholder: 'Type something...' }),  
  ],  
});

登录后复制

未显示的提及建议：检查 suggest.items 方法以确保它过滤并返回预期的列表。

第 6 步：集成到您的应用程序中

将编辑器包装在模式或表单组件中，使其成为更大功能的一部分，例如通知或评论。这是一个例子：

import React from 'react';  

const NotificationForm = ({ mentions, onSubmit }) => {  
  const [content, setContent] = React.useState('');  
  return (  
    <form onSubmit={() => onSubmit(content)}>  
      <RichTextEditor content={content} onChange={setContent} mentions={mentions} />  
      <button type="submit">Send</button>  
    </form> 
  );  
};

登录后复制