@varlet/use 3.14.1 → 3.15.0-alpha.1776572752298
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.cjs +383 -533
- package/lib/index.d.cts +88 -74
- package/lib/index.d.ts +88 -74
- package/lib/index.js +368 -508
- package/package.json +7 -7
package/lib/index.d.cts
CHANGED
|
@@ -1,107 +1,121 @@
|
|
|
1
|
-
import * as vue from
|
|
2
|
-
import {
|
|
3
|
-
import { MotionState } from
|
|
1
|
+
import * as _$vue from "vue";
|
|
2
|
+
import { ComponentInternalInstance, ComputedRef, Ref, WatchSource, WritableComputedRef } from "vue";
|
|
3
|
+
import { MotionState } from "@varlet/shared";
|
|
4
4
|
|
|
5
|
+
//#region src/useEventListener.d.ts
|
|
5
6
|
type UseEventListenerTarget = EventTarget | Ref<EventTarget | undefined | null> | (() => EventTarget);
|
|
6
7
|
interface UseEventListenerOptions {
|
|
7
|
-
|
|
8
|
-
|
|
8
|
+
capture?: boolean;
|
|
9
|
+
passive?: boolean;
|
|
9
10
|
}
|
|
10
11
|
declare function useEventListener<T extends keyof DocumentEventMap>(target: UseEventListenerTarget, type: T, listener: (event: DocumentEventMap[T]) => void, options?: UseEventListenerOptions): () => void;
|
|
11
12
|
declare function useEventListener(target: UseEventListenerTarget, type: string, listener: EventListener, options?: UseEventListenerOptions): () => void;
|
|
12
|
-
|
|
13
|
+
//#endregion
|
|
14
|
+
//#region src/useClickOutside.d.ts
|
|
13
15
|
type UseClickOutsideTarget = Element | Ref<Element | undefined | null> | (() => Element);
|
|
14
16
|
declare function useClickOutside(target: UseClickOutsideTarget, type: string, listener: EventListener): void;
|
|
15
|
-
|
|
17
|
+
//#endregion
|
|
18
|
+
//#region src/onSmartMounted.d.ts
|
|
16
19
|
declare function onSmartMounted(hook: () => void): void;
|
|
17
|
-
|
|
20
|
+
//#endregion
|
|
21
|
+
//#region src/onSmartUnmounted.d.ts
|
|
18
22
|
declare function onSmartUnmounted(hook: () => void): void;
|
|
19
|
-
|
|
23
|
+
//#endregion
|
|
24
|
+
//#region src/useChildren.d.ts
|
|
20
25
|
interface UseChildrenBaseProvider<C> {
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
26
|
+
childInstances: ComponentInternalInstance[];
|
|
27
|
+
collect(instance: ComponentInternalInstance, childProvider: C): void;
|
|
28
|
+
clear(instance: ComponentInternalInstance, childProvider: C): void;
|
|
24
29
|
}
|
|
25
30
|
declare function useChildren<P, C>(key: symbol | string): {
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
31
|
+
length: ComputedRef<number>;
|
|
32
|
+
childProviders: C[];
|
|
33
|
+
bindChildren: (parentProvider: P) => void;
|
|
29
34
|
};
|
|
30
|
-
|
|
35
|
+
//#endregion
|
|
36
|
+
//#region src/useParent.d.ts
|
|
31
37
|
declare function keyInProvides(key: symbol | string): boolean;
|
|
32
38
|
declare function useParent<P, C>(key: symbol | string): {
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
39
|
+
index: null;
|
|
40
|
+
parentProvider: null;
|
|
41
|
+
bindParent: null;
|
|
36
42
|
} | {
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
43
|
+
index: ComputedRef<number>;
|
|
44
|
+
parentProvider: Omit<P & UseChildrenBaseProvider<C>, "childInstances" | "collect" | "clear">;
|
|
45
|
+
bindParent: (childProvider: C) => void;
|
|
40
46
|
};
|
|
41
|
-
|
|
47
|
+
//#endregion
|
|
48
|
+
//#region src/onWindowResize.d.ts
|
|
42
49
|
declare function onWindowResize(listener: EventListener): void;
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
50
|
+
//#endregion
|
|
51
|
+
//#region src/useInitialized.d.ts
|
|
52
|
+
declare function useInitialized<T>(source: WatchSource<T>, value: T): _$vue.Ref<boolean, boolean>;
|
|
53
|
+
//#endregion
|
|
54
|
+
//#region src/useTouch.d.ts
|
|
46
55
|
type TouchDirection = 'horizontal' | 'vertical';
|
|
47
56
|
declare function useTouch(): {
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
57
|
+
startX: _$vue.Ref<number, number>;
|
|
58
|
+
startY: _$vue.Ref<number, number>;
|
|
59
|
+
deltaX: _$vue.Ref<number, number>;
|
|
60
|
+
deltaY: _$vue.Ref<number, number>;
|
|
61
|
+
offsetX: _$vue.Ref<number, number>;
|
|
62
|
+
offsetY: _$vue.Ref<number, number>;
|
|
63
|
+
prevX: _$vue.Ref<number, number>;
|
|
64
|
+
prevY: _$vue.Ref<number, number>;
|
|
65
|
+
moveX: _$vue.Ref<number, number>;
|
|
66
|
+
moveY: _$vue.Ref<number, number>;
|
|
67
|
+
direction: _$vue.Ref<TouchDirection | undefined, TouchDirection | undefined>;
|
|
68
|
+
touching: _$vue.Ref<boolean, boolean>;
|
|
69
|
+
dragging: _$vue.Ref<boolean, boolean>;
|
|
70
|
+
startTime: _$vue.Ref<number, number>;
|
|
71
|
+
distance: _$vue.Ref<number, number>;
|
|
72
|
+
resetTouch: () => void;
|
|
73
|
+
startTouch: (event: TouchEvent) => void;
|
|
74
|
+
moveTouch: (event: TouchEvent) => void;
|
|
75
|
+
endTouch: () => void;
|
|
76
|
+
isReachTop: (element: Element | Window) => boolean;
|
|
77
|
+
isReachBottom: (element: Element, offset?: number) => boolean;
|
|
69
78
|
};
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
79
|
+
//#endregion
|
|
80
|
+
//#region src/useId.d.ts
|
|
81
|
+
declare function useId(): _$vue.Ref<string | undefined, string | undefined>;
|
|
82
|
+
//#endregion
|
|
83
|
+
//#region src/useClientId.d.ts
|
|
84
|
+
declare function useClientId(): _$vue.Ref<string | undefined, string | undefined>;
|
|
85
|
+
//#endregion
|
|
86
|
+
//#region src/useWindowSize.d.ts
|
|
75
87
|
interface UseWindowSizeOptions {
|
|
76
|
-
|
|
77
|
-
|
|
88
|
+
initialWidth?: number;
|
|
89
|
+
initialHeight?: number;
|
|
78
90
|
}
|
|
79
91
|
declare function useWindowSize(options?: UseWindowSizeOptions): {
|
|
80
|
-
|
|
81
|
-
|
|
92
|
+
width: _$vue.Ref<number, number>;
|
|
93
|
+
height: _$vue.Ref<number, number>;
|
|
82
94
|
};
|
|
83
|
-
|
|
95
|
+
//#endregion
|
|
96
|
+
//#region src/useVModel.d.ts
|
|
84
97
|
interface UseVModelOptions<P, K extends keyof P> {
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
98
|
+
passive?: boolean;
|
|
99
|
+
eventName?: string;
|
|
100
|
+
defaultValue?: P[K];
|
|
101
|
+
emit?: (event: string, value: P[K]) => void;
|
|
89
102
|
}
|
|
90
103
|
declare function useVModel<P extends Record<string, any>, K extends keyof P>(props: P, key: K, options?: UseVModelOptions<P, K>): WritableComputedRef<P[K]> | Ref<P[K]>;
|
|
91
|
-
|
|
104
|
+
//#endregion
|
|
105
|
+
//#region src/useMotion.d.ts
|
|
92
106
|
interface UseMotionOptions {
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
107
|
+
from: number | (() => number);
|
|
108
|
+
to: number | (() => number);
|
|
109
|
+
duration?: number | (() => number);
|
|
110
|
+
timingFunction?: (v: number) => number;
|
|
111
|
+
onFinished?: (value: number) => void;
|
|
98
112
|
}
|
|
99
113
|
declare function useMotion(options: UseMotionOptions): {
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
114
|
+
value: _$vue.Ref<number, number>;
|
|
115
|
+
state: _$vue.Ref<MotionState, MotionState>;
|
|
116
|
+
start: () => void;
|
|
117
|
+
pause: () => void;
|
|
118
|
+
reset: () => void;
|
|
105
119
|
};
|
|
106
|
-
|
|
107
|
-
export { TouchDirection, UseChildrenBaseProvider, UseClickOutsideTarget, UseEventListenerOptions, UseEventListenerTarget, UseMotionOptions, UseVModelOptions, UseWindowSizeOptions, keyInProvides, onSmartMounted, onSmartUnmounted, onWindowResize, useChildren, useClickOutside, useClientId, useEventListener, useId, useInitialized, useMotion, useParent, useTouch, useVModel, useWindowSize };
|
|
120
|
+
//#endregion
|
|
121
|
+
export { TouchDirection, UseChildrenBaseProvider, UseClickOutsideTarget, UseEventListenerOptions, UseEventListenerTarget, UseMotionOptions, UseVModelOptions, UseWindowSizeOptions, keyInProvides, onSmartMounted, onSmartUnmounted, onWindowResize, useChildren, useClickOutside, useClientId, useEventListener, useId, useInitialized, useMotion, useParent, useTouch, useVModel, useWindowSize };
|
package/lib/index.d.ts
CHANGED
|
@@ -1,107 +1,121 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
3
|
-
import {
|
|
1
|
+
import { MotionState } from "@varlet/shared";
|
|
2
|
+
import * as _$vue from "vue";
|
|
3
|
+
import { ComponentInternalInstance, ComputedRef, Ref, WatchSource, WritableComputedRef } from "vue";
|
|
4
4
|
|
|
5
|
+
//#region src/useEventListener.d.ts
|
|
5
6
|
type UseEventListenerTarget = EventTarget | Ref<EventTarget | undefined | null> | (() => EventTarget);
|
|
6
7
|
interface UseEventListenerOptions {
|
|
7
|
-
|
|
8
|
-
|
|
8
|
+
capture?: boolean;
|
|
9
|
+
passive?: boolean;
|
|
9
10
|
}
|
|
10
11
|
declare function useEventListener<T extends keyof DocumentEventMap>(target: UseEventListenerTarget, type: T, listener: (event: DocumentEventMap[T]) => void, options?: UseEventListenerOptions): () => void;
|
|
11
12
|
declare function useEventListener(target: UseEventListenerTarget, type: string, listener: EventListener, options?: UseEventListenerOptions): () => void;
|
|
12
|
-
|
|
13
|
+
//#endregion
|
|
14
|
+
//#region src/useClickOutside.d.ts
|
|
13
15
|
type UseClickOutsideTarget = Element | Ref<Element | undefined | null> | (() => Element);
|
|
14
16
|
declare function useClickOutside(target: UseClickOutsideTarget, type: string, listener: EventListener): void;
|
|
15
|
-
|
|
17
|
+
//#endregion
|
|
18
|
+
//#region src/onSmartMounted.d.ts
|
|
16
19
|
declare function onSmartMounted(hook: () => void): void;
|
|
17
|
-
|
|
20
|
+
//#endregion
|
|
21
|
+
//#region src/onSmartUnmounted.d.ts
|
|
18
22
|
declare function onSmartUnmounted(hook: () => void): void;
|
|
19
|
-
|
|
23
|
+
//#endregion
|
|
24
|
+
//#region src/useChildren.d.ts
|
|
20
25
|
interface UseChildrenBaseProvider<C> {
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
26
|
+
childInstances: ComponentInternalInstance[];
|
|
27
|
+
collect(instance: ComponentInternalInstance, childProvider: C): void;
|
|
28
|
+
clear(instance: ComponentInternalInstance, childProvider: C): void;
|
|
24
29
|
}
|
|
25
30
|
declare function useChildren<P, C>(key: symbol | string): {
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
31
|
+
length: ComputedRef<number>;
|
|
32
|
+
childProviders: C[];
|
|
33
|
+
bindChildren: (parentProvider: P) => void;
|
|
29
34
|
};
|
|
30
|
-
|
|
35
|
+
//#endregion
|
|
36
|
+
//#region src/useParent.d.ts
|
|
31
37
|
declare function keyInProvides(key: symbol | string): boolean;
|
|
32
38
|
declare function useParent<P, C>(key: symbol | string): {
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
39
|
+
index: null;
|
|
40
|
+
parentProvider: null;
|
|
41
|
+
bindParent: null;
|
|
36
42
|
} | {
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
43
|
+
index: ComputedRef<number>;
|
|
44
|
+
parentProvider: Omit<P & UseChildrenBaseProvider<C>, "childInstances" | "collect" | "clear">;
|
|
45
|
+
bindParent: (childProvider: C) => void;
|
|
40
46
|
};
|
|
41
|
-
|
|
47
|
+
//#endregion
|
|
48
|
+
//#region src/onWindowResize.d.ts
|
|
42
49
|
declare function onWindowResize(listener: EventListener): void;
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
50
|
+
//#endregion
|
|
51
|
+
//#region src/useInitialized.d.ts
|
|
52
|
+
declare function useInitialized<T>(source: WatchSource<T>, value: T): _$vue.Ref<boolean, boolean>;
|
|
53
|
+
//#endregion
|
|
54
|
+
//#region src/useTouch.d.ts
|
|
46
55
|
type TouchDirection = 'horizontal' | 'vertical';
|
|
47
56
|
declare function useTouch(): {
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
57
|
+
startX: _$vue.Ref<number, number>;
|
|
58
|
+
startY: _$vue.Ref<number, number>;
|
|
59
|
+
deltaX: _$vue.Ref<number, number>;
|
|
60
|
+
deltaY: _$vue.Ref<number, number>;
|
|
61
|
+
offsetX: _$vue.Ref<number, number>;
|
|
62
|
+
offsetY: _$vue.Ref<number, number>;
|
|
63
|
+
prevX: _$vue.Ref<number, number>;
|
|
64
|
+
prevY: _$vue.Ref<number, number>;
|
|
65
|
+
moveX: _$vue.Ref<number, number>;
|
|
66
|
+
moveY: _$vue.Ref<number, number>;
|
|
67
|
+
direction: _$vue.Ref<TouchDirection | undefined, TouchDirection | undefined>;
|
|
68
|
+
touching: _$vue.Ref<boolean, boolean>;
|
|
69
|
+
dragging: _$vue.Ref<boolean, boolean>;
|
|
70
|
+
startTime: _$vue.Ref<number, number>;
|
|
71
|
+
distance: _$vue.Ref<number, number>;
|
|
72
|
+
resetTouch: () => void;
|
|
73
|
+
startTouch: (event: TouchEvent) => void;
|
|
74
|
+
moveTouch: (event: TouchEvent) => void;
|
|
75
|
+
endTouch: () => void;
|
|
76
|
+
isReachTop: (element: Element | Window) => boolean;
|
|
77
|
+
isReachBottom: (element: Element, offset?: number) => boolean;
|
|
69
78
|
};
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
79
|
+
//#endregion
|
|
80
|
+
//#region src/useId.d.ts
|
|
81
|
+
declare function useId(): _$vue.Ref<string | undefined, string | undefined>;
|
|
82
|
+
//#endregion
|
|
83
|
+
//#region src/useClientId.d.ts
|
|
84
|
+
declare function useClientId(): _$vue.Ref<string | undefined, string | undefined>;
|
|
85
|
+
//#endregion
|
|
86
|
+
//#region src/useWindowSize.d.ts
|
|
75
87
|
interface UseWindowSizeOptions {
|
|
76
|
-
|
|
77
|
-
|
|
88
|
+
initialWidth?: number;
|
|
89
|
+
initialHeight?: number;
|
|
78
90
|
}
|
|
79
91
|
declare function useWindowSize(options?: UseWindowSizeOptions): {
|
|
80
|
-
|
|
81
|
-
|
|
92
|
+
width: _$vue.Ref<number, number>;
|
|
93
|
+
height: _$vue.Ref<number, number>;
|
|
82
94
|
};
|
|
83
|
-
|
|
95
|
+
//#endregion
|
|
96
|
+
//#region src/useVModel.d.ts
|
|
84
97
|
interface UseVModelOptions<P, K extends keyof P> {
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
98
|
+
passive?: boolean;
|
|
99
|
+
eventName?: string;
|
|
100
|
+
defaultValue?: P[K];
|
|
101
|
+
emit?: (event: string, value: P[K]) => void;
|
|
89
102
|
}
|
|
90
103
|
declare function useVModel<P extends Record<string, any>, K extends keyof P>(props: P, key: K, options?: UseVModelOptions<P, K>): WritableComputedRef<P[K]> | Ref<P[K]>;
|
|
91
|
-
|
|
104
|
+
//#endregion
|
|
105
|
+
//#region src/useMotion.d.ts
|
|
92
106
|
interface UseMotionOptions {
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
107
|
+
from: number | (() => number);
|
|
108
|
+
to: number | (() => number);
|
|
109
|
+
duration?: number | (() => number);
|
|
110
|
+
timingFunction?: (v: number) => number;
|
|
111
|
+
onFinished?: (value: number) => void;
|
|
98
112
|
}
|
|
99
113
|
declare function useMotion(options: UseMotionOptions): {
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
114
|
+
value: _$vue.Ref<number, number>;
|
|
115
|
+
state: _$vue.Ref<MotionState, MotionState>;
|
|
116
|
+
start: () => void;
|
|
117
|
+
pause: () => void;
|
|
118
|
+
reset: () => void;
|
|
105
119
|
};
|
|
106
|
-
|
|
107
|
-
export { TouchDirection, UseChildrenBaseProvider, UseClickOutsideTarget, UseEventListenerOptions, UseEventListenerTarget, UseMotionOptions, UseVModelOptions, UseWindowSizeOptions, keyInProvides, onSmartMounted, onSmartUnmounted, onWindowResize, useChildren, useClickOutside, useClientId, useEventListener, useId, useInitialized, useMotion, useParent, useTouch, useVModel, useWindowSize };
|
|
120
|
+
//#endregion
|
|
121
|
+
export { TouchDirection, UseChildrenBaseProvider, UseClickOutsideTarget, UseEventListenerOptions, UseEventListenerTarget, UseMotionOptions, UseVModelOptions, UseWindowSizeOptions, keyInProvides, onSmartMounted, onSmartUnmounted, onWindowResize, useChildren, useClickOutside, useClientId, useEventListener, useId, useInitialized, useMotion, useParent, useTouch, useVModel, useWindowSize };
|