diff --git a/packages/vant-use/src/useClickAway/README.zh-CN.md b/packages/vant-use/src/useClickAway/README.zh-CN.md index d1db34b32..4c0fb049a 100644 --- a/packages/vant-use/src/useClickAway/README.zh-CN.md +++ b/packages/vant-use/src/useClickAway/README.zh-CN.md @@ -31,9 +31,7 @@ export default { 通过 `eventName` 选项可以自定义需要监听的事件类型。 ```html - +
``` ```js @@ -56,6 +54,20 @@ export default { }; ``` +## 类型定义 + +```ts +type Options = { + eventName?: string; +}; + +function useClickAway( + target: Element | Ref, + listener: EventListener, + options?: Options +): void; +``` + ## 参数 | 参数 | 说明 | 类型 | 默认值 | diff --git a/packages/vant-use/src/useEventListener/README.zh-CN.md b/packages/vant-use/src/useEventListener/README.zh-CN.md new file mode 100644 index 000000000..d9ffa0394 --- /dev/null +++ b/packages/vant-use/src/useEventListener/README.zh-CN.md @@ -0,0 +1,63 @@ +# useEventListener + +用于事件绑定,在 `mounted` 和 `activated` 时调用 `addEventListener`,在 `unmounted` 和 `deactivated` 时调用 `removeEventListener`。 + +## 代码演示 + +### 基本用法 + +```js +import { ref } from 'vue'; +import { useEventListener } from '@vant/use'; + +export default { + setup() { + // 在 window 上绑定 resize 事件 + // 未指定监听对象时,默认会监听 window 的事件 + useEventListener('resize', () => { + console.log('window resize'); + }); + + // 在 body 节点上绑定 click 事件 + useEventListener( + 'click', + () => { + console.log('click body'); + }, + { target: document.body } + ); + }, +}; +``` + +## 类型定义 + +```ts +type Options = { + target?: EventTarget | Ref; + capture?: boolean; + passive?: boolean; +}; + +function useEventListener( + type: string, + listener: EventListener, + options?: Options +): void; +``` + +## 参数 + +| 参数 | 说明 | 类型 | 默认值 | +| -------- | ------------------------ | --------------- | ------ | +| type | 监听的事件类型 | _string_ | - | +| listener | 点击外部时触发的回调函数 | _EventListener_ | - | +| options | 可选的配置项 | _Options_ | - | + +## Options + +| 参数 | 说明 | 类型 | 默认值 | +| --- | --- | --- | --- | +| target | 绑定事件的节点 | \_EventTarget | Ref\_ | `window` | +| capture | 是否在事件捕获阶段触发 | _boolean_ | `false` | +| passive | 设置为 `true` 时,表示 `listener` 永远不会调用 `preventDefault` | _boolean_ | `false` |