blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

types(@vant/use): improve Ref param typing

Browse Source
This commit is contained in:
chenjiahan 2020-10-09 20:32:31 +08:00
parent 767ca80499
commit 14d2826cc7
6 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/vant-use/src/useClickAway/README.md
View File

@ -60,7 +60,7 @@ export default {
```ts ```ts
function useClickAway( function useClickAway(
target: Element | Ref<Element>, target: Element | Ref<Element | undefined>,
listener: EventListener, listener: EventListener,
options?: Options options?: Options
): void; ): void;

4
packages/vant-use/src/useClickAway/index.ts
View File

@ -7,7 +7,7 @@ export type UseClickAwayOptions = {
}; };
export function useClickAway( export function useClickAway(
target: Element | Ref<Element>, target: Element | Ref<Element | undefined>,
listener: EventListener, listener: EventListener,
options: UseClickAwayOptions = {} options: UseClickAwayOptions = {}
) { ) {
@ -19,7 +19,7 @@ export function useClickAway(
const onClick = (event: Event) => { const onClick = (event: Event) => {
const element = unref(target); const element = unref(target);
if (!element.contains(event.target as Node)) { if (element && !element.contains(event.target as Node)) {
listener(event); listener(event);
} }
}; };

2
packages/vant-use/src/useRect/README.md
View File

@ -31,7 +31,7 @@ export default {
### 类型定义 ### 类型定义
```ts ```ts
function useRect((Element | Window) | Ref<Element | Window>): DOMRect; function useRect((Element | Window) | Ref<Element | Window | undefined>): DOMRect;
``` ```
### 返回值 ### 返回值

4
packages/vant-use/src/useRect/index.ts
View File

@ -5,7 +5,7 @@ function isWindow(val: unknown): val is Window {
} }
export const useRect = ( export const useRect = (
elementRef: (Element | Window) | Ref<Element | Window> elementRef: (Element | Window) | Ref<Element | Window | undefined>
) => { ) => {
const element = unref(elementRef); const element = unref(elementRef);
@ -23,7 +23,7 @@ export const useRect = (
}; };
} }
if (element.getBoundingClientRect) { if (element && element.getBoundingClientRect) {
return element.getBoundingClientRect(); return element.getBoundingClientRect();
} }

4
packages/vant-use/src/useScrollParent/README.md
View File

@ -37,7 +37,9 @@ export default {
### 类型定义 ### 类型定义
```ts ```ts
function useScrollParent(element: Ref<Element>): Ref<Element>; function useScrollParent(
element: Ref<Element | undefined>
): Ref<Element | Window | undefined>;
``` ```
### 参数 ### 参数

2
packages/vant-use/src/useScrollParent/index.ts
View File

@ -39,7 +39,7 @@ function getScrollParent(el: Element, root: ScrollElement = window) {
} }
export function useScrollParent(el: Ref<Element | undefined>) { export function useScrollParent(el: Ref<Element | undefined>) {
const scrollParent = ref(); const scrollParent = ref<Element | Window>();
onMounted(() => { onMounted(() => {
if (el.value) { if (el.value) {