Element: compositionupdate 事件

Baseline 已廣泛支援

此特性已相當成熟,可在許多裝置和瀏覽器版本上使用。自 ⁨2015 年 7 月⁩以來,各瀏覽器均已提供此特性。

當文字合成系統(如輸入法編輯器)控制的文字合成會話中接收到新字元時,會觸發 compositionupdate 事件。

例如,當用戶使用拼音輸入法編輯器輸入中文字元時,可能會觸發此事件。

語法

在諸如 addEventListener() 之類的方法中使用事件名稱,或設定事件處理程式屬性。

js
addEventListener("compositionupdate", (event) => { })

oncompositionupdate = (event) => { }

事件型別

一個 CompositionEvent 物件。繼承自 UIEventEvent

Event UIEvent CompositionEvent

事件屬性

此介面還繼承了其父介面 UIEvent 及其祖先介面 Event 的屬性。

CompositionEvent.data 只讀

返回由觸發事件的輸入法生成的字元;具體返回值取決於生成 CompositionEvent 物件的事件型別。

CompositionEvent.locale 只讀 已棄用

返回當前輸入法的區域設定(例如,如果組合與 IME 相關,則為鍵盤佈局區域設定)。

示例

js
const inputElement = document.querySelector('input[type="text"]');

inputElement.addEventListener("compositionupdate", (event) => {
  console.log(`generated characters were: ${event.data}`);
});

即時示例

HTML

html
<div class="control">
  <label for="example">
    First select textbox, then to open IME:
    <ul>
      <li>on macOS type <kbd>option</kbd> + <kbd>`</kbd></li>
      <li>on Windows type <kbd>windows</kbd> + <kbd>.</kbd></li>
    </ul>
  </label>
  <input type="text" id="example" name="example" />
</div>

<div class="event-log">
  <label for="eventLog">Event log:</label>
  <textarea
    readonly
    class="event-log-contents"
    rows="8"
    cols="25"
    id="eventLog"></textarea>
  <button class="clear-log">Clear</button>
</div>

JavaScript

js
const inputElement = document.querySelector('input[type="text"]');
const log = document.querySelector(".event-log-contents");
const clearLog = document.querySelector(".clear-log");

clearLog.addEventListener("click", () => {
  log.textContent = "";
});

function handleEvent(event) {
  log.textContent += `${event.type}: ${event.data}\n`;
}

inputElement.addEventListener("compositionstart", handleEvent);
inputElement.addEventListener("compositionupdate", handleEvent);
inputElement.addEventListener("compositionend", handleEvent);

結果

規範

規範
UI 事件
# event-type-compositionupdate

瀏覽器相容性

另見