diff --git a/packages/vant-use/src/useClickAway/README.md b/packages/vant-use/src/useClickAway/README.md index 714215ac2..da40115ea 100644 --- a/packages/vant-use/src/useClickAway/README.md +++ b/packages/vant-use/src/useClickAway/README.md @@ -59,15 +59,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/useCountDown/README.md b/packages/vant-use/src/useCountDown/README.md index 669ad6ca7..fed6980ce 100644 --- a/packages/vant-use/src/useCountDown/README.md +++ b/packages/vant-use/src/useCountDown/README.md @@ -62,13 +62,13 @@ export default { ### 类型定义 ```ts -function useCountDown(options: UseCountDownOptions): CountDown; - -type UseCountDownOptions = { - time: number; - millisecond?: boolean; - onChange?: (current: CurrentTime) => void; - onFinish?: () => void; +type CurrentTime = { + days: number; + hours: number; + total: number; + minutes: number; + seconds: number; + milliseconds: number; }; type CountDown = { @@ -78,14 +78,14 @@ type CountDown = { current: ComputedRef; }; -type CurrentTime = { - days: number; - hours: number; - total: number; - minutes: number; - seconds: number; - milliseconds: number; +type UseCountDownOptions = { + time: number; + millisecond?: boolean; + onChange?: (current: CurrentTime) => void; + onFinish?: () => void; }; + +function useCountDown(options: UseCountDownOptions): CountDown; ``` ### 参数 diff --git a/packages/vant-use/src/useEventListener/README.md b/packages/vant-use/src/useEventListener/README.md index 3df4ecbcd..d59536ba7 100644 --- a/packages/vant-use/src/useEventListener/README.md +++ b/packages/vant-use/src/useEventListener/README.md @@ -33,17 +33,17 @@ export default { ## 类型定义 ```ts -function useEventListener( - type: string, - listener: EventListener, - options?: Options -): void; - type Options = { target?: EventTarget | Ref; capture?: boolean; passive?: boolean; }; + +function useEventListener( + type: string, + listener: EventListener, + options?: Options +): void; ``` ## API diff --git a/packages/vant-use/src/usePageVisibility/README.md b/packages/vant-use/src/usePageVisibility/README.md index 8af5a42c9..e389c31e0 100644 --- a/packages/vant-use/src/usePageVisibility/README.md +++ b/packages/vant-use/src/usePageVisibility/README.md @@ -26,9 +26,9 @@ export default { ### 类型定义 ```ts -function usePageVisibility(): Ref; - type VisibilityState = 'visible' | 'hidden'; + +function usePageVisibility(): Ref; ``` ### 返回值 diff --git a/packages/vant-use/src/useRect/README.md b/packages/vant-use/src/useRect/README.md index ff2a3236b..33dfa36df 100644 --- a/packages/vant-use/src/useRect/README.md +++ b/packages/vant-use/src/useRect/README.md @@ -31,7 +31,9 @@ export default { ### 类型定义 ```ts -function useRect((Element | Window) | Ref): DOMRect; +function useRect( + element: Element | Window | Ref +): DOMRect; ``` ### 返回值 diff --git a/packages/vant-use/src/useRect/index.ts b/packages/vant-use/src/useRect/index.ts index 16494cdbc..228549ffc 100644 --- a/packages/vant-use/src/useRect/index.ts +++ b/packages/vant-use/src/useRect/index.ts @@ -16,9 +16,9 @@ function makeDOMRect(width: number, height: number) { } export const useRect = ( - elementRef: (Element | Window) | Ref + elementOrRef: Element | Window | Ref ) => { - const element = unref(elementRef); + const element = unref(elementOrRef); if (isWindow(element)) { const width = element.innerWidth; diff --git a/packages/vant-use/src/useRelation/useParent.ts b/packages/vant-use/src/useRelation/useParent.ts index c1b4816be..ac8ec53fa 100644 --- a/packages/vant-use/src/useRelation/useParent.ts +++ b/packages/vant-use/src/useRelation/useParent.ts @@ -23,10 +23,7 @@ export function useParent(key: string | symbol) { const { link, unlink, internalChildren, ...rest } = parent; link(instance); - - onUnmounted(() => { - unlink(instance); - }); + onUnmounted(() => unlink(instance)); const index = computed(() => internalChildren.indexOf(instance)); diff --git a/packages/vant-use/src/utils.ts b/packages/vant-use/src/utils.ts index 5610d0112..2bc2417b5 100644 --- a/packages/vant-use/src/utils.ts +++ b/packages/vant-use/src/utils.ts @@ -24,7 +24,5 @@ export function cancelRaf(id: number) { // double raf for animation export function doubleRaf(fn: FrameRequestCallback): void { - raf(() => { - raf(fn); - }); + raf(() => raf(fn)); }