導入
動作要件
- PHP 8.4 以上(
ext-dom)。サーバー側サニタイザがブラウザと同じ規則で HTML を読むために、PHP 8.4 のネイティブ HTML5 パーサを使います。 - Laravel 12 または 13(Laravel 連携を使う場合。Blade コンポーネント・Cast・サービスプロバイダ)。エディタ本体とサニタイザは Laravel が無くても動きます。
- 画像アップロードには
ext-gd(画像のアップロード)。アップロードを無効にするなら不要です。
パッケージのインストール
composer require 2bo-velocity/ohashirichtexteditor
php artisan vendor:publish --tag=ohashi-editor-assets
2 行目で、ビルド済みのエディタ(JavaScript ファイル 1 つ)が public/vendor/ohashi-editor/ にコピーされます。パッケージを更新したら、もう一度実行してください。
既定の設定を変える場合は、設定ファイルも公開します。
php artisan vendor:publish --tag=ohashi-editor-config
Blade
<script type="module" src="{{ asset('vendor/ohashi-editor/ohashi-editor.js') }}"></script>
<form method="POST" action="{{ route('posts.store') }}">
@csrf
<x-ohashi-editor name="body" :value="old('body', $post->body)" label="本文" />
<button type="submit">保存</button>
</form>
エディタは <textarea> と同じようにフォームに参加し、name の名前で送信されます。
| 属性 | 意味 |
|---|---|
name | フォーム送信時のフィールド名 |
value | 初期値の HTML。表示前に無害化されます(セキュリティ) |
label | 入力エリアの読み上げ用の名前(スクリーンリーダー向け)。既定は「Rich text editor」 |
続けて HTML を安全に保存・表示 してください。
Inertia(Vue 3 / React)
JavaScript は Composer で入ったパッケージからインストールします。エディタとサーバー側のコードが常に同じバージョンになります。composer install を npm install より先に実行してください(CI や Docker のビルドでも同じです)。
npm install ./vendor/2bo-velocity/ohashirichtexteditor
Vue 3
<script setup>
import { useForm } from '@inertiajs/vue3'
import { OhashiEditor } from '@2bo-velocity/ohashirichtexteditor/vue'
const form = useForm({ body: '' })
</script>
<template>
<form @submit.prevent="form.post('/posts')">
<OhashiEditor v-model="form.body" name="body" />
<button type="submit">保存</button>
</form>
</template>
React
import { useForm } from '@inertiajs/react'
import { OhashiEditor } from '@2bo-velocity/ohashirichtexteditor/react'
export default function Create() {
const { data, setData, post } = useForm({ body: '' })
return (
<form onSubmit={(e) => { e.preventDefault(); post('/posts') }}>
<OhashiEditor value={data.body} onChange={(html) => setData('body', html)} name="body" />
<button type="submit">保存</button>
</form>
)
}
ラッパーがエディタ本体を自動で読み込みます。Inertia のサーバーサイドレンダリングでもそのまま import できます。
Livewire
Blade コンポーネントに wire:model を付けます。Livewire 3.8.3 以上と 4 に対応しています。
<x-ohashi-editor wire:model="body" label="記事の本文" />
class EditPost extends Component
{
public string $body = '';
public function save(): void
{
$this->validate(['body' => 'required|max:65535']);
$this->post->update(['body' => $this->body]); // SanitizedHtml Cast で無害化される
}
}
- 入力・ツールバーのボタン・元に戻す・貼り付け・アップロードのどの変更も、エディタが正規化した HTML としてプロパティに届きます。
wire:model.live・.blur・.changeは通常の入力欄と同じように使えます。.liveでも、サーバーからの応答が待っている間に入力した内容を上書きすることはなく、変換の途中で通信が往復しても IME の変換は途切れません(IME の入力を自動化できる Chromium で確認)。- サーバー側でプロパティを設定する(
$this->body = '…')と、エディタの内容が置き換わります。 - コンポーネントの再描画や
wire:navigateでもエディタは壊れません。wire:ignoreは不要です。 - 保存は通常のフォームと同じく
SanitizedHtmlCast を通してください。Livewire のプロパティも利用者の入力です(安全な保存と表示)。
以上は、Livewire 3 と 4 のそれぞれについて、本物の Livewire サーバーに対して Chromium・Firefox・WebKit で確認しています。