React で TipTap を使用してリッチテキストエディターを構築する (メンション付き)-jsチュートリアル-php.cn

React で TipTap を使用してリッチテキストエディターを構築する (メンション付き)

Barbara Streisand

リリース： 2024-11-25 11:48:15

オリジナル

634 人が閲覧しました

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

強力でカスタマイズ可能なリッチテキストエディターで React アプリを強化したい場合は、TipTap が最適な選択肢です。このチュートリアルでは、TipTap をプロジェクトに統合し、動的なユーザーエクスペリエンスを実現するメンション機能を追加する方法を説明します。

構築するもの

このチュートリアルが終わるまでに、次のことができるようになります:

TipTap で構築された完全に機能するリッチテキストエディター。
@ によってトリガーされるメンションをサポートし、動的な提案リストを完備します。
プレースホルダーの表示やカーソルの保存などの特殊なケースの解決に関する洞察。

TipTap の詳細については、公式ドキュメントを参照するか、GitHub リポジトリを参照してください。

ステップ 1: 依存関係をインストールする
始める前に、必要なライブラリをインストールしてください:

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

ログイン後にコピー

ステップ 2: 基本的なリッチテキストエディターを作成する

まず、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...' }),  
  ],  
});

ログイン後にコピー

メンションの提案が表示されない: フィルタリングされ、期待どおりのリストが返されることを確認するには、suggestion.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> 
  );  
};

ログイン後にコピー