ModaEditor — リッチエディタ

ヘッドレスエディタコア — React/Vue/Svelte/vanilla。

不変JSON ASTドキュメントとトランザクション更新で作る、フレームワーク非依存ヘッドレスリッチテキストエディタ。

ドキュメントモデル・トランザクション・選択・入力バインディングなど全エディタロジックを純粋TypeScriptコアに置き、各フレームワークアダプタは薄い反応バインディングのみ。5つのレンダラーが同じDOM契約を作りどこでも同じ動作です。

スターターバンドル1つで書式・見出し・引用・リスト・タスク・表・コードブロック・リンク・画像・整列・履歴まで揃い、Extension/Plugin/InputRuleで無限に拡張できます。

無料 (MIT)React · Vue 3 · Vue 2.7 · Svelte 5 · Vanilla不変EditorState・トランザクションTypeScript

ライブデモ

CDNから読み込んだ実際のコアで動作します。ツールバーの各ボタンは editor.commands.* 呼び出しと1:1対応(ツールチップにAPI名表示)し、編集のたびにHTMLシリアライズとドキュメントJSONが下パネルにリアルタイム出力されます。下部には editor.on() で購読したイベントが流れます。

環境別パッケージ

使用環境パッケージ備考
React@moda-editor/reactuseEditor + EditorView、カスタムノードビューはReactコンポーネント
Vue 3@moda-editor/vueuseEditor + EditorView SFC、useEditorStateで外部エディタ購読
Vue 2.7@moda-editor/vue2Vue 3と同じComposition API使い方
Svelte 5@moda-editor/sveltecreateEditorStore + EditorView、readableストア連動
純JS / CDNmoda-editor.jsビルドツールなしで<script>一行、window.ModaEditor
フレームワークなし@moda-editor/coreヘッドレスcreateEditor + mountEditor直接使用

npmでインストール

npm i @moda-editor/react # React
npm i @moda-editor/vue # Vue 3
npm i @moda-editor/vue2 # Vue 2.7
npm i @moda-editor/svelte # Svelte 5
npm i @moda-editor/core # ヘッドレスコアのみ
npmjs.com/package/@moda-editor/react →

CDNでそのまま使う

https://editor.modaolive.com/moda-editor.js
https://editor.modaolive.com/style.css

3ステップで開始

  1. 1

    パッケージインストール

    npm i @moda-editor/reactのようなアダプタをインストールするか、CDN <script>一行でコアをロードします。

  2. 2

    extensions渡し

    starterExtensions()一つでスキーマ・コマンド・キーマップ・入力ルール・履歴がすべて入ります。docで初期文書JSONを渡せます。

  3. 3

    レンダリング・操作

    アダプタは<EditorView>一つで完了。ツールバーはeditor.commands.*に接続し、vanillaはmountEditor(el, options)で配線します。

// npm i @moda-editor/react
import { EditorView, starterExtensions, useEditor } from "@moda-editor/react";
import "@moda-editor/react/styles.css";

function App() {
  const { editor, state } = useEditor({
    doc: myDoc,                       // DocNode JSON(省略時は空ドキュメント)
    extensions: starterExtensions(),  // スターターのスキーマ・コマンド・キーマップ・履歴
  });

  return (
    <>
      <button onClick={() => editor.commands.toggleBold()}>B</button>
      <button onClick={() => editor.commands.setHeading(2)}>H2</button>
      <EditorView editor={editor} />
    </>
  );
}
// stateは不変EditorState — ===比較で再レンダー要否を判定

EditorStateは不変です。変更まで同一参照を返すため、React useSyncExternalStoreのスナップショット契約が構造的に保証されます。

機能別の使い方 — 何を使えばいいか

全機能はコアのコマンド・オプションで動作しアダプタは伝達のみ。ライブデモのツールバーボタンにマウスを載せると対応APIが表示されます。

書式 (インラインマーク)

機能有効化方法 (オプション/prop/入力)コアAPI
太字・斜体・下線ツールバー / Mod-B·I·Ucommands.toggleBold() / toggleItalic() / toggleUnderline()
取り消し線ツールバーボタンcommands.toggleStrike()
上付き・下付き—commands.toggleSuperscript() / toggleSubscript()
インラインコードツールバーボタンcommands.toggleCode()
マーク属性の変更—commands.setMarkAttr("link", { href })
書式クリア—clearFormat(starterヘルパー)

ブロック

機能有効化方法 (オプション/prop/入力)コアAPI
見出しツールバーボタンcommands.setHeading(1~6)
引用ツールバーボタンcommands.toggleQuote()
コードブロックtoggleCodeBlock — 言語選択を含むcommands.setCodeLanguage(lang) / highlightCode
水平線・ハードブレーク—commands.insertHorizontalRule() / insertHardBreak()
揃え揃えfeature登録時commands.setAlign("left"|"center"|"right")
ブロック分割・脱出Enter / Mod-EntersplitBlock / exitBlockコマンド

リスト・表

機能有効化方法 (オプション/prop/入力)コアAPI
箇条書き・番号リストツールバーボタンcommands.toggleBulletList() / toggleOrderedList()
タスクリストツールバーボタンcommands.toggleTaskList() / toggleTaskItem()
インデント・逆インデントTab / Shift-Tabcommands.sinkListItem() / liftListItem()
表挿入・行・列—commands.insertTable(r,c) / addTableRow / addTableColumn / deleteTable
セル移動表内でTabnextCell / prevCell

リンク・画像・貼り付け

