メインコンテンツまでスキップ

はじめに

OhashiRichTextEditor は、Web Components と Shadow DOM で作られた Laravel 向けのリッチテキストエディタです。エディタが作る HTML をサーバー側で無害化する仕組みまで、同じ Composer パッケージに入っています。

開発中

v1.0 はまだリリースされていません。v0.1.0 は先行版です。このマニュアルには、現在動くものと、これから提供するものを区別して書いています。1.0 までは名前(属性・::part()・CSS 変数・イベント)が変わることがあります。

目指していること​

  • ページ上の何にも壊されない。 エディタは独自の Shadow DOM の中にあり、ページ側の CSS セレクタやスクリプト(jQuery・Bootstrap・Inertia の画面遷移)は内部に届きません。
  • 保存から表示まで安全な HTML。 保存・表示する HTML は HTML5 パーサを使うサーバー側サニタイザを通り、ブラウザ側でも保存済みの内容を表示前に無害化します。
  • 日本語 IME で快適に打てる(v1.0)。変換確定の Enter で改行やリストが暴発しないようにします。
  • composer require ひとつで完結。無害化と画像アップロードまで含みます。Blade で使う場合、Node.js は不要です。

現在の状態​

機能状態
<ohashi-rich-text-editor> 要素(Shadow DOM・フォーム送信・SSR 対応)提供中
Blade コンポーネント <x-ohashi-editor>提供中
Inertia 用の Vue 3 / React ラッパー提供中
サーバー側サニタイザ・SanitizedHtml Cast・<x-ohashi-content>提供中
CSS カスタムプロパティと ::part() によるテーマ調整提供中
Undo/Redo(Ctrl/Cmd+Z・Ctrl/Cmd+Shift+Z)。エディタ独自の履歴提供中
貼り付け・ドラッグ&ドロップ時の無害化と整形。編集を繰り返しても増えない HTML提供中
IME: 変換中にエディタが入力を乱さない提供中(Linux / Chrome と macOS / Safari で確認済み。Windows は未確認 — 対応ブラウザ)
ツールバー: 太字・斜体・打ち消し線・見出し・引用・リスト・リンク・コードブロック。キーボードショートカット。英語と日本語提供中
画像アップロード(ボタン・貼り付け・ドラッグ&ドロップ、幅のプリセットと代替テキスト)とエディタ内のエラー表示提供中
Livewire 連携(wire:model・.live・再描画・wire:navigate。Livewire 3 / 4)提供中
表・HTML ソース編集・HTML 文法チェックv1.1

次に読むページ​