🐱

tiptap でリッチテキストエディタ実装

2022/12/18に公開約12,200字

はじめに

今回はTypeScript製のリッチテキストエディタ(tiptap)とReact Hook Formで入力値の取得を行います。

tiptapとは

https://tiptap.dev/

  • WYSIWYGエディタを作成できるライブラリ.
  • 標準でエディタにスタイリングされていないため、UIを自由に実装できます.
  • リアルタイム同時編集対応.
  • Markdown shortcuts があるので、キー入力にMarkdown記法を使うことはできます.
  • TypeScript対応.

React Hook Formとは

https://www.react-hook-form.com/

  • 使いやすさに重点を置いた、React用の高性能なフォームバリデーションライブラリ.
  • コンポーネントの再レンダリングが少なく、パフォーマンスに優れた作りとなっています.
  • useFormというカスタムフックを提供します.useFormから得られるメソッドやステートを使ってフォームの設定や値の取得を行います。
    • useForm: フォームを作成する
    • register: 入力フィールドを登録する
    • handleSubmit: 送信を受け取って処理する
    • formState: フォームのエラー状態や入力状態を検知する
    • getValues: その時点のフォームの値を取得
    • watch: 最新のフォーム値を取得

今回実装したもの

https://rich-text-editor-rho.vercel.app/

導入

Next.js(typeScript)

https://nextjs.org/docs#automatic-setup

Tailwind CSS

https://tailwindcss.com/docs/guides/nextjs

React Hook Form

https://www.react-hook-form.com/get-started

tiptap

https://tiptap.dev/installation/nextjs#2-install-the-dependencies

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

@tiptap/react: tiptapをReact(Next.js)で使用するためのパッケージ
@tiptap/starter-kit: エディタを構築する際に使用する主要な機能のパッケージを集めたスターターキット

ハンズオン

tiptapエディタを表示するコンポーネント作成

components/editor.tsx
import React from "react";
import { EditorContent, useEditor } from "@tiptap/react";
import StarterKit from "@tiptap/starter-kit";
import RichEditorToolbar from "./rich-editor-toolbar";

const Editor = () => {
  const editor = useEditor({
    extensions: [StarterKit],
    content: "<p>Hello World! 🌎️</p>",
    editorProps: {
      attributes: {
        class: "prose prose-base m-5 focus:outline-none text-left",
      },
    },
  });

  if (!editor) {
    return null;
  }

  return (
    <div className="w-2/3 mt-10 mx-auto border-gray-500 border-2">
        <RichEditorToolbar editor={editor} />
        <div className="p-3 overflow-y-scroll h-[70vh] overflow-hidden mt-3">
            <EditorContent editor={editor} />
        </div>
    </div>
  );
};

export default Editor;
  • useEditorを使用してEditorクラスのインスタンスを作成し、実装するエディタの設定を行います.
  • contentには初期値としてエディタに表示したいHTMLを記述します.
  • editorProps<EditorContent /> にクラス名を付与しています.
  • extensionsにはエディタに追加したい機能(パッケージ)を記述します。こちらには、先ほどインストールしたStarterkitを追加します。

Starterkitについて

Starterkitは主要な機能のパッケージを集めたもので、これを extentions に追加するだけで下記の機能を使用できます。

  • Blockquote : <blockquote>タグを使用できる
  • BulletList : <ul>タグを使用できる
  • CodeBlock : <pre>と<code>タグによるコードブロックを使用できる
  • Document : <body>タグのようなもの
  • Heading : <h1>〜<h6>タグを使用できる
  • HorizonalRule : <hr>タグを使用できる
  • ListItem : <li>タグを使用できる
  • OrderedList : <ol>タグを使用できる
  • Paragraph : 段落を扱うために必要
  • Text : 何らかのテキストを扱う場合に必要
  • Bold : テキストを太字にする
  • Code : <code>タグを使用できる
  • Italic : テキストを斜体で表示する
  • Strike : テキストに打ち消し線を引く
  • History : エディタ編集の履歴をサポートする

Starterkit以外の機能カスタムも可能

Starterkit以外の機能をつけたい場合は、下記を参考にカスタムも可能です。
https://tiptap.dev/extensions

components/editor.tsx
const editor = useEditor({
    extensions: [
      StarterKit,
      TaskItem.configure({
        nested: true,
      }),
      TaskList,
      Link.configure({
        openOnClick: true,
      }),
      CodeBlockLowlight.configure({
        lowlight,
      }),
      Placeholder.configure({
        placeholder: "Write something …",
      }),
    ],
    content: "",
    editorProps: {
      attributes: {
        class: "prose prose-base m-5 focus:outline-none text-left",
      },
    },
  });

コマンドメニューを追加

