VueHook PlususeEventListener
管理事件的 Hook
代码演示
基于元素用法
基于浏览器用法
API
useEventListener(
eventName: string,
handler: (ev: Event) => void,
options?: Options,
);
useEventListener(
eventName: string,
handler: (ev: Event) => void,
options?: Options,
);
Params
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| eventName | 事件名称 | string | - |
| handler | 处理函数 | (ev: Event) => void | - |
| options | 设置(可选) | Options | - |
Options
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| target | DOM 节点或者 ref | (() => Element) | Element | React.MutableRefObject<Element> | Window | Document | window |
| capture | 可选项，listener 会在该类型的事件捕获阶段传播到该 EventTarget 时触发。 | boolean | false |
| once | 可选项，listener 在添加之后最多只调用一次。如果是 true，listener 会在其被调用之后自动移除。 | boolean | false |
| passive | 可选项，设置为 true 时，表示 listener 永远不会调用 preventDefault() 。如果 listener 仍然调用了这个函数，客户端将会忽略它并抛出一个控制台警告。 | boolean |