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

カスタマイズ

エディタの内部は Shadow DOM なので、サイトのスタイルシートのセレクタは届きません。見た目の調整は、その境界を越えるために用意した 2 つの仕組みで行います。

備考

ここに載っている名前は公開の約束です。メジャーバージョンを上げない限り変わりません。

1. CSS カスタムプロパティ​

エディタ要素、またはその祖先に指定します。

プロパティ既定値対象
--orte-font-familyシステムの UI フォント → Hiragino Sans / Noto Sans JPエディタ内の文字
--orte-text-color#111827文字色
--orte-editor-bg#ffffff入力エリアの背景
--orte-toolbar-bg#f9fafbツールバーの背景
--orte-border-color#d1d5db外枠・ツールバーの区切り線
--orte-border-radius0.5rem外枠の角丸
--orte-min-height16rem入力エリアの最小の高さ
--orte-accent-color#2563ebフォーカス枠・押されたボタン・リンク・引用の線
--orte-muted-color#6b7280引用の文字色
--orte-icon-size1.125remツールバーのアイコン(標準も差し替えたものも)
--orte-code-bg / --orte-code-color#1e293b / #f8fafcコードブロック
--orte-danger-color / --orte-danger-bg#dc2626 / #fef2f2エラーの表示(不正なリンクなど)
ohashi-rich-text-editor {
--orte-border-radius: 0;
--orte-min-height: 24rem;
}

ダークモード​

エディタは、サイトがいつダーク表示なのかを推測しません。サイトで使っている条件に合わせて、プロパティを切り替えてください。

.dark ohashi-rich-text-editor {
--orte-text-color: #f8fafc;
--orte-editor-bg: #0f172a;
--orte-toolbar-bg: #1e293b;
--orte-border-color: #334155;
}

2. ::part()​

part要素
container外枠
toolbarツールバー(ボタンが無いときは表示されません)
groupボタンのグループ(toolbar 属性の | で区切った単位)
btnすべてのボタン
btn-<ツール名>個別のボタン: btn-bold・btn-ul・btn-link など
btn-activeキャレット位置でその書式が有効なあいだ、ボタンに付く
iconボタン内のアイコン
content入力エリア
popover・popover-linkリンクの入力欄
input・input-link-url・input-link-blankURL 欄と「新しいタブで開く」
btn-primary・btn-link-apply・btn-link-remove・btn-popover-closeリンク入力欄のボタン
popover-image・btn-image-width・input-image-alt・btn-image-apply画像の設定(幅のプリセット・代替テキスト)。選択中のプリセットには btn-active も付きます
notice・notice-error・notice-infoツールバーと本文の間に出るメッセージ(エラー、またはアップロード中などの進行状況)
notice-message・notice-code・btn-notice-closeその本文・エラーコード・閉じるボタン
ohashi-rich-text-editor::part(content) {
padding: 1.5rem;
font-size: 1.05rem;
line-height: 1.9;
}

::part() の後ろにはクラスや属性のセレクタを書けません。:hover・:focus-visible・:disabled などの擬似クラスは使えます。そのため、状態は独立した part 名で表します。

ohashi-rich-text-editor::part(btn) { border-radius: 9999px; }
ohashi-rich-text-editor::part(btn-active) { background: #fef3c7; }
ohashi-rich-text-editor::part(btn):disabled { opacity: 0.3; }

3. ツールバー​

toolbar 属性でボタンを選び、| でグループを区切ります。

<!-- 既定 -->
<ohashi-rich-text-editor toolbar="undo redo | bold italic strike | paragraph h2 h3 quote | ul ol | link code image">

<!-- コメント欄向け -->
<ohashi-rich-text-editor toolbar="bold italic | link">

書かなかったツールは完全に無効になり、キーボードショートカット(Ctrl/Cmd+B などブラウザ標準のものを含む)も効きません。::part(btn-bold) { display: none } で隠すのは見た目だけです。

ツールショートカット
undo / redoCtrl/Cmd+Z / Ctrl/Cmd+Shift+Z
bold / italicCtrl/Cmd+B / Ctrl/Cmd+I
linkCtrl/Cmd+K
strike・paragraph・h2・h3・quote・ul・ol・code—
image(upload-url があるときだけ表示。画像のアップロード)—

ツールバーは Tab で 1 回だけ止まり、矢印キー・Home・End でボタン間を移動します。

コードブロックの中では Enter で行が増えます。コードブロックを抜けるには、空の最終行で Enter を押します(末尾で Enter を 2 回)。引用も同じく、空の最終行で Enter を押すと抜けます。コードブロック・引用・リスト・見出しがエディタの最後にあるときは、その末尾で ↓ か → を押すと下に新しい段落ができます。末尾に残った空の段落は保存されません。

Blade では、config/ohashi-editor.php ですべてのエディタの既定を決められます。個々のエディタの属性が優先されます。

'toolbar' => 'bold italic | link',

4. 表示言語​

<ohashi-rich-text-editor locale="ja">

既定は英語で、日本語を同梱しています。

Blade の <x-ohashi-editor> は言語を自動で決めます。エディタの locale 属性 → config('ohashi-editor.locale')(OHASHI_EDITOR_LOCALE)→ アプリの言語(app()->getLocale()。ja や ja_JP なら日本語)の順で、同梱していない言語なら英語です。ブラウザの設定から推測することはなく、ページの lang は本文の言語を表すために残しておきます。

JavaScript で言語を追加したり、文言を変えたりできます。足りない文言は英語になります。使うときは locale(または config)にその言語のコードを指定します。

import { defineOhashiEditorLocale } from '@2bo-velocity/ohashirichtexteditor'

defineOhashiEditorLocale('fr', { bold: 'Gras', italic: 'Italique', link: 'Lien' })

5. アイコン​

標準のアイコンは Lucide です。1 つのエディタだけ差し替えるなら slot を使います。中身はページ側にあるので、ページの CSS(アイコンフォントなど)がそのまま効きます。

<ohashi-rich-text-editor>
<i slot="icon-bold" class="fa-solid fa-bold"></i>
</ohashi-rich-text-editor>

ページ全体で差し替えるなら:

import { defineOhashiEditorIcons } from '@2bo-velocity/ohashirichtexteditor'

defineOhashiEditorIcons({ bold: '<svg viewBox="0 0 24 24">…</svg>' })

文字列はそのままマークアップとして挿入されます。自分で書いた SVG だけを渡し、利用者が入力したものは決して渡さないでください。

境界を越えて入ってくるもの​

color・font-family・line-height などの継承されるプロパティは、ページからエディタの中へ流れ込みます。エディタは重要なものを自分で指定しているので、上のカスタムプロパティを設定しない限り、ページ側の値は入り込みません。