diff --git a/packages/vant-use/src/useClickAway/README.zh-CN.md b/packages/vant-use/src/useClickAway/README.zh-CN.md index 4c0fb049a..260d48b34 100644 --- a/packages/vant-use/src/useClickAway/README.zh-CN.md +++ b/packages/vant-use/src/useClickAway/README.zh-CN.md @@ -57,15 +57,15 @@ export default { ## 类型定义 ```ts -type Options = { - eventName?: string; -}; - function useClickAway( target: Element | Ref, listener: EventListener, options?: Options ): void; + +type Options = { + eventName?: string; +}; ``` ## 参数 diff --git a/packages/vant-use/src/useEventListener/README.zh-CN.md b/packages/vant-use/src/useEventListener/README.zh-CN.md index d9ffa0394..08ddcaf82 100644 --- a/packages/vant-use/src/useEventListener/README.zh-CN.md +++ b/packages/vant-use/src/useEventListener/README.zh-CN.md @@ -33,17 +33,17 @@ export default { ## 类型定义 ```ts -type Options = { - target?: EventTarget | Ref; - capture?: boolean; - passive?: boolean; -}; - function useEventListener( type: string, listener: EventListener, options?: Options ): void; + +type Options = { + target?: EventTarget | Ref; + capture?: boolean; + passive?: boolean; +}; ``` ## 参数 diff --git a/packages/vant-use/src/usePageVisibility/README.zh-CN.md b/packages/vant-use/src/usePageVisibility/README.zh-CN.md new file mode 100644 index 000000000..3e97d7951 --- /dev/null +++ b/packages/vant-use/src/usePageVisibility/README.zh-CN.md @@ -0,0 +1,36 @@ +# usePageVisibility + +获取页面的可见状态。 + +## 代码演示 + +### 基本用法 + +```js +import { watch } from 'vue'; +import { usePageVisibility } from '@vant/use'; + +export default { + setup() { + const pageVisibility = usePageVisibility(); + + watch(pageVisibility, (value) => { + console.log('visibility: ', value); + }); + }, +}; +``` + +## 类型定义 + +```ts +function usePageVisibility(): Ref; + +type VisibilityState = 'visible' | 'hidden'; +``` + +## 返回值 + +| 参数 | 说明 | 类型 | 默认值 | +| --- | --- | --- | --- | +| visibilityState | 页面当前的可见状态,`visible` 为可见,`hidden` 为隐藏 | _Ref_ | - |