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

浏览器兼容性

另见