DOM
事件的触发用于通知“对变化感兴趣”的代码以影响代码的执行。这些事件可能来自用户的交互(例如:使用鼠标或调整窗口大小)、底层环境状态的改变(例如:电池电量不足或操作系统的媒体事件)和其他的情况。
每个事件都使用继承自 Event 接口的对象来表示,可以包括额外的自定义成员属性及函数,以获取事件发生时相关的更多信息。本文为每个事件都提供了一个表格(靠近顶部的区域),其中包含了指向相关事件接口的链接和其他相关的信息。事件 > 基于 Event 的接口中完整地列出了不同的事件类型。
本文提供了你可能感兴趣的主要事件类型(动画、剪切板、worker 等等)的索引,以及实现这些事件的主要的类。
事件索引
<table class="standard-table"> <tbody> <tr> <th>事件类型</th> <th style="width: 50%">描述</th> <th>文档</th> </tr> <tr> <td>动画</td> <td> <p> 与 <a href="/zh-CN/docs/Web/API/Web_Animations_API">Web 动画 API</a > 相关的事件。 </p> <p> 用于响应动画状态的改变(例如:动画的开始或结束)。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Document#动画事件" ><code>Document</code></a >、<a href="/zh-CN/docs/Web/API/Window#动画事件" ><code>Window</code></a >、<a href="/zh-CN/docs/Web/API/HTMLElement#动画事件" ><code>HTMLElement</code></a > 上触发的事件。 </td> </tr> <tr> <td>异步数据获取</td> <td><p>与数据获取相关的事件。</p></td> <td> 在 <a href="/zh-CN/docs/Web/API/AbortSignal#事件" ><code>AbortSignal</code></a >、<a href="/zh-CN/docs/Web/API/XMLHttpRequest#事件" ><code>XMLHttpRequest</code></a >、<a href="/zh-CN/docs/Web/API/FileReader#事件" ><code>FileReader</code></a > 上触发的事件。 </td> </tr> <tr> <td>剪切板</td> <td> <p> 与<a href="/zh-CN/docs/Web/API/Clipboard_API">剪切板 API</a> 相关的事件。 </p> <p>用于在内容被剪切、复制或粘贴时发出通知。</p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Document#剪切板事件" ><code>Document</code></a >、<a href="/zh-CN/docs/Web/API/Element#剪切板事件" ><code>Element</code></a >、<a href="/zh-CN/docs/Web/API/Window#剪切板事件" ><code>Window</code></a > 上触发的事件。 </td> </tr> <tr> <td>合成(Composition)</td> <td> <p> 与文本输入相关的事件;“间接”输入文本(而不是直接使用常规的键盘输入)。 </p> <p> 例如,使用语音转文字的引擎,或使用特殊的组合键以将键入的内容表示成另一种语言中的字符。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Element#合成事件" ><code>Element</code></a > 上触发的事件。 </td> </tr> <tr> <td>CSS 过渡</td> <td> <p> 与 <a href="/zh-CN/docs/Web/CSS/Guides/Transitions">CSS 过渡</a>相关的事件。 </p> <p> 当 CSS 过渡开始、停止或取消等事件发生时发出通知。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Document#过渡事件" ><code>Document</code></a >、<a href="/zh-CN/docs/Web/API/HTMLElement#过渡事件" ><code>HTMLElement</code></a >、<a href="/zh-CN/docs/Web/API/Window#过渡事件" ><code>Window</code></a > 上触发的事件。 </td> </tr> <tr> <td>数据库</td> <td> <p> 与数据库操作相关的事件:打开、关闭、事务、错误,等等。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/IDBDatabase#事件" ><code>IDBDatabase</code></a >、<a href="/zh-CN/docs/Web/API/IDBOpenDBRequest#事件" ><code>IDBOpenDBRequest</code></a >、<a href="/zh-CN/docs/Web/API/IDBRequest#事件" ><code>IDBRequest</code></a >、<a href="/zh-CN/docs/Web/API/IDBTransaction#事件" ><code>IDBTransaction</code></a > 上触发的事件。 </td> </tr> <tr> <td>DOM 突变</td> <td> <p> 与文档对象模型(DOM)层次结构和节点的修改相关的事件。 </p> </td> <td> <div class="notecard warning"> <p> <strong>警告:</strong> <a href="/zh-CN/docs/Web/API/MutationEvent">突变事件</a>已被弃用。请使用 <a href="/zh-CN/docs/Web/API/MutationObserver" >Mutation Observer</a > 代替。 </p> </div> </td> </tr> <tr> <td>拖放、滚轮</td> <td> <p> 与使用 <a href="/zh-CN/docs/Web/API/HTML_Drag_and_Drop_API" >HTML 拖放 API</a > 和<a href="/zh-CN/docs/Web/API/WheelEvent">滚轮事件</a>相关的事件。 </p> <p> 拖动和滚轮事件派生自鼠标事件。虽然它们在使用鼠标滚轮和拖放时触发,但它们也可以和其他合适的硬件一起使用。 </p> </td> <td> <p> 拖放事件在 <a href="/zh-CN/docs/Web/API/Document#拖放事件" ><code>Document</code></a > 上触发。 </p> <p> 滚轮事件在 <a href="/zh-CN/docs/Web/API/Element/wheel_event" ><code>Element</code></a > 上触发。 </p> </td> </tr> <tr> <td>焦点</td> <td><p>与元素获得和失去焦点相关的事件。</p></td> <td> 在 <a href="/zh-CN/docs/Web/API/Element#聚焦事件" ><code>Element</code></a >、<a href="/zh-CN/docs/Web/API/Window#聚焦事件"><code>Window</code></a > 上触发的事件。 </td> </tr> <tr> <td>表单</td> <td> <p>与创建、重置和提交表单相关的事件。</p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/HTMLFormElement#事件" ><code>HTMLFormElement</code></a > 上触发。 </td> </tr> <tr> <td>全屏</td> <td> <p> 与 <a href="/zh-CN/docs/Web/API/Fullscreen_API">全屏 API</a> 相关的事件。 </p> <p> 用于在全屏和窗口模式切换或切换期间发生错误时发送通知。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Document#fullscreen_events" ><code>Document</code></a >、<a href="/zh-CN/docs/Web/API/Element#fullscreen_events" ><code>Element</code></a > 上触发的事件。 </td> </tr> <tr> <td>游戏手柄(Gamepad)</td> <td> <p> 与<a href="/zh-CN/docs/Web/API/Gamepad_API">游戏手柄 API</a> 相关的事件。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Window#gamepad_事件" ><code>Window</code></a > 上触发的事件。 </td> </tr> <tr> <td>手势</td> <td> <p> 建议使用 <a href="/zh-CN/docs/Web/API/Touch_events">Touch 事件</a>来实现手势。 </p> </td> <td> <p> 在 <a href="/zh-CN/docs/Web/API/Document#触摸事件" ><code>Document</code></a >、<a href="/zh-CN/docs/Web/API/Element#触摸事件" ><code>Element</code></a > 上触发的事件。 </p> <p>此外还有一些非标准的手势事件:</p> <ul> <li> WebKit 非标准的、在 <a href="/zh-CN/docs/Web/API/Element#触摸事件" ><code>Element</code></a > 上的事件: <a href="/zh-CN/docs/Web/API/Element/gesturestart_event" ><code>gesturestart</code> 事件</a >、<a href="/zh-CN/docs/Web/API/Element/gesturechange_event" ><code>gesturechange</code> 事件</a >、<a href="/zh-CN/docs/Web/API/Element/gestureend_event" ><code>gestureend</code> 事件</a >。 </li> </ul> </td> </tr> <tr> <td>History</td> <td> <p> 与<a href="/zh-CN/docs/Web/API/History_API">历史记录 API</a> 相关的事件。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Window#历史记录事件" ><code>Window</code></a > 上触发的事件。 </td> </tr> <tr> <td>HTML 元素内容显示管理</td> <td> <p> 与显示或文本元素状态的改变相关的事件。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/HTMLDetailsElement#事件" ><code>HTMLDetailsElement</code></a >、<a href="/zh-CN/docs/Web/API/HTMLDialogElement#事件" ><code>HTMLDialogElement</code></a >、<a href="/zh-CN/docs/Web/API/HTMLSlotElement#事件" ><code>HTMLSlotElement</code></a > 上触发的事件。 </td> </tr> <tr> <td>输入</td> <td> <p> 与 HTML input 元素(如:input、select 或 textarea)相关的事件。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/HTMLElement#输入事件" ><code>HTMLElement</code></a >、<a href="/zh-CN/docs/Web/API/HTMLInputElement#事件" ><code>HTMLInputElement</code></a > 上触发的事件。 </td> </tr> <tr> <td>键盘</td> <td> <p> 与使用<a href="/zh-CN/docs/Web/API/KeyboardEvent">键盘</a>相关的事件。 </p> <p>用于在按键向上、向下或仅仅只是按下时发出通知。</p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Document#键盘事件" ><code>Document</code></a >、<a href="/zh-CN/docs/Web/API/Element#键盘事件" ><code>Element</code></a > 上触发的事件。 </td> </tr> <tr> <td>加载/卸载文档</td> <td><p>在加载或卸载文档时触发的事件。</p></td> <td> <p> 在 <a href="/zh-CN/docs/Web/API/Document#加载和卸载事件" ><code>Document</code></a > 和 <a href="/zh-CN/docs/Web/API/Window#加载和卸载事件" ><code>Window</code></a > 上触发的事件。 </p> </td> </tr> <tr> <td>清单</td> <td> <p> 与安装<a href="/zh-CN/docs/Web/Progressive_web_apps/Manifest">渐进式 web 应用清单</a>相关的事件。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Window#清单事件" ><code>Window</code></a > 上触发的事件 </td> </tr> <tr id="media"> <td>媒体</td> <td> <p> 与媒体使用(包括<a href="/zh-CN/docs/Web/API/Media_Capture_and_Streams_API#事件" >媒体捕捉与媒体流 API</a >、<a href="/zh-CN/docs/Web/API/Web_Audio_API#事件">Web 音频 API</a>、<a href="/zh-CN/docs/Web/API/Picture-in-Picture_API#事件" >画中画 API</a >,等等)相关的事件。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/ScriptProcessorNode#事件" ><code>ScriptProcessorNode</code></a >、<a href="/zh-CN/docs/Web/API/HTMLMediaElement#事件" ><code>HTMLMediaElement</code></a >、<a href="/zh-CN/docs/Web/API/AudioTrackList#事件" ><code>AudioTrackList</code></a >、<a href="/zh-CN/docs/Web/API/AudioScheduledSourceNode#事件" ><code>AudioScheduledSourceNode</code></a >、<a href="/zh-CN/docs/Web/API/MediaRecorder#事件" ><code>MediaRecorder</code></a >、<a href="/zh-CN/docs/Web/API/MediaStream#事件" ><code>MediaStream</code></a >、<a href="/zh-CN/docs/Web/API/MediaStreamTrack" ><code>MediaStreamTrack</code></a >、<a href="/zh-CN/docs/Web/API/VideoTrackList#事件" ><code>VideoTrackList</code></a >、<a href="/zh-CN/docs/Web/API/HTMLTrackElement#事件" ><code>HTMLTrackElement</code></a >、<a href="/zh-CN/docs/Web/API/OfflineAudioContext#事件" ><code>OfflineAudioContext</code></a >、<a href="/zh-CN/docs/Web/API/TextTrack#事件"><code>TextTrack</code></a >、<a href="/zh-CN/docs/Web/API/TextTrackList#事件" ><code>TextTrackList</code></a >、<a href="/zh-CN/docs/Web/HTML/Reference/Elements/audio#事件">Element/audio</a>, <a href="/zh-CN/docs/Web/HTML/Reference/Elements/video#事件">Element/video</a> 上触发的事件。 </td> </tr> <tr> <td>消息传递</td> <td> <p> 与窗口从另一个浏览上下文接受消息相关的事件。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Window#消息事件" ><code>Window</code></a > 上触发的事件。 </td> </tr> <tr> <td>鼠标</td> <td> <p> 与<a href="/zh-CN/docs/Web/API/MouseEvent">计算机鼠标</a>相关的事件。 </p> <p> 用于在鼠标单机、双击、释放、按下、右击、移入移除元素/文本、选择等动作时发出通知。 </p> <p> 指针事件为鼠标事件提供了与硬件无关的代替方案。拖放和滚轮事件派生自鼠标事件。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Element#鼠标事件" ><code>Element</code></a > 上触发的事件。 </td> </tr> <tr> <td>网络连接</td> <td><p>与获得和失去网络连接相关的事件。</p></td> <td> <p> 在 <a href="/zh-CN/docs/Web/API/Window#连接事件" ><code>Window</code></a > 上触发的事件。 </p> <p> 在 <a href="/zh-CN/docs/Web/API/NetworkInformation#事件" ><code>NetworkInformation</code></a >(<a href="/zh-CN/docs/Web/API/Network_Information_API" >网络状况 API</a >)上触发的事件。 </p> </td> </tr> <tr> <td>支付</td> <td> <p> 与<a href="/zh-CN/docs/Web/API/Payment_Request_API" >支付请求 API</a > 相关的事件。 </p> </td> <td> <p> 在 <a href="/zh-CN/docs/Web/API/PaymentRequest#事件" ><code>PaymentRequest</code></a >、<a href="/zh-CN/docs/Web/API/PaymentResponse#事件" ><code>PaymentResponse</code></a > 上触发的事件。 </p> </td> </tr> <tr> <td>性能</td> <td> <p> 与任何性能相关的规范分组为<a href="/zh-CN/docs/Web/API/Performance_API" >性能 API</a > 的相关事件。 </p> </td> <td> <p> 在 <a href="/zh-CN/docs/Web/API/Performance#事件" ><code>Performance</code></a > 上触发的事件。 </p> </td> </tr> <tr> <td>指针</td> <td> <p> 与<a href="/zh-CN/docs/Web/API/Pointer_events">指针事件 API</a> 相关的事件。 </p> <p> 提供来自指针设备(包括鼠标、触控、笔/触控笔)的与硬件无关的通知。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Document#指针事件" ><code>Document</code></a >、<a href="/zh-CN/docs/Web/API/HTMLElement#指针事件" ><code>HTMLElement</code></a > 上触发的事件。 </td> </tr> <tr> <td>打印</td> <td><p>与打印相关的事件。</p></td> <td> 在 <a href="/zh-CN/docs/Web/API/Window#打印事件"><code>Window</code></a > 上触发的事件。 </td> </tr> <tr> <td>Promise rejection</td> <td> <p> 在任意 JavaScript promise 被拒绝时,发送到全局脚本上下文的事件。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Window#promise_拒绝事件" ><code>Window</code></a > 上触发的事件。 </td> </tr> <tr> <td>网络套接字</td> <td> <p> 与 <a href="/zh-CN/docs/Web/API/WebSockets_API">WebSocket API</a> 相关的事件。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/WebSocket#事件"><code>Websocket</code></a > 上触发的事件。 </td> </tr> <tr> <td>SVG</td> <td><p>与 SVG 图像相关的事件。</p></td> <td> <p> 在 <a href="/zh-CN/docs/Web/API/SVGElement#事件" ><code>SVGElement</code></a >、<a href="/zh-CN/docs/Web/API/SVGAnimationElement#事件" ><code>SVGAnimationElement</code></a >、<a href="/zh-CN/docs/Web/API/SVGGraphicsElement#事件" ><code>SVGGraphicsElement</code></a > 上触发的事件。 </p> </td> </tr> <tr> <td>文本选择</td> <td> <p> 与选择文本相关的<a href="/zh-CN/docs/Web/API/Selection">选择 API</a> 事件。 </p> </td> <td> <p> 事件(<code>selectionchange</code>)在 HTMLTextAreaElement/selectionchange_event、HTMLInputElement/selectionchange_event 上触发。 </p> </td> </tr> <tr> <td>触控</td> <td> <p> 与<a href="/zh-CN/docs/Web/API/Touch_events">触摸事件 API</a> 相关的事件。 </p> <p> 在与触控屏交互(例如:用手指或触控笔)时发出通知。与 <a href="/zh-CN/docs/Web/API/Force_Touch_events#事件" >Force Touch API</a > 无关。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/Document#触摸事件" ><code>Document</code></a >、<a href="/zh-CN/docs/Web/API/Element#触摸事件" ><code>Element</code></a > 上触发的事件。 </td> </tr> <tr> <td>虚拟现实</td> <td> <p> 与 <a href="/zh-CN/docs/Web/API/WebXR_Device_API">WebXR 设备 API</a> 相关的事件。 </p> <div class="notecard warning"> <p> <strong>警告:</strong> <a href="/zh-CN/docs/Web/API/WebVR_API">WebVR API</a>(和关联的 <a href="/zh-CN/docs/Web/API/Window#webvr_事件" ><code>Window</code> 事件</a >)已被弃用。 </p> </div> </td> <td> 在 <a href="/zh-CN/docs/Web/API/XRSystem#事件"><code>XRSystem</code></a >、<a href="/zh-CN/docs/Web/API/XRSession#事件"><code>XRSession</code></a >、<a href="/zh-CN/docs/Web/API/XRReferenceSpace#事件" ><code>XRReferenceSpace</code></a > 上触发的事件。 </td> </tr> <tr> <td>RTC(实时通信)</td> <td> <p> 与 <a href="/zh-CN/docs/Web/API/WebRTC_API">WebRTC API</a> 相关的事件。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/RTCDataChannel#事件" ><code>RTCDataChannel</code></a >、<a href="/zh-CN/docs/Web/API/RTCDTMFSender#事件" ><code>RTCDTMFSender</code></a >、<a href="/zh-CN/docs/Web/API/RTCIceTransport#事件" ><code>RTCIceTransport</code></a >、<a href="/zh-CN/docs/Web/API/RTCPeerConnection#事件" ><code>RTCPeerConnection</code></a > 上触发的事件。 </td> </tr> <tr> <td>服务器发送事件</td> <td> <p> 与<a href="/zh-CN/docs/Web/API/Server-sent_events" >服务器发送事件 API</a > 相关的事件。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/EventSource#事件" ><code>EventSource</code></a > 上触发的事件。 </td> </tr> <tr> <td>语音合成</td> <td> <p> 与 <a href="/zh-CN/docs/Web/API/Web_Speech_API">Web 语音 API</a> 相关的事件。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/SpeechSynthesisUtterance#事件" ><code>SpeechSynthesisUtterance</code></a > 上触发的事件。 </td> </tr> <tr> <td>Worker</td> <td> <p> 与 <a href="/zh-CN/docs/Web/API/Web_Workers_API">Web Worker API</a>、<a href="/zh-CN/docs/Web/API/Service_Worker_API">Service Worker API</a >、<a href="/zh-CN/docs/Web/API/Broadcast_Channel_API" >Broadcast Channel API</a > 和 <a href="/zh-CN/docs/Web/API/Channel_Messaging_API" >Channel Messaging API</a > 相关的事件。 </p> <p> 用于相应新消息和消息发送的错误。Service worker 还可以收到其他事件的通知,包括推送通知、用户单击显示的通知 push 订阅失效、从内容索引中删除条目,等等。 </p> </td> <td> 在 <a href="/zh-CN/docs/Web/API/ServiceWorkerGlobalScope#事件" ><code>ServiceWorkerGlobalScope</code></a >、<a href="/zh-CN/docs/Web/API/DedicatedWorkerGlobalScope#事件" ><code>DedicatedWorkerGlobalScope</code></a >、<a href="/zh-CN/docs/Web/API/SharedWorkerGlobalScope#事件" ><code>SharedWorkerGlobalScope</code></a >、<a href="/zh-CN/docs/Web/API/WorkerGlobalScope#事件" ><code>WorkerGlobalScope</code></a >、<a href="/zh-CN/docs/Web/API/Worker#事件"><code>Worker</code></a >、<a href="/zh-CN/docs/Web/API/BroadcastChannel#事件" ><code>BroadcastChannel</code></a >、<a href="/zh-CN/docs/Web/API/MessagePort#事件" ><code>MessagePort</code></a > 上触发的事件。 </td> </tr> </tbody> </table>
创建和派发事件
除了由内置接口触发的事件外,你还可以自己创建和派发 DOM 事件。这类事件通常称为合成事件,以区别于由浏览器触发的事件。
创建自定义事件
可以使用 Event 构造函数按如下方式来创建事件:
const event = new Event("build");
// 监听事件。
elem.addEventListener("build", (e) => {
/* … */
});
// 派发事件。
elem.dispatchEvent(event);
此代码示例使用了 EventTarget.dispatchEvent() 方法。
添加自定义数据——CustomEvent()
要向事件对象添加更多数据,可以使用 CustomEvent 接口,并通过 detail 属性传递自定义数据。例如,可以这样创建事件:
const event = new CustomEvent("build", { detail: elem.dataset.time });
这样你就可以在事件监听器中访问额外的数据:
function eventHandler(e) {
console.log(`时间为:${e.detail}`);
}
添加自定义数据——继承 Event
Event 接口也可以被子类化。这对于代码复用、处理更复杂的自定义数据,甚至为事件添加方法都特别有用。
class BuildEvent extends Event {
#buildTime;
constructor(buildTime) {
super("build");
this.#buildTime = buildTime;
}
get buildTime() {
return this.#buildTime;
}
}
这段代码定义了一个具有只读属性和固定事件类型的 BuildEvent 类。
然后可以按如下方式创建该事件:
const event = new BuildEvent(elem.dataset.time);
然后,可以使用自定义属性在事件监听器中访问这些附加数据:
function eventHandler(e) {
console.log(`时间为:${e.buildTime}`);
}
事件冒泡
通常情况下,我们希望从子元素触发事件,并让父元素捕获该事件;此外,还可以选择性地将数据包含在事件中:
<form>
<textarea></textarea>
</form>
const form = document.querySelector("form");
const textarea = document.querySelector("textarea");
// 创建一个新事件,允许冒泡,并在“detail”属性中传递任何你想要的数据
const eventAwesome = new CustomEvent("awesome", {
bubbles: true,
detail: { text: () => textarea.value },
});
// form 元素监听自定义的“awesome”事件,然后输出传递的 text() 方法的结果
form.addEventListener("awesome", (e) => console.log(e.detail.text()));
// 当用户输入时,form 内的 textarea 派发/触发事件,以自身为起点
textarea.addEventListener("input", (e) => e.target.dispatchEvent(eventAwesome));
动态创建和派发事件
元素可以监听尚未创建的事件:
<form>
<textarea></textarea>
</form>
const form = document.querySelector("form");
const textarea = document.querySelector("textarea");
form.addEventListener("awesome", (e) => console.log(e.detail.text()));
textarea.addEventListener("input", function () {
// 动态创建并派发/触发事件
// 注意:此外,我们还使用了“函数表达式”(而不是“箭头函数表达式”),这样“this”将代表该元素
this.dispatchEvent(
new CustomEvent("awesome", {
bubbles: true,
detail: { text: () => textarea.value },
}),
);
});
触发内置事件
此示例演示如何使用 DOM 方法模拟复选框的点击操作(即通过编程方式生成点击事件)。查看示例运行效果。
function simulateClick() {
const event = new MouseEvent("click", {
view: window,
bubbles: true,
cancelable: true,
});
const cb = document.getElementById("checkbox");
const cancelled = !cb.dispatchEvent(event);
if (cancelled) {
// 某个处理器调用了 preventDefault。
alert("已取消");
} else {
// 没有处理器调用 preventDefault。
alert("未取消");
}
}
注册事件处理器
有两种推荐的方法来注册处理器。可以通过将事件处理器代码分配给目标元素的相应 onevent 属性,或者使用 EventTarget.addEventListener 方法将处理器注册为元素的监听器,从而使事件处理器代码在事件触发时运行。无论哪种方式,处理器都会收到一个符合 Event 接口(或派生接口)的对象。主要区别在于,可以使用事件监听器方法可以添加(或删除)多个事件处理器。
[!WARNING] 不建议使用第三种方法,即使用 HTML onevent 属性设置事件处理器的方法!这种方法会增加标记的复杂度,降低代码的可读性,并增加调试难度。更多信息请参阅内联事件处理器。
使用 onevent 属性
按照惯例,触发事件的 JavaScript 对象都有相应的“onevent”属性(通过在事件名称前加上“on”来命名)。当事件被触发时,这些属性会被调用以运行相关的处理器代码,也可以由你自己的代码直接调用。
要设置事件处理器代码,只需将其分配给相应的 onevent 属性即可。每个元素中的每个事件只能分配一个事件处理器。如有需要,可以通过将另一个函数分配给同一属性来替换处理器。
以下示例展示了如何使用 onclick 属性为 click 事件设置 greet() 函数。
const btn = document.querySelector("button");
function greet(event) {
console.log("greet:", event);
}
btn.onclick = greet;
请注意,表示事件的对象会作为第一个参数传递给事件处理器。此事件对象实现或派生自 Event 接口。
EventTarget.addEventListener
在元素上设置事件处理器最灵活的方法是使用 EventTarget.addEventListener 方法。这种方法允许为元素分配多个监听器,并且如果需要,可以使用 EventTarget.removeEventListener 移除已注册的监听器。
[!NOTE] 通过添加和移除事件处理器,你可以实现例如让同一个按钮在不同情况下执行不同操作。此外,在更复杂的程序中,清理旧的或未使用的事件处理器可以提高运行效率。
以下示例展示了如何将 greet() 函数设置为 click 事件的监听器/事件处理器(如果需要,可以使用匿名函数表达式代替命名函数)。请再次注意,事件会作为第一个参数传递给事件处理器。
const btn = document.querySelector("button");
function greet(event) {
console.log("greet:", event);
}
btn.addEventListener("click", greet);
该方法还可以接受额外的参数/选项,用于控制事件捕获和移除的方式。更多信息请参见 EventTarget.addEventListener 的参考文档。
使用 AbortSignal
事件监听器的一个显著特性是能够使用中止信号同时清理多个事件处理器。
这是通过向所有你希望一起移除的事件处理器的 EventTarget/addEventListener() 调用传递相同的 AbortSignal 来实现的。然后你可以调用拥有该 AbortSignal 的控制器的 AbortController/abort(),这将移除所有使用该信号添加的事件处理器。例如,添加一个可以使用 AbortSignal 移除的事件处理器:
const controller = new AbortController();
btn.addEventListener(
"click",
(event) => {
console.log("greet:", event);
},
{ signal: controller.signal },
); // 向此处理器传递 AbortSignal
然后就可以像这样移除这个事件处理器:
controller.abort(); // 移除与此控制器关联的任何/所有事件处理器
多个事件处理器的交互
onevent IDL 属性(例如 element.onclick = ...)和 HTML onevent 内容属性(例如 <button onclick="...">)都指向同一个单一处理器槽。由于 HTML 在 JavaScript 能够访问同一元素之前已加载完毕,因此通常 JavaScript 会覆盖 HTML 中指定的内容。使用 EventTarget.addEventListener 添加的处理器是独立的。使用 onevent 不会移除或替换使用 addEventListener() 添加的监听器,反之亦然。
当事件被派发时,监听器会分阶段调用。共有两个阶段:捕获和冒泡。在捕获阶段,事件从最高祖先元素开始,沿 DOM 树向下移动,直到到达目标元素。在冒泡阶段,事件沿相反方向移动。事件监听器默认在冒泡阶段监听,可以通过在 addEventListener() 中指定 capture: true 来使其在捕获阶段监听。在同一个阶段内,监听器将按照它们被注册的顺序运行。onevent 处理器在首次变为非 null 时即被注册;后续的重新赋值仅会改变其回调函数,不会改变其在顺序中的位置。
调用 Event.stopPropagation() 可以阻止在传播链后续环节中调用其他元素上的监听器。Event.stopImmediatePropagation() 还会阻止调用同一元素上剩余的监听器。
规范
参见
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