機能有効化方法 (オプション/prop/入力)コアAPI
リンクツールバー / [テキスト](url)入力ルールcommands.setLink(href) / unsetLink()
画像URL挿入 / 貼り付け・ドロップcommands.insertImage(src, alt) / updateImage / deleteImage
画像アップロードフックonImageUploadオプション — File → URL非同期変換省略時はFileReader data URLで即挿入
HTML貼り付けサニタイズ自動 — script・on*・javascript:を除去parseHTML + sanitizeHTML内蔵パイプライン
Word・Google Docs貼り付け自動 — 外部ボールド混入・ラッパー平坦化を防止外部文書paste時に構造クリーンアップ+履歴スキップ
pasteイベント—editor.on("paste", ({html, text}) => …)

状態・イベント・履歴

機能有効化方法 (オプション/prop/入力)コアAPI
不変状態—editor.state — 変更まで同一参照
レンダー購読アダプタが自動接続editor.subscribe(fn) / getSnapshot()
意味イベント—editor.on("update"|"selectionUpdate"|"transaction"|"focus"|"blur"|"destroy")
元に戻す·やり直しstarterExtensionsにhistory含、Mod-Z / Mod-Shift-Zcommands.undo() / redo(), canUndo / canRedo
読み取り専用EditorOptions.editable: falsecontenteditableを切るシグナルとして使用
共同編集 (CRDT)bindCollab — @moda-editor/collab-yjssubscribe・apply経由のライフサイクルバインディング、Pointベースの位置マッピング
手動ディスパッチ—editor.dispatch(tr) — 全変更の単一入口

ドキュメント・拡張

機能有効化方法 (オプション/prop/入力)コアAPI
JSONドキュメントモデルdoc: DocNodeオプションcreateDoc(content) / createText(text, marks)
HTMLシリアライズ—serializeToHTML(doc, schema)
HTML → ドキュメント—parseHTML(html, schema) → createDoc(nodes)
カスタムノードビューEditorViewのnodeViews prop{ codeBlock: MyComponent } — NodeViewProps
拡張システムextensions配列Extension = nodes + marks + commands + keymap + inputRules + plugins
スターターバンドルextensions: starterExtensions()スキーマ・コマンド・キーマップ・入力ルール・履歴一括
テーマstyles.cssの--me-* CSS変数.me-* DOMクラス契約でカスタム

よく使うレシピ

コピーしてすぐ使えるコードスニペット。

ツールバーボタン接続

editor.commandsは拡張から集めたコマンドレジストリ — ボタンonClickに直結

<button onClick={() => editor.commands.toggleBold()}>B</button>
<button onClick={() => editor.commands.setHeading(2)}>H2</button>
<button onClick={() => editor.commands.toggleTaskList()}>{t.todoL}</button>
<button onClick={() => editor.commands.undo()}>↶</button>

// false返却 = 現在の選択では適用不可 → ボタン無効化シグナルに使用

自動保存 (updateイベント)

ドキュメント・選択が変わる度に発行 — デバウンスしてサーバへ送信

editor.on("update", ({ state, prevState }) => {
  if (state.doc === prevState.doc) return;  // 選択のみ変わった場合はスキップ
  scheduleSave(serializeToHTML(state.doc, editor.schema));
});

// またはドキュメントJSONをそのまま保存
const payload = JSON.stringify(state.doc);

HTML → ドキュメント読込

既存HTMLをパースして初期ドキュメントに — sanitizer内蔵で危険タグ除去

import { createEditor, createDoc, parseHTML, starterExtensions }
  from "@moda-editor/core";

const extensions = starterExtensions();
const boot = createEditor({ extensions });
const doc = createDoc(parseHTML(savedHtml, boot.schema));

const editor = createEditor({ extensions, doc });

画像アップロード

貼り付け・ドロップ・ファイル選択のFileをサーバアップロードURLに置換

useEditor({
  extensions: starterExtensions(),
  onImageUpload: async (file) => {
    const form = new FormData();
    form.append("file", file);
    const res = await fetch("/api/upload", { method: "POST", body: form });
    return (await res.json()).url;   // エディタがsrcとして挿入
  },
});

カスタムノードビュー (React)

特定ノードタイプのレンダリングを自コンポーネントに — contentに編集アウトレット描画

function CodeBlockView({ node, editor, path, content }: NodeViewProps) {
  return (
    <div className="my-codeblock">
      <select onChange={(e) =>
        editor.commands.setCodeLanguageAt(path, e.target.value)} />
      {content}   {/* 編集エリア — 必ずレンダーすること */}
    </div>
  );
}

<EditorView editor={editor} nodeViews={{ codeBlock: CodeBlockView }} />

イベントログ・外部連携

transactionはフィルタ前の全trを発行 — デバッグ・同期の最下層フック

editor.on("transaction", ({ tr, state }) => console.log(tr.steps));
editor.on("paste", ({ html, text }) => console.log(t.pasteL, text));
editor.on("blur",  () => saveDraft());
editor.on("destroy", () => cleanup());

// 外部で作ったエディタをビューに共有
const editor = createEditor({ extensions: starterExtensions() });
<EditorView editor={editor} />   // 購読はビューが処理

フレームワークが違っても動作は一つ

React・Vue・Svelte・Vanilla レンダラーはすべて同じDOM契約(.me-*クラス)を生成し、共通コンフォーマンススペック(runWidgetConformance)で検証されます。一つのプラットフォームで覚えたAPIとCSS変数(--me-*)は他でもそのまま使えます。

ソース・ドキュメント

github.com/park-taejoon/moda-editor-releases
  • プラットフォーム別ガイド — React / Vue 3 / Vue 2.7 / Svelte 5 / Vanilla
  • 機能ガイド — カスタムnodeViews・検索可能リスト例
  • テーマ — --me-* CSS変数・マイグレーションマッピング文書

使い方

ヘッドレスエディタコア — React/Vue/Svelte/vanilla。

rich text editor

関連ツール