← すべてのドキュメント

設定リファレンス

利用できるエディター設定を一覧します。構成例と使い方は設定を参照してください。

小さな画面ではテーブルを横にスクロールしてすべての列を確認できます。キーボードではテーブル領域にフォーカスし、矢印キーを使えます。

名前既定値説明
skindefaultエディターの外観を指定します。値はコンテナーのクラス（rte-skin-<value>）になります。dark、gray、blue、rounded-corner のテーマが付属し、独自にスタイルを定義した名前も使えます。未設定なら既定の明るい外観になります。skin を参照してください。
toolbardefaultdefault、basic、full から選びます。デスクトップのツールバーのボタン構成を自動設定します。
toolbarMobilemobileモバイル端末で使うツールバーの構成です。
maxWidthForMobile992画面（ブラウザーウィンドウ）の幅が 992 未満になると、モバイル用ツールバーを使います。
timeoutAddToUndo900高速入力中は、元に戻す履歴を追加するまで 900ms 待ちます。
enableDragDroptrueエディターのドラッグ＆ドロップを有効または無効にします。
enableObjectResizingtrueRichTextEditor 内のオブジェクトのサイズ変更をユーザーに許可するかどうかを指定します。
readOnlyfalseRichTextEditor を編集可能な HTML エディターとして使うか、読み取り専用の文書ビューアーとして使うかを取得または設定します。
focusOnLoadfalseページの読み込み時にエディターにフォーカスを移すかどうかを指定します。true なら移し、false なら移しません。
allowScriptCodefalseJavaScript インジェクションを防ぐため、HTML からすべての script 要素とその内容を除去するかどうかを指定します。false（既定値）の場合、RichTextEditor はすべての script 要素とその内容を除去します。
tagWhiteList[]エディターで使用できるタグの許可リストです。
tagBlackList[]エディターで使用できないタグの拒否リストです。
maxHTMLLength0HTML タグを含め、RichTextEditor に入力できる最大文字数を取得または設定します。既定の 0 は上限なしです。上限を超えると、最後の有効な状態に戻し、reachmaxlength の customdialog フックを発生させます。
maxTextLength0HTML タグを除き、RichTextEditor に入力できる最大文字数を取得または設定します。既定の 0 は上限なしです。上限を超えると、最後の有効な状態に戻し、reachmaxlength の customdialog フックを発生させます。
styleWithCSSfalse太字、斜体、下線の保存形式です。既定ではタグ（<b>、<i>、<u>）を書き込みます。boldTag と italicTag で名前を変更でき、スクリーンリーダーは強調として読み上げます。true にすると、代わりにインラインスタイル（<span style="font-weight: bold">）を保存します。コア 2.6.8 以降の動作です。それ以前はプラグインバンドルの読み込みが先に終わるかどうかに依存し、同じ内容でも保存形式が変わる場合がありました。
pasteStripThemeStylestrue貼り付け時に、エディター自身のテーマを繰り返すだけのインラインスタイルを除去します。ブラウザーはコピーした HTML に計算済みスタイルを書き込むため、以前はエディター内でコピーしたテキストにテーマの余白、文字サイズ、色が付いて貼り付けられ、そのまま保存されていました。作者が設定した、テーマとは異なるスタイルは残します。false にすると貼り付けたスタイルをすべて残します。コア 2.6.8 以降です。
smartTypographytrue入力文字を組版用の文字に置き換えます。直線の引用符を曲線の引用符に、ハイフン 2 個を em ダッシュに、ピリオド 3 個を省略記号に、(c)、(r)、(tm) を ©、®、™ に変換します。code、pre、kbd の内部は変更しません。これはコアの機能で、自動修正プラグインとは別なので、autocorrectEnabled: false では無効になりません。入力どおりに残すには false にします。以下の 4 項目で各置換を個別に切り替えられます。
smartTypographyQuotestrue直線の二重引用符と一重引用符を曲線の引用符（“ ” ‘ ’）に変換し、単語内のアポストロフィを ’（don’t）に変換します。
smartTypographyDashestrueハイフン 2 個を em ダッシュ（—）に変換します。ハイフン 1 個は変更しません。
smartTypographyEllipsistrueピリオド 3 個を 1 文字の省略記号（…）に変換します。
smartTypographyTrademarkstrue(c)、(r)、(tm) を ©、®、™ に変換します。
sanitizerAllowIframestrueコンテンツ内の <iframe> 要素を残します。プラグインバンドルに含まれるコンテンツサニタイザー（contentSanitizer）が有効なときに適用します。src が http または https のフレームだけを残し、srcdoc、イベントハンドラー、javascript: URL は残しません。sanitizerAllowedIframeHosts のリストがない場合、すべてのフレームに allow-scripts allow-same-origin allow-presentation の sandbox を適用します。トップレベルの移動、ポップアップ、モーダル、フォームは許可せず、ページと同一オリジンのフレームからは allow-same-origin も除きます。false にするとすべての iframe を除去します。
sanitizerAllowedIframeHosts[]指定したホストとそのサブドメインのフレームだけを残します。例：["www.youtube.com", "player.vimeo.com"]。より厳密な制御なので、想定する埋め込み先が分かっている場合は設定してください。
maxUploadFileSize0エディターが挿入またはアップロードする最大ファイルサイズ（バイト）です。既定の 0 は上限なしです。画像と文書のダイアログ、貼り付け、ドラッグ＆ドロップに適用します。上限超過のファイルは読み取り前に拒否するため、文書への埋め込みもハンドラーへの送信も行いません。メッセージには text_uploadtoobig を使います。独自のダイアログを表示するには uploadtoobig の customdialog フックを処理してください。
allowBase64Imagestrueアップロードハンドラーも file_upload_url もない場合、挿入した画像は base64 の data: URL として HTML に埋め込まれます。false にすると埋め込まず、text_base64disabled メッセージ（customdialog フックは base64disabled）で画像を拒否するため、アップロードハンドラーが必要になります。コア 2.6.5 以降です。
base64ImageMaxSize204800縮小後の base64 画像の最大サイズ（バイト、200 KB）です。これを超える画像は text_base64toobig メッセージ（customdialog フックは base64toobig）で拒否します。0 は上限なしで、コア 2.6.5 より前の動作です。
base64ImageShrinktruebase64 として埋め込む前に、ブラウザー内で JPEG、PNG、WebP、BMP 画像を縮小して再エンコードします。GIF と SVG は再エンコードしません。false にすると、base64ImageMaxSize 以下なら元のバイト列を埋め込みます。コア 2.6.5 以降です。
base64ImageMaxDimension1600base64 埋め込み用に縮小した画像の長辺のピクセル数です。コア 2.6.5 以降です。
file_upload_urlnull挿入、貼り付け、ドロップしたファイルを multipart/form-data で POST する URL です。file_upload_handler を書く代わりに設定します。レスポンスは TinyMCE の {"location": "..."}、CKEditor の {"url": "..."} または {"urls": {"default": "..."}}、READY:<url> を受け付けます。{"error": {"message": "..."}}、ERROR:<message>、その他の本文は失敗です。両方を設定した場合は file_upload_handler が優先されます。
file_upload_fieldfileファイルを送信するフォームフィールド名です。CKEditor 形式のエンドポイントは upload を想定します。
file_upload_base_pathnullアップロードを CDN から配信するため、エンドポイントが返した相対 URL の前に付けます。
file_upload_credentialsfalse別オリジンのエンドポイントへのアップロードに Cookie と HTTP 認証情報を付けます。
file_upload_reuse_filenamefalse元のファイル名で送信します。既定では一意の名前を生成するため、2 人が image.png をアップロードしても互いに上書きしません。
file_upload_headersnullCSRF トークンなど、アップロードの追加リクエストヘッダーです。
automaticUploadsfalsetrue の場合、setHTMLCode の後と HTML の挿入・貼り付けの後に、コンテンツ内の base64 data: URL の画像を自動アップロードします。uploadEmbeddedImages() を automaticUploadsDelay（300 ms）でデバウンスして実行します。file_upload_handler が未設定なら何もしません。
automaticUploadsDelay300自動スキャンを実行するまでの待ち時間（ミリ秒）です。複数の画像を貼り付けたときにまとめてアップロードします。
uploadRetryCount0失敗をハンドラーのコールバックとユーザーに伝えるまでの追加試行回数です。試行ごとに uploadretry イベントが発生します。キャンセル済み、または画像が削除済みのアップロードは再試行しません。
uploadRetryDelay1000最初の再試行までの待ち時間（ミリ秒）です。その後は試行ごとに倍になります。
autoSavenull入力中に自分のサーバーへ保存します：{ onSave: function (html) { return promise; }, interval: 2000, indicator: true, retryCount: 3, retryDelay: 5000 }。onSave は必須です。Promise を返すと保存結果をエディターに表示できます。失敗時は待ち時間を倍にして再試行し、ブラウザーがオンラインに戻った直後にも再試行します。手動制御は editor.autoSave のメソッドを参照してください。
editorResizeModebothサイズ変更モードを取得または設定します。both、height、none を指定できます。
toggleBordertrueToggleBorder の状態を指定します。コードで border = 1 などを設定せずに、境界線を確認できる機能です。
showSelectedBlocktrueRichTextEditor 内で選択中のブロックを表示するかどうかを指定します。
showFloatTextToolBarfalseconfig.controltoolbar_TEXT で定義した FloatTextToolBar を表示するかどうかを指定します。
showFloatLinkToolBarfalseconfig.controltoolbar_A で定義した FloatLinkToolBar を表示するかどうかを指定します。
showFloatImageToolBbarfalseconfig.controltoolbar_IMG で定義した FloatImageToolBbar を表示するかどうかを指定します。
showFloatTableToolBarfalseconfig.controltoolbar_TD で定義した FloatTableToolBar を表示するかどうかを指定します。
showFloatParagraphtrue左側に FloatParagraph を表示するかどうかを指定します。
floatParagraphPosleftFloatParagraph の位置を取得または設定します。左または右です。
floatParagraphPosX0FloatParagraph の水平座標をピクセル単位の数値で指定します。
floatParagraphPosY0FloatParagraph の垂直座標をピクセル単位の数値で指定します。
showPlusButtontrueエディターのプラスボタンを表示するかどうかを指定します。
showTagListtrueエディター下部のバーにタグセレクターを表示するかどうかを指定します。
showStatisticstrueエディター下部のバーにコンテンツの統計を表示するかどうかを指定します。
tabSpaces4Tab キーで挿入するスペース数を取得または設定します。
enterKeyTagpEnter キーを押したときの動作を指定します。div、p、br から選びます。
htmlcode_forcehexformatfalse保存する HTML の色を rgb(153, 51, 0) ではなく #993300 で書き込みます。エディターは選択した色をそのまま渡しますが、スタイルの読み戻し時にブラウザーが rgb() に正規化するため、出力時に変換します。読み込み・貼り付け済みの色とユーザーが適用した色の両方に適用し、文字色と背景色を対象にします。6 桁の 16 進数ではアルファ値を表せないので、rgba() は変更しません。
paragraphClassparagraph新しい段落の作成時に、指定したクラス名を自動で追加します。
insertTableTag<table></table>テーブル挿入時の既定のテーブル属性です。
insertRowTag<tr></tr>行作成時の既定の行属性です。
insertCellTag<td><br/></td>セル挿入時の既定のセル属性です。
url_base/richtexteditorエディター自身のファイル（コンテンツとプレビューのスタイルシート、プレビュースクリプト、ヘルプページ、カラーピッカーの More ページ）の読み込み元フォルダーです。コア 2.6.10 以降は未設定なら rte.js の読み込み元に従うため、CDN やサブフォルダーへの設置でも設定不要です。それ以前は常に /richtexteditor でした。別の場所から配信する場合に設定します。
onready(none)コア 2.6.10 以降：エディターの構築と初期コンテンツの読み込みが完了したとき（ready イベント）に 1 回呼び出す関数です。editor.attachEvent("ready", fn) と同じです。
pasteMode"Auto"貼り付け処理を指定します。"Auto" は書式を残して整理し、"PasteText" は常にプレーンテキスト、"PasteWord" は常に Word 用の整理処理、"Disabled" は貼り付けを拒否します。Disabled 以外では Ctrl+Shift+V でプレーンテキストを貼り付けます。
smartLinkPastetrueテキスト選択中に URL を貼り付けると、置き換えずに選択したテキストをリンクにします。
autoLinkPastetrueコア 2.6.10 以降：貼り付けたプレーンテキスト内の Web アドレス（https://… または www.…）をリンクにします。末尾の句読点はリンクに含めません。Ctrl+Shift+V、リンク内、コード内には適用しません。アドレスをプレーンテキストにするには false にします。
linkDefaultProtocol"http://"コア 2.6.10 以降：リンクダイアログに入力した example.com や貼り付けた www. アドレスなど、プロトコルがないアドレスの先頭に付けます。既定で安全なリンクを使うには "https://" にします。
pasteMarkdownfalseコア 2.6.10 以降：true の場合、プレーンテキストで貼り付けた Markdown（README、チャット、AI の回答）を見出し、太字、斜体、リンク、リスト、引用、コードブロックに変換します。Markdown に見えないテキスト、Ctrl+Shift+V、コード内の貼り付けはプレーンテキストのままです。結果は通常の貼り付けと同様にサニタイズします。
markdownShortcutsEnabledtrue空の段落の先頭で入力する Markdown ブロックショートカットです。# から ###### は見出し、- / * は箇条書き、1. / 1) は番号付きリスト（1 以外なら開始番号を指定）、> は引用、[ ] は ToDo 項目（ToDo プラグイン使用時）、``` はコードブロック、--- + Enter は水平線です。Ctrl+Z を 1 回押すと入力した文字に戻ります。
markdownInlineEnabledtrue閉じ区切りの入力でインライン Markdown を自動整形します：**bold**、*italic*、`code`、~~strike~~。その後の入力は書式なしになります。
contentCssUrl%url_base%/runtime/
richtexteditor_content.css		編集領域に使うスタイルシートの場所を指定します。
previewCssUrl%url_base%/runtime/
richtexteditor_preview.css		プレビューウィンドウに使うスタイルシートの場所を指定します。
previewScriptUrl%url_base%/runtime/
richtexteditor_preview.js		プレビューウィンドウに使う JavaScript ファイルの場所を指定します。
contentCssText""編集領域に使うインライン CSS テキストを取得または設定します。例："body{background-color:#eee}"。
previewCssText""プレビューウィンドウに使うインライン CSS テキストを取得または設定します。例："body{background-color:#eee}"。
editorBodyCssClass""スタイルを切り替えるための編集領域のクラスを取得または設定します。
editorBodyCssText""編集用 body に使うインライン CSS テキストを取得または設定します。
editablePaddingTop2編集領域の上のパディング（余白）を設定します。
editablePaddingBottom2編集領域の下のパディング（余白）を設定します。
editablePaddingLeft2編集領域の左のパディング（余白）を設定します。
editablePaddingRight2編集領域の右のパディング（余白）を設定します。
zIndexFullPage9999全画面モードのエディターの z-index を設定します。
zIndexFloat99999フローティングツールバーの z-index を設定します。
zIndexDialog999999エディターのダイアログの z-index を設定します。
zIndexDropDown9999999エディターのドロップダウンの z-index を設定します。
fontNameDropDownMinWidth90pxフォント名ドロップダウンの min-width を設定します。
fontNameDropDownMaxWidth110pxフォント名ドロップダウンの max-width を設定します。
tooltipAttributerte-tooltipエディターのツールチップ用の属性を設定します。
showKeyboardShortcutsInTooltipstrueツールバーボタンのショートカットをツールチップに表示します（"Bold (Ctrl+B)"、Mac では ⌘）。表示はツールチップだけで、ダイアログのタイトルとボタンのアクセシブル名は通常のラベルのままです。ボタンに aria-keyshortcuts を付けます。
keyboardShortcutHints{ bold: "Ctrl+B", italic: "Ctrl+I", ... }コマンド名をキーとする、各コマンドの表示用ショートカットです。独自にバインドしたショートカットに合わせて追加・置換してください。text_* ラベルには入れないでください。ラベルはダイアログのタイトルとアクセシブル名にも使われ、言語パックで置き換えられます。
commentMentions[]コメントでメンションできる人の { id, name } 配列です。コメント入力欄で @ を入力すると一覧が表示されます。選択すると "@Name" が挿入され、コメントにメンションを記録します。空なら一覧はありません（コメントプラグイン）。
text_uilocaleset by each language pack読み込んだ言語パックのロケール（例：zh-Hans、de）です。ブラウザーの Intl API を使い、テキストの一部の言語メニューと Ask AI の翻訳リストの言語名、日付チップの表記に使います。パック未読み込み時は英語です。
controlSelectionClassrte-control-selectedコントロール選択時のクラスを設定します。
controlSelectionMargin7コントロール選択時の余白を設定します。
altTextHinttruealt テキストがない、または空の画像を、編集領域内で琥珀色の破線で囲みます。説明が必要な画像を作者に示します。エディター内だけの表示で、保存 HTML には何も追加しません。false で非表示にします。
autoHeadingAnchorstrue変更の少し後に、すべての見出しにテキストから作る id（"Hello World" は hello-world）を付け、リンクや目次の参照先にできるようにします。重複時は -2、-3 を付けます。false でコアの id 付与を停止します。プラグインバンドルを読み込んでいる場合、文書アウトラインプラグインが自分で見出し id の一意性を保ちます。
autoLinkOnTypetrue入力した URL やメールアドレスの後にスペースを入力するとリンクにします。false ならプレーンテキストのままです。
backspaceOutdenttrueリスト項目の先頭で Backspace を押すと、前の項目に結合せず、その項目を段落としてリストから取り出します。false なら結合します。
blockDragHandlestrueブロック（段落、見出し、リスト、テーブルなど）にポインターを重ねると、横にドラッグハンドルを表示します。ドラッグでブロックを移動できます。false で非表示にします。
collabEnabledtrue共同編集プラグイン（yjscollab）が editor.collab を設定できるようにします。false ならプラグインは何もせず、editor.collab はありません。共同編集は editor.collab.attach(...) を呼んだときにだけ開始し、この既定値だけでは接続しません。共同編集を参照してください。
collabShowPresencetrue共同編集セッションの接続時に、文書内のほかの参加者を一覧するパネルを表示します。false で非表示にします。
collabShowRemoteCursorstrue共同編集セッションの接続時に、ほかの参加者のキャレットと選択範囲をテキスト上に表示します。false で非表示にします。
collabTextSyncfalseプレゼンスとレビュー台帳以外に同期する内容です（yjscollab プラグイン）。false は文書テキストを同期せず、true は共有 Yjs テキストに文書全体のスナップショットを保存し、"crdt" は CRDT エンジン（crdt-engine.min.js）で文字単位にマージします。エンジン未読み込み時はスナップショットに切り替えます。
collabRequireCrdtfalsecollabTextSync: "crdt" のとき、CRDT エンジンがなければスナップショットに切り替えず、テキスト同期を無効にします。プレゼンスとレビュー台帳は維持し、理由をコンソールに表示します。
collabTextNamerichtextbox.bodyスナップショット同期に使う共有 Yjs テキストの名前です。1 つの Yjs 文書内の各エディターに異なる名前を付けてください。
aiToolkitEnabledtrueAI Toolkit プラグインです。false にすると AI のボタン、メニュー、ダイアログを無効にします。AI Toolkit を参照してください。
aiToolkitResolvernullAI Toolkit が自分の AI サービスを呼び出す関数です。キーまたはエンドポイントを用意してください。実行時は editor.aiToolkit.setResolver(fn) で設定します。未設定ならデモモードで動作します。リクエストとレスポンスは AI Toolkit のページで説明しています。
aiToolkitAgentnulleditor.aiToolkit.runAgent(prompt) が複数段階の編集を計画・適用する関数です。実行時は setAgent(fn) で設定します。未設定なら runAgent はその旨のメッセージで拒否します。
aiToolkitAutoToolbarButtonstrueAI ボタンをツールバーに自動追加します。独自のツールバー文字列に AI コマンドを配置するには false にします。
aiToolkitActions(built-in list)AI メニューの操作を { id, section, icon, title, description } の配列で指定します。置き換えると独自の操作を表示できます。
aiToolkitDialogModes(built-in list)Ask AI ダイアログのモード（Proofread、Rewrite、Translate など）を { id, title, description } の配列で指定します。
aiToolkitChatPrompts(built-in list)AI Chat の開始用プロンプトを { id, label, prompt } の配列で指定します。
aiToolkitTranslateLanguages(Spanish, French, German, Italian...)Translate の言語を { value, label } の配列で指定します。
aiToolkitOperationHandlersAI の回答に含まれる操作の種類別ハンドラーです：{ myType: function (operation, context) { ... } }。適用できたら true を返します。実行時は editor.aiToolkit.registerOperationHandler() で追加できます。
aiToolkitPersistenceKey(empty)この文書のキーです。設定すると AI レビューの状態（提案と判断）をブラウザーの localStorage の RTE.AIToolkit.<key> に保存し、再読み込み後も維持します。aiToolkitSuggestionLedgerUrl に対する文書の識別にも使います。空なら保存しません。
aiToolkitReviewLogUrl(empty)監査ログ用に、AI レビューの各判断を JSON POST で受け取る自分のサーバーの URL です。空なら送信しません。
aiToolkitSuggestionLedgerUrl(empty)共有・復元用に、文書の AI 提案と状態を JSON POST で受け取る自分のサーバーの URL です。aiToolkitPersistenceKey が必要です。空なら送信しません。
aiToolkitReviewSyncInterval15000レビュー状態をサーバーと同期する間隔（ミリ秒、5000 以上）です。
collabLedgerMapNamereviewLedgerコメント、提案、AI レビューの判断を参加者間で伝える共有 Yjs マップの名前です。
onCollabStatusnullセッション開始時に { attached, textSyncMode, requestedTextSync, fallbackReason, yjsBridge, peerCount } を渡して呼び出します。CRDT からスナップショットへの切り替えなど、有効なモードを表示できます。editor.collab.getStatus() も同じオブジェクトを返します。
imageHoverQuickBartrue画像にポインターを重ねると、小さな画像操作バーを表示します。false で非表示にします。
imageLazyLoadtrue挿入する画像（URL、アップロード、ドロップ）に loading="lazy" と decoding="async" を付け、長い文書の全画像が一度に読み込まれないようにします。false なら付けません。
indentUseMargintrue段落・見出しのインデント操作で、Word と同様にマージン（左から右のテキストでは margin-left）を変更します。false ならパディングを変更します。変更幅は indentation です。
inlineMathtrueeditor.applyMathMarkup() が $...$ の部分を <span class="rte-math-inline" data-tex="..."> で囲み、KaTeX や MathJax などで描画できるようにします。呼び出すまでは何も起きません。false なら呼び出しても変更しません。
placeholderShowOnlyWhenEditabletrue読み取り専用（readOnly または setReadOnly(true)）かコメント専用モードでは placeholder を隠し、編集可能になると再表示します。false なら読み取り専用でも表示します。2.6.11 以前は読み取り専用でも表示していました。
showFloatLinkUrlPreviewtrueキャレットがリンク内にあると、フローティングリンクツールバーの先頭にアドレスを表示し、クリックすると新しいタブで開きます。false ならボタンだけを表示します。
smartPasteToasttrueWord や Google Docs からの貼り付けを整理した後、短い通知を表示します。false なら通知せず整理します。
tableColumnResizetrueテーブルの列境界にポインターを重ねるとサイズ変更の目印を表示し、ドラッグで列幅を変更できます。false で無効にします。
tableRowResizetrueテーブル行の下端にポインターを重ねるとサイズ変更の目印を表示し、ドラッグで行高を変更できます。false で無効にします。
aiContextMenutrueAI Toolkit の読み込み時、選択テキスト（3 文字以上）の右クリックで AI 操作メニューを開きます。false ならブラウザーのメニューを使います。
wordExportFileName(none)名前を渡さない場合の editor.exportToWord()（Word 互換の .doc）の基本ファイル名です。未設定なら最初の h1〜h3 見出しのテキスト、なければ "document" です。
wordExportFontFamilyCalibri, 'Segoe UI', Arial, sans-serif.doc 出力の本文フォントです。exportToWord() に渡すオプションを優先します。
wordExportFontSize11pt.doc 出力の本文フォントサイズです。
wordExportPageSize8.5in 11in.doc 出力のページサイズを CSS の @page サイズで指定します。既定は US Letter、A4 は "21cm 29.7cm" です。文書のページ設定（ページ表示）が優先されます。
wordExportMargin1in.doc 出力の余白を CSS の長さまたは一括指定で設定します。文書のページ設定が優先されます。
wordExportLandscapefalse.doc 出力を横向きにします。文書のページ設定が優先されます。
docxExportFileName(none)名前を渡さない場合の .docx 出力の基本ファイル名です。未設定なら Export- に日時（YYMMDD-HHMMSS）を続けます。例：Export-261026-153045.docx。
docxExportTitle(none).docx のプロパティに保存するタイトルです。未設定ならページの document.title、なければ "Document" です。
docxExportAuthorRichTextEditor.docx のプロパティに保存する作成者です。
pdfExportFileName(none)名前を渡さない場合の PDF 出力の基本ファイル名です。未設定なら Export- に日時（YYMMDD-HHMMSS）を続けます。
pdfExportTitle(none)PDF のメタデータに保存するタイトルです。未設定ならページの document.title、なければ "Document" です。
pdfExportAuthor(empty)PDF のメタデータに保存する作成者です。
pdfExportFonthelveticaベクター PDF のフォントです（pdfexport プラグイン）。埋め込み不要の標準 PDF フォント "helvetica"、"times"、"courier" から選びます。西欧のラテン文字のみ対応します。pdfExportRasterFallback を参照してください。
pdfExportBaseFontSize11ベクター PDF の本文サイズ（ポイント）です。見出しのサイズもこれを基準にします。
pdfExportHeader(none)ベクター PDF の各ページ上部中央のプレーンテキストです。{page} と {total} がページ番号と総ページ数になります。未設定なら文書のページヘッダー（ページ表示）のテキストがあれば使います。
pdfExportFooter(none)各ページ下部中央のプレーンテキストです。同じ {page} と {total} を使えます。
pdfExportRasterFallbacktrue西欧のラテン文字以外（中国語、日本語、韓国語、キリル文字、ギリシャ語、アラビア語など）、ベクター PDF でエンコードできない文字がある場合、exportToPdf() とツールバーの Export PDF は全文字を描画できる html2pdf のラスター出力に切り替え、コンソールに通知します。editor.getPdfUnsupportedText() で対象文字を確認できます。false なら常にベクター出力し、非対応文字は "?" になります。2.6.11 以前は常に "?" でした。
pdfExportUnicodeFont(none)標準フォントで描画できない中国語、日本語、韓国語、キリル文字、ギリシャ語などのための TrueType フォントのバイト列（.ttf、ArrayBuffer または Uint8Array）です。設定すると文書で使う字形だけを埋め込み、大きな CJK フォントでも数百 KB 程度になり、選択・検索ができます。未設定時は pdfExportRasterFallback を参照してください。editor.loadPdfFont(url) で配信中のフォントを取得して設定できます。呼び出すまで取得しません。CFF（.otf）とコレクション（.ttc）はコンソールに通知して拒否します。
mentionTrigger@メンション一覧を開く文字です（mentions プラグイン）。mentionStaticList または mentionSource の設定後にだけ動作します。
mentionStaticListnull既定のトリガー用の固定ユーザー一覧です：{ id, label (or name), subtitle (or email) } の配列。トリガー後の入力で label、subtitle、id を大文字・小文字を区別せず絞り込みます。未入力なら最初の 50 件を表示します。
mentionSourcenull既定のトリガー用の一覧を返す関数です：(query, { trigger }) => 項目配列、またはその Promise。mentionStaticList より優先します。追加トリガーには mentionTriggers または editor.mentions.register() を使います。
mentionTriggersnull追加トリガーです。各項目は { trigger, source (or search), insertClass, label, renderItem, renderInsert }。タグ用の # などに使います。search(query, done) のコールバックと非同期関数に対応します。source も search もなければコンソールに警告してスキップします。
mentionMaxItems8一覧に表示する最大件数です。
mentionDebounceMs150入力が止まってから再検索するまでの時間（ミリ秒）です。トリガー直後の未入力時はすぐに検索します。
mentionInsertClassrte-mention挿入したメンション要素のクラスです。トリガーごとに独自の insertClass を指定できます。
slashCommandTrigger/行頭またはスペースの後に入力してスラッシュコマンドメニューを開くキーです。コードや pre 内では動作しません。
slashCommandMaxItems40スラッシュメニューに一度に表示する最大コマンド数です。
documentOutlineEnabledtrue文書の見出し間を移動できるアウトラインパネルです（documentoutline プラグイン）。false なら Outline ボタンとパネルを表示しません。
documentOutlineAutoOpenfalse起動時にアウトラインパネルを開きます。
documentOutlineMinLevel1アウトラインに含める最上位の見出しレベル（1〜6）です。
documentOutlineMaxLevel6アウトラインに含める最下位の見出しレベル（1〜6、documentOutlineMinLevel より上位は不可）です。
documentOutlineTitle"Outline" (translated)パネルのタイトルとアクセシブル名です。未設定なら言語パックのテキストを使います。
documentOutlineHint(translated text)パネルのタイトルの下の行です。
documentOutlineEmptyText(translated text)見出しがない文書でパネルに表示するテキストです。
contentMinimapEnabledtrue文書全体の小さなプレビューをクリックして移動できるミニマップパネルです（contentminimap プラグイン）。false なら Minimap ボタンとパネルを表示しません。
contentMinimapAutoOpenfalse起動時にミニマップパネルを開きます。
contentMinimapWidth168パネルの幅（ピクセル、148 以上）です。
contentMinimapScale0.14文書をプレビューする縮小率です。0.14 は元のサイズの 14% です。
contentMinimapTitle"Minimap" (translated)パネルのタイトルとアクセシブル名です。
contentMinimapHint(translated text)パネルのタイトルの下の行です。
contentMinimapEmptyText(translated text)空の文書でパネルに表示するテキストです。
accessibilityCheckerEnabledtrue見出しレベルの飛び、alt テキストのない画像、ヘッダーのないテーブルなどの問題と修正方法を一覧するアクセシビリティチェックパネルです（accessibilitychecker プラグイン）。false ならボタンとパネルを表示しません。
accessibilityCheckerAutoOpenfalse起動時にアクセシビリティチェックパネルを開きます。
accessibilityCheckerTitle"Accessibility" (translated)パネルのタイトルとアクセシブル名です。
accessibilityCheckerHint(translated text)パネルのタイトルの下の行です。
accessibilityCheckerEmptyText(translated text)問題がないときにパネルに表示するテキストです。
contentAriaLabel(none)編集領域のアクセシブル名とフレームのタイトルです（a11yenhance プラグイン）。後ろに Escape の説明が付きます。例："Article body Press Escape to leave the editing area."。未設定なら言語パックの "Rich text editor. Editing area." を使います。同一ページの各エディターに異なる名前を付けてください。
contentLabel(none)contentAriaLabel が未設定のときに代わりに使います。
a11yEditorLabel(none)contentAriaLabel も contentLabel も未設定のときに編集領域名として使います（keyboarda11y プラグイン）。2.6.11 以前はプラグインバンドルの読み込み時に効果がありませんでした。
a11yEscapeHint"Press Escape to leave the editing area." (translated)編集領域名の後ろに付ける、キーボードでエディターから出る方法の説明です。
contentLang(the page's lang)スペルチェックやスクリーンリーダーの発音に使う編集文書の lang です。未設定なら親ページの <html lang>、なければ en に従います。
a11yReadOnlySuffix"Read only."読み取り専用になったときにスクリーンリーダーが伝える内容です。
a11yEditableAgain"Editing enabled."読み取り専用を解除したときにスクリーンリーダーが伝える内容です。
a11yRovingToolbartrueツールバーを 1 つの Tab 停止位置とし、矢印キーでボタン間を移動します（ARIA ツールバーパターン）。false なら各ボタンが Tab 停止位置になります。
commentHighlightBg#fff9c4コメント付きテキストの背景色です（コメントプラグイン）。
commentHighlightBorder#f9a825コメント付きテキストの下線の色です。
trackChangesInsertClassrte-tc rte-tc-insert挿入提案を囲む要素のクラスです（提案モード）。独自のスタイルを適用する場合に変更します。
trackChangesDeleteClassrte-tc rte-tc-delete削除提案を囲む要素のクラスです。
onReviewDecisionDeniednullreviewCanDecide が承認・却下を拒否したとき、{ entry, action, user } を渡して呼び出します。ユーザーに理由を伝えられます。
reviewCanDecidenullユーザーが提案を承認・却下できるか判定する (entry, action, user, editor) 関数です。false で拒否します。例外を投げた場合も拒否します。
restrictedEditingModefalse入力欄のある Word フォームのように、data-rte-editable="true" の領域以外をロックします（restricted editing プラグイン）。editor.restrictedEditing で領域の指定、ロックの切り替え、領域間の移動を行います。
pageHeaderHtml(empty)ページ表示で各ページの上部に繰り返す HTML です（pagination プラグイン）。{page} と {total} がページ番号と総ページ数になります。文書のページ設定のヘッダーを優先します。
pageFooterHtml(empty)ページ表示で各ページの下部に繰り返す HTML です。同じ {page} と {total} を使えます。
readabilityWordsPerMinute200読書時間の推定に使う読む速度です（readability statistics プラグイン）。
maxLength0文書の最大文字数です（character limit プラグイン）。0 は上限なしです。
maxWords0文書の最大単語数です。0 は上限なしです。
charLimitEnforcetruemaxLength / maxWords を超える入力・貼り付けを止めます。false なら計数と報告だけを行います（editor.isOverLimit()、charlimit イベント）。
charLimitShowCountertrue上限設定中にフローティングカウンターを表示します。
sanitizerAllowTags[]サニタイザーが残す追加要素名です。完全一致、"x-*" のワイルドカード、正規表現を使えます。例：["custom-el", "x-*", /^ui-/]。script など実行可能な要素は残しません。
sanitizerAllowAttributes[]同じ形式で指定する、サニタイザーが残す追加属性名です。例：["data-cms-*"]。イベントハンドラー属性（on*）は残しません。
sanitizerAllowStyleTagsfalseコンテンツ内の <style> ブロックを残します。文書内のスタイルが表示先ページを変更するため、既定では無効です。
sanitizerGuardLiveDomtrue編集領域自体も監視し、script、on* 属性、javascript: URL などの実行可能な内容が現れたら再度除去します。貼り付けや setHTMLCode() だけでなく、共同編集同期、ページの別スクリプト、ブラウザー拡張機能からの内容も対象です。false ならエディター自身の経路だけを処理します。サニタイザーはブラウザー内で動作するため、サーバーでも検証してください。
documentImportModereplaceファイル取り込み時の動作です（document import プラグイン）。"replace" は文書を置換し、"insert" はキャレット位置に挿入します。置換は 1 回の元に戻す操作に相当します。
documentImportAccept.md,.markdown,.html,.htm,.txt,.doc,.docx取り込みダイアログで選択できるファイル形式です。
documentImportImagestrue取り込んだ .docx 内の画像を data URI として読み込みます。画像の多いファイルで除外するには false にします。
documentImportResolver(none)サーバーなどでファイルを独自変換する (file) => HTML（またはその Promise）関数です。文字列を返すとその結果を使います。それ以外、または拒否された Promise では組み込みリーダーに戻ります。
dictationEnabledfalseブラウザーの音声認識（Web Speech API）で文書に入力する音声入力を有効にします（dictation プラグイン）。既定では無効です。Chrome など一部のブラウザーはベンダーのサーバーで認識するため、音声が端末外に送られます。有効化前に許容できるか確認してください。
dictationLang(the browser's language)認識する言語を en-US などの BCP-47 タグで指定します。未設定なら navigator.language です。
dictationContinuoustrue発話の間も認識を続けます。false なら 1 回の発話で停止します。
dictationInterimResultstrue発話中に途中の認識結果を表示します。
dictationAutoPunctuationtrue各フレーズの先頭を大文字にし、句読点がなければ末尾にピリオドを付けます。
commentsEnabledtrueコメントプラグイン（インラインコメント、返信、解決）です。false で無効にします。
trackChangesEnabledtrue変更履歴プラグイン（提案モード、承認、却下）です。false で無効にします。
currentUsernull{ id, name, color } は編集中のユーザーです。コメント、提案、リビジョン履歴、共同編集で作成者として記録します。ユーザーが分かる場合は設定してください。
mentionEnabledtrueメンションプラグインです。false で無効にします。データソース（mentionStaticList、mentionSource、mentionTriggers）を設定して初めて表示します。
slashCommandEnabledtrueスラッシュコマンドメニューです（slash command プラグイン）。false で無効にします。
slashCommandIncludeAitrueAI Toolkit 読み込み時に、その操作をスラッシュメニューに表示します。false で除外します。
slashCommandsnull起動時に登録する追加スラッシュコマンドです。editor.slashCommands.register() が受け取る { id, section, title, description, keywords, iconSvg, run } の配列です。
galleryEndpoint(none)ギャラリーがフォルダーと画像を取得する URL です（insertgallery プラグイン）。{ currentFolder, currentFolderDisplay, parentFolder, folders: [{ folder, name }], images: [{ url, name, folder, size, source, alt }] } を返します。未設定なら galleryImages のみ表示し、リクエストしません。
nodeTypesEnabledtrueカスタムノード型のレジストリです（nodetypes プラグイン）。false で無効にします。
nodeTypes(none)起動時に登録するノード型です。editor.nodeTypes.register() と同じ { name, match, inline, atomic, toJSON, fromJSON, toMarkdown } を使います。登録要素はサニタイザーを通してもマークアップを維持し、単なるテキストの代わりに指定した Markdown 形式になります。
rubyAnnotationEnabledtrueルビ注釈です（rubyannotation プラグイン）。東アジアの文字の上に読みを表示し、<ruby> と <rt> で記述します。false で無効にします。
rubyAnnotationParenthesestrue読みの前後に <rp> の括弧を付けます。ルビ非対応の表示環境でも、本文と読みがつながらず "base(reading)" と表示できます。
stateInspectorEnabledtrue文書構造、構造上の問題、バグ報告用にコピーできるスナップショットを表示する開発者向け状態インスペクターです（stateinspector プラグイン）。false で無効にします。
stateInspectorToolbarButtonfalse状態インスペクターを開くツールバーボタンを追加します。既定では無効です。editor.stateInspector.open() でも開けます。
stateInspectorAutoOpenfalse起動時に状態インスペクターを開きます。
stateInspectorLogLimit60保持する最近のエディターイベント数です（10〜500）。
stateInspectorMaxDepth24文書ツリーを調べる深さです（2 以上）。
stateInspectorTitleState inspectorパネルのタイトルです。
stateInspectorHint(text)パネルのタイトルの下の行です。
stateInspectorEmptyTextNo content to inspect yet.空の文書でパネルに表示するテキストです。
名前既定値説明
paragraphItemsNormal,H1,H2,H3,H4,H5,H6書式ブロックの定義済みの一覧です。
fontSizeItems8,9,10,11,12,13,14,16,
18,24,36,48,60,72,96		フォントサイズの定義済みの一覧です。
fontNameItemsArial,Arial Black,Comic Sans MS,
Courier New,Tahoma,Georgia,Helvetica,
Segoe UI,Sans-Serif,Impact,
Times New Roman,Verdana		フォント名の定義済みの一覧です。
lineHeightItems100%,150%,200%,250%,300%,
350%,400%,450%,500%,600%		行高の定義済みの一覧です。
inlineStyles[["Red", "color:red", "color:red"],
["Bold", "font-weight:bold", "font-weight:bold"],
["Mark", "my-cls-mark"],
["Warning", "my-cls-warning"]]		インラインスタイルのドロップダウンの既定 CSS スタイルです。
[text,css style, display style]
paragraphStyles[["Red", "color:red"],
["Bold", "font-weight:bold"],
["Quote", "my-cls-quote"],
["Large Center", "my-cls-largecenter"]]		段落スタイルのドロップダウンの既定 CSS スタイルです。
[text,css style, display style]
imageStyles[["Border", "border:solid 1px gray"],
["Shadow", "box-shadow:0 0 8px gray"],
["Margin10", "margin:10px"],
["Padding:10", "padding:10px"]]		画像スタイルのドロップダウンの既定 CSS スタイルです。
[text,css style]
linkStyles[["Margin10", "margin:10px"],
["Padding:10", "padding:10px"],
["BigText", "font-size:36px"]]		リンクスタイルのドロップダウンの既定 CSS スタイルです。
[text,css style]
galleryImages[]ギャラリーのプリセット画像です。URL、[url, text]、{ url, name, alt } を指定します。既定は空です。2.6.11 までは richtexteditor.com のサンプル画像 6 枚を表示し、開くたびに当社サーバーから取得していました。画像ギャラリーを参照してください。
htmlTemplates[]Insert Template ダイアログのテンプレートです。[title, html] または { title, html, description } を指定します。既定は空です。2.6.11 までは両方とも "My Doc 1" というデモを 2 つ含んでいました。空の場合はダイアログにその旨を表示します。
characterItems文字の定義済みの一覧です。
foreColorItems文字色の定義済みの一覧です。
backColorItems背景色の定義済みの一覧です。
linkItems[]Insert Link ダイアログが提案するアドレスです。例：["/about", "/contact"]。既定は空です。2.6.11 までは大企業のサイト 5 件を提案していました。項目がなければ提案用の矢印を隠します。
imageItems[]Insert Image（URL 指定）ダイアログが提案するアドレスです。既定は空で、項目がなければ矢印を隠します。

プラグインのオプション

上記はコアエディターの設定です。以下はすべて richtexteditor/plugins/ の付属プラグインによる設定です。同じように、コンストラクターのオプションオブジェクト、または作成前にグローバルな RTE_DefaultConfig に設定します。

ソースビルドのプレビュー：新しいプラグインオプション

これらは現在のソースプラグインにありますが、すべての配布バンドルや現在のサイトのデモに含まれるわけではありません。対応するテスト済みのプラグインビルドを使ってください。オプションを設定しても、古いランタイムにない機能は追加されません。

オプション既定値説明
aiToolkitImageResolvernull画像生成対応ビルド：(prompt: string) => Promise<string>。HTTPS の画像 URL または PNG/JPEG/WebP/GIF の画像 data URL を最大 6,000,000 文字で返します。プラグイン自身はプロバイダーを呼び出しません。認証情報はサーバーに置き、生成画像の保存前にアップロード・ストレージのポリシーを適用してください。
galleryAcceptedExtensionsnullギャラリー対応ビルド：[".jpg", ".png"] などの配列で、Insert Gallery ダイアログに表示・許可する形式を置換します。アップロード先で受け付ける形式に合わせてください。
commentMentions[]コメントメンション対応ビルド：[{ id, name }] で、コメント欄の @ の後に提案するユーザーを指定します。選択した id/name をコメントに保存します。これは候補リストです。認可や通知・メール送信はアプリケーション側で別途実装してください。
tableRowDragtrue行ドラッグ対応ビルド：作成前に false にすると行のドラッグハンドルを隠します。ヘッダー行は固定です。結合・不揃いのテーブル、読み取り専用・コメント専用の内容、提案モードでは非対応の移動を拒否します。行移動は提案として記録しません。Escape でドラッグをキャンセルします。
tableColumnDragtrue列ドラッグ対応ビルド：作成前に false にすると列のドラッグハンドルを隠します。列幅とともに全行のセルを移動し、行番号列は先頭に残します。結合・不揃いのテーブル、読み取り専用・コメント専用、提案モードでは非対応の移動を拒否します。Escape でキャンセルします。

AI

すべての AI 機能で独自のキーを用意します。エディターは指定した関数を呼び出し、プロバイダーと直接通信しません。

オプション既定値説明
ghostTextfalseインラインの灰色テキスト補完を有効にします。Tab で採用、Esc で閉じます。
ghostTextResolvernullasync ({ before }) => string。ghostText の動作には必須です。
aiToolkitReviewLegacyLayouttrue以前の AI Review ドロワーのレイアウトを使います。
aitoolkit_skip_auto_csstrue独自のスタイルシートを提供する場合に AI Toolkit の CSS 自動挿入を省略します。

入力と執筆の支援

入力中に動作する機能です。それぞれ個別に無効にできます。

オプション既定値説明
autocorrectEnabledtrue自動修正プラグイン全体のスイッチです。コアのスマートタイポグラフィは無効になりません。smartTypography を参照してください。
autocorrectCapitalizetrue文の先頭を大文字にします。
autocorrectSpellingtrue組み込みのよくあるスペルミス一覧を適用します。
autocorrectTypographytrue自動修正プラグインによる引用符、ダッシュ、省略記号の置換です。コアも独自に同じ置換を行います。停止するには smartTypography を false にします。
autocorrectReplacementsnull独自の { from: to } 置換マップを組み込みの一覧に統合します。
emojiAutocompleteEnabledtrue:shortcode: の入力で絵文字を挿入します。
emojiShortcodes{ … }ショートコードと絵文字の対応を上書き・拡張します。
foldHeadingsEnabledtrue編集領域の見出しを折りたためるようにします。
typewriterModeEnabledfalse入力中、キャレット行の垂直位置を固定します。
typewriterAnchor0.5キャレット行の位置を 0（上）〜1（下）で指定します。
focusModeEnabledfalseキャレットがあるブロック以外を薄く表示します。
dragHandleEnabledtrue余白にブロックのドラッグハンドルを表示します。
dragHandleKeyboardtrueキーボード（Alt+Up / Alt+Down）でブロックを並べ替えられるようにします。
formattingMarkPilcrowtrue編集記号の表示時に段落記号を表示します。
formattingMarkBlockstrue編集記号の表示時にブロック境界を囲みます。
formattingMarkInvisiblestrueスペース、タブ、改行しないスペースを可視化します。
permanentPenClass"rte-pen"永久ペンのテキストに適用するクラスです。
permanentPenStyle{ … }永久ペンのテキストに適用するインラインスタイルオブジェクトです。
titleCaseSmallWords"a an and as at …"Change Case → Title Case で小文字のままにする単語です。
formatPainterProperties[ … ]書式コピーでコピーする CSS プロパティです。
readabilityStatstrueステータスバーに読みやすさの統計を表示します。
localDraftfalse誤った再読み込み後も内容を残すため、ローカルの下書きを保存します。

ブロック、構造、参照

コールアウト、カラム、番号付きリスト、脚注、相互参照、目次などの構造化コンテンツです。

オプション既定値説明
text_inlinecode"Inline code"インラインコードボタンのラベルとツールチップです（コマンドは "inlinecode"、属性なしの <code> 要素を出力）。
calloutTypes[ … ]使用できるコールアウトの種類です（info、warning など）。
calloutDefaultType"info"種類が未選択の場合に挿入するコールアウトの種類です。
columnsDefaultCount2カラムブロックで作成する列数です。
legalListClass"rte-legal-list"複数レベルの法的文書用リストに適用するクラスです。
legalListSeparator"."レベル番号間の区切り文字です（1.1.1）。
legalListSuffix"."最後のレベルの後ろに付ける文字です。
lineNumberStart1行番号の開始値です。
lineNumberInterval1N 行ごとに行番号を表示します。
lineNumberRestart"continuous""continuous"、またはページごとに再開始します。
lineNumberGutter38行番号の余白の幅（ピクセル）です。
footnotesTitle"Footnotes"脚注一覧の上に表示する見出しです。
footnotesNumbering"decimal"脚注番号のマーカー形式です。
footnotesMarkerPrefix""各脚注マーカーの前のテキストです。
footnotesMarkerSuffix""各脚注マーカーの後のテキストです。
crossRefFigureLabel"Figure"図を参照する際のラベルです。
crossRefTableLabel"Table"テーブルを参照する際のラベルです。
crossRefMissingText"[reference not found]"相互参照先がなくなったときの表示です。
tocTitle"Contents"生成した目次の見出しです。
tocMinLevel1目次に含める最上位の見出しレベルです。
tocMaxLevel3目次に含める最下位の見出しレベルです。
tocPageNumbers"auto"目次にページ番号を表示します。
mathDialogSamples[ … ]数式ダイアログに表示する初期サンプルです。
tableNumberSeries"numeric"テーブル行番号の番号系列です。
tableNumberHeader"#"行番号列のヘッダーテキストです。

ページレイアウト、出力、取り込み

文書をファイルや印刷ページにする機能です。出力処理はブラウザー内で行い、アップロードしません。

オプション既定値説明
paginationEnabledfalse文書を個別のページとして表示します。
pageFormat"A4"ページ分割と出力に使う用紙サイズです。
pageOrientation"portrait""portrait"（縦向き）または "landscape"（横向き）です。
pageMargins{ top: 1, right: 1, bottom: 1, left: 1 }余白をインチ単位で指定します。
paginationShowPageNumberstrueページ表示でページ番号を表示します。
paginationShowPageCounttrueページ番号とともに "of N" を表示します。
docxExporttrue.docx 出力を有効にします。ブラウザー内で作成し、サーバーは不要です。
wordExporttrueWord 互換の HTML 出力を有効にします。
documentImporttrue.docx の取り込みを有効にします。
pdfExporttrueベクター形式のタグ付き PDF 出力を有効にします。
html2pdfScriptUrlnullラスター PDF 出力用の html2pdf のパスです。省略するとベクター出力のみになります。
markdownExportEnabledtrueMarkdown としてのコピー・ダウンロードを有効にします。
emailWrapWidth640メール用 HTML 出力のテーブル幅です。
emailInlineProperties[ … ]メールクライアント向けに要素へインライン化する CSS プロパティです。
watermarkText"DRAFT"透かしのテキストです。
watermarkImagenull透かし画像です。テキストの透かしより優先します。
watermarkMode"tile""tile"、または中央に 1 つ表示します。
watermarkOpacity0.18透かしの不透明度（0〜1）です。
watermarkAngle-30回転角度（度）です。
watermarkColor"#94a3b8"透かしの色です。
watermarkFontSize48透かしのフォントサイズ（ピクセル）です。
watermarkPrintfalse印刷時にも透かしを含めます。

リゾルバーで独自のデータソースを提供できます。通常の関数なので、エンドポイントと認証情報を自分で管理できます。

オプション既定値説明
autoEmbedEnabledtrue貼り付けた YouTube や Vimeo の URL をレスポンシブな埋め込みに変換します。
autoEmbedResolvernull(url) => https の埋め込み URL、拒否する場合は null。独自のプロバイダーを追加できます。
bookmarkResolvernull(url) => リンクプレビューカードのメタデータ。
bookmarkFaviconService"/favicon-proxy?domain="ブックマークカードのファビコン取得先です。自分のプロキシを指定してください。
diagramResolvernullMermaid のレンダラーを指定します。付属していません。
diagramSamples[ … ]挿入ダイアログに表示する図の初期サンプルです。
drawingWidth640描画プラグイン（drawing.js、次のリリース）：キャンバスの幅（CSS ピクセル）です。
drawingHeight360描画プラグイン（次のリリース）：キャンバスの高さ（CSS ピクセル）です。
drawingColors[6 colours]描画プラグイン（次のリリース）：ペンとマーカーに表示する色見本です。
text_insertdrawing"Drawing"描画プラグイン（次のリリース）：insertdrawing ボタンのツールバーラベルです。
chipResolvernull(query) => スマートチップの項目。
chipDateFormatnull日付チップの書式文字列です。
mergeFields[ … ]使用できる差し込みフィールドです。
mergeFieldPrefix"{{"開始区切り文字です。
mergeFieldSuffix"}}"終了区切り文字です。
mergeFieldMissing"placeholder"フィールドに値がない場合に表示する内容です。

言語、方向、アクセシビリティ

エディターには 67 言語が付属しています。方向とアクセシビリティの動作も設定できます。

オプション既定値説明
defaultTextDirectionnull"ltr"、"rtl"、または継承する場合は null です。
textDirectionAutoDetectfalse入力中のテキストから方向を検出します。
textDirectionSwapAligntrue方向が反転したら配置を左右反転します。
rtlUserInterface"auto"RTL ロケールでツールバーとダイアログを左右反転します。
a11yEnhancetrueエディターの UI にアクセシブル名とロールを付けます。
dialogA11ytrueダイアログ内のフォーカストラップとラベル設定です。
keyboardA11ytrueツールバーの tabindex を移動させ、Tab でエディターから出られるようにします。
readAloudRate1.0読み上げ速度です。
readAloudHighlighttrue読み上げ中のテキストを強調します。
textPartLanguages24 languagesLanguage ドロップダウンの言語です：[{ code, label, dir }]。WCAG 3.1.2。
textPartLanguageHighlighttrue編集中、言語を指定した語句に点線の下線を付けます。エディター内だけで、保存しません。

編集領域と複数領域

キャレットを置くノードがない位置への移動と、1 つのツールバーによる複数の編集領域の操作です。

オプション既定値説明
gapCursorKeystrue文書の端にあるテーブルなど、キャレットを閉じ込めるブロックから矢印・Home・End キーで出られるようにします。
gapCursorClicktrueコンテンツ周囲の空白をクリックして段落を挿入します。
gapCursorHinttrue2 つのブロック間の高さゼロの境界に挿入の目印を表示します。
multiRootGroupnull同じグループ名のインスタンスを、1 つのツールバーを共有するエディターとして動作させます。
multiRootNamecontainer idグループ API（getHTML、focusRoot など）で使う領域名です。
multiRootToolbarHostnullアクティブなツールバーの移動先要素（または id）です。null なら移動しません。
layoutTableOutlinetrue編集中、レイアウト用テーブルを破線で囲みます。role="presentation" のテーブルは仕様上見えないため、編集対象を確認する唯一の方法です。エディター内だけの表示です。
shadowStyleAdoptiontrueエディターのスタイルシートを、それを含むシャドウルートにコピーします。文書のスタイルは境界を越えないため、無効にすると編集はできますが全スタイルが失われます。シャドウルート外では処理しません。
shadowStyleSourcesnullシャドウ境界の内側へ追加でコピーするスタイルシート URL（独自のスキンの上書き用）です。文字列または配列です。

独自の CSS からのスタイル

設定に再入力せず、ページのスタイルシートにあるクラスから Quick Styles の一覧を作ります。

オプション既定値説明
importStylesfalse全体のスイッチです。ユーティリティ CSS のページではクラス一覧が膨大になるため、明示的に有効にします。
importStylesSheetsnull読み込むスタイルシートです。href と照合する文字列・正規表現、または関数を指定します。null は読み取り可能なすべてです。
importStylesExclude/^(rte|ck|mce|…)/エディター CSS の自動除外に加えて適用するクラス名の拒否リストです。
importStylesFilternull(className, selector, bucket) => false で除外し、文字列で表示名を変更します。
importStylesReplacefalse設定済みスタイルへの追加ではなく置換を行います。
importStylesLimit100各ドロップダウンの上限です。除外した項目は報告し、黙って切り詰めません。

コンテンツの安全性と検証

フィルタリングと検証です。セキュリティレビューで確認する設定です。

オプション既定値説明
contentSanitizertrue入力・出力・ライブ DOM の許可リストフィルターです。有効のままにしてください。
spellCheckEnabledtrue編集領域に spellcheck="true" を付け、ブラウザーのスペルチェックを使います。
spellCheckResolvernull(text) => [{ word, offset, length, suggestions }]。契約している任意のサービスを使えます。
linkCheckResolvernull(urls) => リンクチェック用の到達可能性の結果。
linkCheckMixedContenttruehttps:// のページ内の http:// リンクを警告します。
linkCheckUnsafeSchemes["javascript:", "data:", …]安全でないと報告するスキームです。

リビジョン履歴

名前付きの文書の版をブラウザーに保存し、必要に応じてサーバーへ送信します。

オプション既定値説明
revisionHistoryEnabledtruefalse でリビジョン履歴プラグインを無効にします。
revisionHistoryKey(page path + query)コア 2.6.10 以降：この文書の履歴の保存キーです。特に URL で文書を識別できない CMS ではレコード id を設定してください。以前のビルドはサイト全体で 1 つの一覧を共有していました。
revisionHistoryMaxEntries50保持する版の数です。古いものから削除します。
revisionHistoryAutoSnapshotMs0内容が変わった場合、N ミリ秒ごとに自動で版を保存します。0 なら明示的な要求時だけ保存します。
revisionHistorySnapshotBeforeRestoretrueコア 2.6.10 以降：復元前の内容を "Before restoring …" という版として保存するため、誤った復元を取り消せます。false は未保存の作業を破棄していた以前の動作です。
revisionHistoryUrl""各版を JSON としてこの URL に POST します。
revisionHistoryRequestHeadersnullPOST 用ヘッダーです。オブジェクト、またはそれを返す関数（認証トークンなど）を指定します。
onRevisionHistorySyncErrornull(detail) => POST 失敗時に呼び出します。版はローカルに残します。