次に、ボタンのクリックによりh1やリスト、コードブロックなどを表示できるように実装していきます。

components/rich-editor-toolbar.tsx
import { Editor } from "@tiptap/react";
import { useCallback } from "react";
import { AiOutlineLink } from "react-icons/ai";
import {
  MdCode,
  MdFormatBold,
  MdFormatListBulleted,
  MdFormatListNumbered,
  MdFormatQuote,
  MdFormatStrikethrough,
  MdRedo,
  MdTaskAlt,
  MdTitle,
  MdUndo,
} from "react-icons/md";

const RichEditorToolbar = ({ editor }: { editor: Editor }) => {
  const setLink = useCallback(() => {
    const previousUrl = editor.getAttributes("link").href;
    const url = window.prompt("URL", previousUrl);
    // cancelled
    if (url === null) {
      return;
    }
    // empty
    if (url === "") {
      editor.chain().focus().extendMarkRange("link").unsetLink().run();

      return;
    }
    // update link
    editor.chain().focus().extendMarkRange("link").setLink({ href: url }).run();
  }, [editor]);

  if (!editor) {
    return null;
  }

  return (
    <div className="flex flex-wrap gap-2 border-b border-gray-600 p-4 text-2xl">
      <button
        type="button"
        onClick={() => editor.chain().focus().toggleHeading({ level: 1 }).run()}
        className={
          !editor.isActive("heading", { level: 1 }) ? "opacity-20" : ""
        }
      >
        <MdTitle />
      </button>
      <button
        type="button"
        onClick={() => editor.chain().focus().toggleBold().run()}
        className={!editor.isActive("bold") ? "opacity-20" : ""}
      >
        <MdFormatBold />
      </button>
      <button
        type="button"
        onClick={() => editor.chain().focus().toggleStrike().run()}
        className={!editor.isActive("strike") ? "opacity-20" : ""}
      >
        <MdFormatStrikethrough />
      </button>
      <button
        type="button"
        onClick={() => editor.chain().focus().toggleTaskList().run()}
        className={!editor.isActive("taskList") ? "opacity-20" : ""}
      >
        <MdTaskAlt />
      </button>
      <button
        type="button"
        onClick={() => editor.chain().focus().toggleCodeBlock().run()}
        className={!editor.isActive("codeBlock") ? "opacity-20" : ""}
      >
        <MdCode />
      </button>
      <button
        type="button"
        onClick={() => editor.chain().focus().toggleBulletList().run()}
        className={!editor.isActive("bulletList") ? "opacity-20" : ""}
      >
        <MdFormatListBulleted />
      </button>
      <button
        type="button"
        onClick={() => editor.chain().focus().toggleOrderedList().run()}
        className={!editor.isActive("orderedList") ? "opacity-20" : ""}
      >
        <MdFormatListNumbered />
      </button>
      <button
        type="button"
        onClick={() => editor.chain().focus().toggleBlockquote().run()}
        className={!editor.isActive("blockquote") ? "opacity-20" : ""}
      >
        <MdFormatQuote />
      </button>
      <button
        type="button"
        onClick={setLink}
        className={!editor.isActive("link") ? "opacity-20" : ""}
      >
        <AiOutlineLink />
      </button>

      <button onClick={() => editor.chain().focus().undo().run()} type="button">
        <MdUndo />
      </button>
      <button onClick={() => editor.chain().focus().redo().run()} type="button">
        <MdRedo />
      </button>
    </div>
  );
};

export default RichEditorToolbar;

ボタンがクリックされたときにeditorから複数のコマンド(メソッド)を実行しています.

CSSでスタイリング

今回はSassを使ってスタイリングしていきます.

