編集コンテキスト API
利用可能性は限定的
この機能はベースラインではありません。最も広く使用されているブラウザーの一部で動作しません。
もっと多くのブラウザーがこの機能に対応してほしいですか? 理由を教えてください。
Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。
編集コンテキスト API (EditContext API) を使用すると、インプットメソッドエディター (IME) による文字変換や絵文字ピッカーなど、プラットフォーム固有の編集関連 UI を含む高度なテキスト入力に対応したリッチテキストエディターをウェブ上に構築できます。
編集コンテキスト API を使うと、任意の技術で独自の編集可能なテキスト領域を描画できます。
概念
アプリケーションの編集可能な領域にテキストを入力する際には、複数の要素が関わります。
- ユーザー
-
ユーザーは、キーボード、マウス、音声、その他の入力方式を使ってテキストを入力します。
- インプットメソッドソフトウェア
-
インプットメソッドソフトウェアは、ユーザーの入力をテキストに変換します。たとえば、標準キーボードからのキー入力を日本語、中国語、韓国語の文字に変換する インプットメソッドエディター (IME) などです。
- OS のテキスト入力サービス
-
オペレーティングシステムのテキスト入力サービスは、入力方式ソフトウェアとアプリケーションをつなぎます。
- アプリケーションのテキスト編集コンテキスト
-
アプリケーションのテキスト編集コンテキストは、編集中のテキストの状態を提供します。この状態には、テキスト本体、現在の選択範囲、アプリの UI におけるテキストの位置などの情報が含まれます。
- アプリケーションの編集可能な領域
-
アプリケーションの編集可能な領域は、テキストを表示する UI 要素です。
最初の 3 つの要素はオペレーティングシステムによって提供されますが、編集可能な領域とテキスト編集コンテキストを提供するのはアプリケーションの責任です。
ウェブ上の編集可能な領域には、<textarea> 要素、<input> 要素、または contenteditable 属性が true に設定された要素がよく使われます。これらの要素では、ブラウザーがテキスト編集コンテキストを自動的に提供するため、ウェブ開発者がテキスト入力をサポートするコードを書く必要はありません。
独自の編集可能な領域の作成
ウェブ開発者は、編集コンテキスト API を使って独自の編集可能な領域を作成することもできます。たとえば、<canvas> 要素を使ってテキストを描画するリッチテキストエディターを作成できます。この場合、テキスト入力をサポートするコードを自分で書く必要があります。
ウェブ開発者の責任
<canvas> にテキストを描画する場合も、一連の DOM 要素にテキストを表示する場合も、独自の編集可能な領域を実装するなら、代わりに <textarea> を使用したときにブラウザーが通常提供する機能を自分で提供する責任があります。具体的には、次のとおりです。
- テキストを描画する。
- 選択範囲を描画する(
<canvas>ではなく DOM 要素で編集可能な領域を構築した場合、選択範囲はブラウザーが描画します)。 - 選択範囲が変わったときに、OS のテキスト入力サービスに知らせる。
- UI 内でテキストがどこにあるかを OS のテキスト入力サービスに知らせ、入力方式ソフトウェアが正しい位置に IME の変換ウィンドウを表示できるようにする。
- ユーザーが IME の変換ウィンドウ内でテキストを入力している間に、特定のテキスト書式を適用する。
その代わりに、編集コンテキスト API は選択した DOM 要素を編集可能にし、文書のフォーカス順に含めます。また、編集中のテキストの状態に関する情報も提供するため、独自の方法でテキストを描画できます。提供される情報には、次のものがあります。
- 現在のテキスト内容。
- 現在の選択範囲。
- IME による文字変換中かどうか、およびテキスト書式を適用する必要があるかどうか。
アクセシビリティ
編集コンテキスト API を <canvas> 要素と一緒に使用する場合は、支援技術からもテキストにアクセスできるようにしてください。スクリーンリーダーは <canvas> 要素内のテキストを読み上げられません。たとえば、スクリーンリーダー向けに、画面外の DOM 要素にテキストの別の表示を用意できます。
モデルとビューのアーキテクチャ
編集コンテキスト API を使うときは、編集機能をモデルとビューのアーキテクチャとして構築すると便利です。
EditContext インスタンスは、編集可能な領域のモデルを表します。テキスト入力を受け取ったときや選択範囲が変わったときに、その内部状態が更新されます。
EditContext インスタンスが提供する情報を使って、ビューにテキストと選択範囲を描画できます。ただし、ビューをモデルと完全に一致させる必要はありません。テキストは自由な方法で描画できます。
インターフェイス
EditContext-
EditContextインターフェイスは、textareaなどの標準的な編集可能な領域を使うときに通常はブラウザーが透過的に提供するテキスト編集コンテキストを、JavaScript で表現したものです。EditContextは、テキスト本体、現在の選択範囲、アプリの UI におけるテキストの位置など、編集中のテキストの状態を提供します。 TextFormat-
TextFormatインターフェイスは、ユーザーが IME の変換ウィンドウ内でテキストを入力しているときに、テキスト範囲へ適用する特定の書式を表します。 TextUpdateEvent-
TextUpdateEventインターフェイスは、EditContextインスタンスに関連付けられた編集可能なテキスト領域での、テキストまたは選択範囲の更新を表す DOM イベントです。 TextFormatUpdateEvent-
TextFormatUpdateEventインターフェイスは、EditContextインスタンスに関連付けられた編集可能な領域で入力中のテキストに、インプットメソッドエディター (IME) ウィンドウが適用しようとするテキスト書式のリストを表す DOM イベントです。 CharacterBoundsUpdateEvent-
CharacterBoundsUpdateEventインターフェイスは、EditContextインスタンスに関連付けられた編集可能な領域内の特定の文字の境界情報を求める、オペレーティングシステムからの要求を表す DOM イベントです。
他のインターフェイスへの拡張
HTMLElement.editContext-
HTMLElementインターフェイスのeditContextプロパティは、要素に関連付けられたEditContextオブジェクトを取得および設定します。
例
>基本的な使い方
編集コンテキスト API を使うには、まず EditContext インターフェイスのインスタンスを作成し、editContext プロパティを使って編集可能にしたい DOM 要素に関連付けます。DOM 要素には <div> や <canvas> 要素を含む任意の要素を指定できます。
<canvas id="editor-canvas"></canvas>
const canvas = document.getElementById("editor-canvas");
const editContext = new EditContext();
canvas.editContext = editContext;
EditContext インスタンスは、一度に 1 つの DOM 要素にしか関連付けられません。
EditContext インスタンスを DOM 要素に関連付けると、その要素はフォーカス可能になり、文書のフォーカス順に含まれます。ユーザーは好みの入力方式でその要素にテキストを入力でき、EditContext インスタンスが発生させるイベントを使ってテキストと選択範囲を描画できます。
仕様書
| 仕様書 |
|---|
| EditContext API> # dom-editcontext> |