npm i sass --dev
styles/editor.scss
.ProseMirror {
  > * + * {
    margin-top: 0.75em;
  }

  ul {
    padding: 0 1rem;
    list-style: disc;
  }

  ol {
    padding: 0 1rem;
    list-style: decimal;
  }

  h1 {
    line-height: 1.1;
    font-size: x-large;
    font-weight: 600;
  }

  code {
    background-color: rgba(#616161, 0.1);
    color: #616161;
  }

  pre {
    background: #0d0d0d;
    border-radius: 0.5rem;
    color: #fff;
    font-family: "JetBrainsMono", monospace;
    padding: 0.75rem 1rem;

    code {
      background: none;
      color: inherit;
      font-size: 0.8rem;
      padding: 0;
    }

    .hljs-comment,
    .hljs-quote {
      color: #616161;
    }

    .hljs-variable,
    .hljs-template-variable,
    .hljs-attribute,
    .hljs-tag,
    .hljs-name,
    .hljs-regexp,
    .hljs-link,
    .hljs-name,
    .hljs-selector-id,
    .hljs-selector-class {
      color: #f98181;
    }

    .hljs-number,
    .hljs-meta,
    .hljs-built_in,
    .hljs-builtin-name,
    .hljs-literal,
    .hljs-type,
    .hljs-params {
      color: #fbbc88;
    }

    .hljs-string,
    .hljs-symbol,
    .hljs-bullet {
      color: #b9f18d;
    }

    .hljs-title,
    .hljs-section {
      color: #faf594;
    }

    .hljs-keyword,
    .hljs-selector-tag {
      color: #70cff8;
    }

    .hljs-emphasis {
      font-style: italic;
    }

    .hljs-strong {
      font-weight: 700;
    }
  }

  blockquote {
    padding-left: 1rem;
    border-left: 2px solid rgba(#0d0d0d, 0.1);
  }

  hr {
    border: none;
    border-top: 2px solid rgba(#0d0d0d, 0.1);
    margin: 2rem 0;
  }
  a {
    color: #68cef8;
    text-decoration: underline;
    cursor: pointer;
  }
}

ul[data-type="taskList"] {
  list-style: none;
  padding: 0;

  p {
    margin: 0;
  }

  li {
    display: flex;

    > label {
      flex: 0 0 auto;
      margin-right: 0.5rem;
      user-select: none;
    }

    > div {
      flex: 1 1 auto;
    }
  }
}
/* Placeholder (at the top) */
.ProseMirror p.is-editor-empty:first-child::before {
  color: #adb5bd;
  content: attr(data-placeholder);
  float: left;
  height: 0;
  pointer-events: none;
}
styles/globals.scss
@tailwind base;
@tailwind components;
@tailwind utilities;

@import "./editor.scss";

Next.jsを起動

ここまで実装すれば、下記のようなエディタが表示されます.
Markdown shortcutsによるキー入力で様々なノードやマークを作成できます.
例として、-+スペースでリストが作成されます.

React Hook Form実装

最後に,React Hook Formを使ってエディタに入力された値を取得します。

フォームの作成

まずはフォームを作成します。

const Editor = () => {
  //フォームの作成
  const { handleSubmit, setValue } = useForm();

export default Editor;

フィールドの登録

フォームに含まれるインプットやテキストエリア、チェックボックスなどをフィールドと呼びます.{...register('フィールド名', バリデーション)} のフォーマットでフィールドを登録できます.フィールドをフォームに登録することで値の検知やエラーの判断が可能になります

サンプル
<label>
  名前
  <input
    type="text"
    required
    autoComplete="name"
    {...register('name', {
      required: true,
      maxLength: 200,
    })}
  />
</label>

入力フォームが Tiptap や Material UI などの UIライブラリによって制御されているケースがあります。
今回のようなTiptapを使用した場合は、React Hook FormのsetValueとtiptapのonUpdateを組み合わせることで解決します。
また、値の種類を設定することが出来ます。
今回はJSON形式で値を取得します。

const editor = useEditor({
    extensions: [
      StarterKit,
      TaskItem.configure({
        nested: true,
      }),
      TaskList,
      Link.configure({
        openOnClick: true,
      }),
      CodeBlockLowlight.configure({
        lowlight,
      }),
      Placeholder.configure({
        placeholder: "Write something …",
      }),
    ],
    content: "",
    editorProps: {
      attributes: {
        class: "prose prose-base m-5 focus:outline-none text-left",
      },
    },
    //フィールドの登録
    onUpdate: ({ editor }) => {
      //JSONに変換
      const json = editor.getJSON();
      setValue("body", json);
    },
  });

送信の処理

以下のようにhandleSubmitを使うことで送信の制御ができます。
入力した値をconsoleで確認できます。


const submit = (data: any) => {
    console.log(data);
  };

<form onSubmit={handleSubmit(submit)}>
      <div className="flex-col justify-center items-center">
        <div className="w-2/3 mt-10 mx-auto border-gray-500 border-2">
          <RichEditorToolbar editor={editor} />
          <div className="p-3 overflow-y-scroll h-[70vh] overflow-hidden mt-3">
            <EditorContent editor={editor} />
          </div>
        </div>
        <div className="rounded-full bg-gray-400 px-5 py-3 font-bold text-white shadow w-1/4 mx-auto text-center mt-5 text-2xl">
          <button>Submit</button>
        </div>
      </div>
    </form>

まとめ

TypeScript製のリッチテキストエディタtiptapとReact Hook Formの使い方について解説しました。
公式ドキュメントには他にも色々な機能が説明されていますので是非ご確認ください。

プロダクトのgit hubはこちら
https://github.com/kodaishiotsuki/rich-text-editor

Discussion

ログインするとコメントできます