@varlet/use 3.20.6 → 3.20.8
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.d.cts +27 -28
- package/lib/index.d.ts +27 -28
- package/package.json +4 -4
package/lib/index.d.cts
CHANGED
|
@@ -1,31 +1,31 @@
|
|
|
1
1
|
import { ComponentInternalInstance, ComputedRef, Ref, WatchSource, WritableComputedRef } from "vue";
|
|
2
2
|
import { MotionState } from "@varlet/shared";
|
|
3
3
|
//#region src/useEventListener.d.ts
|
|
4
|
-
type UseEventListenerTarget = EventTarget | Ref<EventTarget | undefined | null> | (() => EventTarget);
|
|
5
|
-
interface UseEventListenerOptions {
|
|
4
|
+
export type UseEventListenerTarget = EventTarget | Ref<EventTarget | undefined | null> | (() => EventTarget);
|
|
5
|
+
export interface UseEventListenerOptions {
|
|
6
6
|
capture?: boolean;
|
|
7
7
|
passive?: boolean;
|
|
8
8
|
}
|
|
9
|
-
declare function useEventListener<T extends keyof DocumentEventMap>(target: UseEventListenerTarget, type: T, listener: (event: DocumentEventMap[T]) => void, options?: UseEventListenerOptions): () => void;
|
|
10
|
-
declare function useEventListener(target: UseEventListenerTarget, type: string, listener: EventListener, options?: UseEventListenerOptions): () => void;
|
|
9
|
+
export declare function useEventListener<T extends keyof DocumentEventMap>(target: UseEventListenerTarget, type: T, listener: (event: DocumentEventMap[T]) => void, options?: UseEventListenerOptions): () => void;
|
|
10
|
+
export declare function useEventListener(target: UseEventListenerTarget, type: string, listener: EventListener, options?: UseEventListenerOptions): () => void;
|
|
11
11
|
//#endregion
|
|
12
12
|
//#region src/useClickOutside.d.ts
|
|
13
|
-
type UseClickOutsideTarget = Element | Ref<Element | undefined | null> | (() => Element);
|
|
14
|
-
declare function useClickOutside(target: UseClickOutsideTarget, type: string, listener: EventListener): void;
|
|
13
|
+
export type UseClickOutsideTarget = Element | Ref<Element | undefined | null> | (() => Element);
|
|
14
|
+
export declare function useClickOutside(target: UseClickOutsideTarget, type: string, listener: EventListener): void;
|
|
15
15
|
//#endregion
|
|
16
16
|
//#region src/onSmartMounted.d.ts
|
|
17
|
-
declare function onSmartMounted(hook: () => void): void;
|
|
17
|
+
export declare function onSmartMounted(hook: () => void): void;
|
|
18
18
|
//#endregion
|
|
19
19
|
//#region src/onSmartUnmounted.d.ts
|
|
20
|
-
declare function onSmartUnmounted(hook: () => void): void;
|
|
20
|
+
export declare function onSmartUnmounted(hook: () => void): void;
|
|
21
21
|
//#endregion
|
|
22
22
|
//#region src/useChildren.d.ts
|
|
23
|
-
interface UseChildrenBaseProvider<C> {
|
|
23
|
+
export interface UseChildrenBaseProvider<C> {
|
|
24
24
|
childInstances: ComponentInternalInstance[];
|
|
25
25
|
collect(instance: ComponentInternalInstance, childProvider: C): void;
|
|
26
26
|
clear(instance: ComponentInternalInstance, childProvider: C): void;
|
|
27
27
|
}
|
|
28
|
-
declare function useChildren<P, C>(key: symbol | string): {
|
|
28
|
+
export declare function useChildren<P, C>(key: symbol | string): {
|
|
29
29
|
length: ComputedRef<number>;
|
|
30
30
|
childInstances: ComponentInternalInstance[];
|
|
31
31
|
childProviders: C[];
|
|
@@ -33,8 +33,8 @@ declare function useChildren<P, C>(key: symbol | string): {
|
|
|
33
33
|
};
|
|
34
34
|
//#endregion
|
|
35
35
|
//#region src/useParent.d.ts
|
|
36
|
-
declare function keyInProvides(key: symbol | string): boolean;
|
|
37
|
-
declare function useParent<P, C>(key: symbol | string): {
|
|
36
|
+
export declare function keyInProvides(key: symbol | string): boolean;
|
|
37
|
+
export declare function useParent<P, C>(key: symbol | string): {
|
|
38
38
|
index: null;
|
|
39
39
|
parentProvider: null;
|
|
40
40
|
bindParent: null;
|
|
@@ -45,14 +45,14 @@ declare function useParent<P, C>(key: symbol | string): {
|
|
|
45
45
|
};
|
|
46
46
|
//#endregion
|
|
47
47
|
//#region src/onWindowResize.d.ts
|
|
48
|
-
declare function onWindowResize(listener: EventListener): void;
|
|
48
|
+
export declare function onWindowResize(listener: EventListener): void;
|
|
49
49
|
//#endregion
|
|
50
50
|
//#region src/useInitialized.d.ts
|
|
51
|
-
declare function useInitialized<T>(source: WatchSource<T>, value: T): import("vue").Ref<boolean, boolean>;
|
|
51
|
+
export declare function useInitialized<T>(source: WatchSource<T>, value: T): import("vue").Ref<boolean, boolean>;
|
|
52
52
|
//#endregion
|
|
53
53
|
//#region src/useTouch.d.ts
|
|
54
|
-
type TouchDirection = 'horizontal' | 'vertical';
|
|
55
|
-
declare function useTouch(): {
|
|
54
|
+
export type TouchDirection = 'horizontal' | 'vertical';
|
|
55
|
+
export declare function useTouch(): {
|
|
56
56
|
startX: import("vue").Ref<number, number>;
|
|
57
57
|
startY: import("vue").Ref<number, number>;
|
|
58
58
|
deltaX: import("vue").Ref<number, number>;
|
|
@@ -77,39 +77,39 @@ declare function useTouch(): {
|
|
|
77
77
|
};
|
|
78
78
|
//#endregion
|
|
79
79
|
//#region src/useId.d.ts
|
|
80
|
-
declare function useId(): import("vue").Ref<string | undefined, string | undefined>;
|
|
80
|
+
export declare function useId(): import("vue").Ref<string | undefined, string | undefined>;
|
|
81
81
|
//#endregion
|
|
82
82
|
//#region src/useClientId.d.ts
|
|
83
|
-
declare function useClientId(): import("vue").Ref<string | undefined, string | undefined>;
|
|
83
|
+
export declare function useClientId(): import("vue").Ref<string | undefined, string | undefined>;
|
|
84
84
|
//#endregion
|
|
85
85
|
//#region src/useWindowSize.d.ts
|
|
86
|
-
interface UseWindowSizeOptions {
|
|
86
|
+
export interface UseWindowSizeOptions {
|
|
87
87
|
initialWidth?: number;
|
|
88
88
|
initialHeight?: number;
|
|
89
89
|
}
|
|
90
|
-
declare function useWindowSize(options?: UseWindowSizeOptions): {
|
|
90
|
+
export declare function useWindowSize(options?: UseWindowSizeOptions): {
|
|
91
91
|
width: import("vue").Ref<number, number>;
|
|
92
92
|
height: import("vue").Ref<number, number>;
|
|
93
93
|
};
|
|
94
94
|
//#endregion
|
|
95
95
|
//#region src/useVModel.d.ts
|
|
96
|
-
interface UseVModelOptions<P, K extends keyof P> {
|
|
96
|
+
export interface UseVModelOptions<P, K extends keyof P> {
|
|
97
97
|
passive?: boolean;
|
|
98
98
|
eventName?: string;
|
|
99
99
|
defaultValue?: P[K];
|
|
100
100
|
emit?: (event: string, value: P[K]) => void;
|
|
101
101
|
}
|
|
102
|
-
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]>;
|
|
102
|
+
export 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]>;
|
|
103
103
|
//#endregion
|
|
104
104
|
//#region src/useMotion.d.ts
|
|
105
|
-
interface UseMotionOptions {
|
|
105
|
+
export interface UseMotionOptions {
|
|
106
106
|
from: number | (() => number);
|
|
107
107
|
to: number | (() => number);
|
|
108
108
|
duration?: number | (() => number);
|
|
109
109
|
timingFunction?: (v: number) => number;
|
|
110
110
|
onFinished?: (value: number) => void;
|
|
111
111
|
}
|
|
112
|
-
declare function useMotion(options: UseMotionOptions): {
|
|
112
|
+
export declare function useMotion(options: UseMotionOptions): {
|
|
113
113
|
value: import("vue").Ref<number, number>;
|
|
114
114
|
state: import("vue").Ref<MotionState, MotionState>;
|
|
115
115
|
start: () => void;
|
|
@@ -118,7 +118,6 @@ declare function useMotion(options: UseMotionOptions): {
|
|
|
118
118
|
};
|
|
119
119
|
//#endregion
|
|
120
120
|
//#region src/useResizeObserver.d.ts
|
|
121
|
-
type UseResizeObserverTarget = Element | Ref<Element | undefined | null> | (() => Element | undefined | null);
|
|
122
|
-
declare function useResizeObserver(target: UseResizeObserverTarget, callback: ResizeObserverCallback): (() => void) | undefined;
|
|
123
|
-
//#endregion
|
|
124
|
-
export { TouchDirection, UseChildrenBaseProvider, UseClickOutsideTarget, UseEventListenerOptions, UseEventListenerTarget, UseMotionOptions, UseResizeObserverTarget, UseVModelOptions, UseWindowSizeOptions, keyInProvides, onSmartMounted, onSmartUnmounted, onWindowResize, useChildren, useClickOutside, useClientId, useEventListener, useId, useInitialized, useMotion, useParent, useResizeObserver, useTouch, useVModel, useWindowSize };
|
|
121
|
+
export type UseResizeObserverTarget = Element | Ref<Element | undefined | null> | (() => Element | undefined | null);
|
|
122
|
+
export declare function useResizeObserver(target: UseResizeObserverTarget, callback: ResizeObserverCallback): (() => void) | undefined;
|
|
123
|
+
//#endregion
|
package/lib/index.d.ts
CHANGED
|
@@ -1,31 +1,31 @@
|
|
|
1
1
|
import { MotionState } from "@varlet/shared";
|
|
2
2
|
import { ComponentInternalInstance, ComputedRef, Ref, WatchSource, WritableComputedRef } from "vue";
|
|
3
3
|
//#region src/useEventListener.d.ts
|
|
4
|
-
type UseEventListenerTarget = EventTarget | Ref<EventTarget | undefined | null> | (() => EventTarget);
|
|
5
|
-
interface UseEventListenerOptions {
|
|
4
|
+
export type UseEventListenerTarget = EventTarget | Ref<EventTarget | undefined | null> | (() => EventTarget);
|
|
5
|
+
export interface UseEventListenerOptions {
|
|
6
6
|
capture?: boolean;
|
|
7
7
|
passive?: boolean;
|
|
8
8
|
}
|
|
9
|
-
declare function useEventListener<T extends keyof DocumentEventMap>(target: UseEventListenerTarget, type: T, listener: (event: DocumentEventMap[T]) => void, options?: UseEventListenerOptions): () => void;
|
|
10
|
-
declare function useEventListener(target: UseEventListenerTarget, type: string, listener: EventListener, options?: UseEventListenerOptions): () => void;
|
|
9
|
+
export declare function useEventListener<T extends keyof DocumentEventMap>(target: UseEventListenerTarget, type: T, listener: (event: DocumentEventMap[T]) => void, options?: UseEventListenerOptions): () => void;
|
|
10
|
+
export declare function useEventListener(target: UseEventListenerTarget, type: string, listener: EventListener, options?: UseEventListenerOptions): () => void;
|
|
11
11
|
//#endregion
|
|
12
12
|
//#region src/useClickOutside.d.ts
|
|
13
|
-
type UseClickOutsideTarget = Element | Ref<Element | undefined | null> | (() => Element);
|
|
14
|
-
declare function useClickOutside(target: UseClickOutsideTarget, type: string, listener: EventListener): void;
|
|
13
|
+
export type UseClickOutsideTarget = Element | Ref<Element | undefined | null> | (() => Element);
|
|
14
|
+
export declare function useClickOutside(target: UseClickOutsideTarget, type: string, listener: EventListener): void;
|
|
15
15
|
//#endregion
|
|
16
16
|
//#region src/onSmartMounted.d.ts
|
|
17
|
-
declare function onSmartMounted(hook: () => void): void;
|
|
17
|
+
export declare function onSmartMounted(hook: () => void): void;
|
|
18
18
|
//#endregion
|
|
19
19
|
//#region src/onSmartUnmounted.d.ts
|
|
20
|
-
declare function onSmartUnmounted(hook: () => void): void;
|
|
20
|
+
export declare function onSmartUnmounted(hook: () => void): void;
|
|
21
21
|
//#endregion
|
|
22
22
|
//#region src/useChildren.d.ts
|
|
23
|
-
interface UseChildrenBaseProvider<C> {
|
|
23
|
+
export interface UseChildrenBaseProvider<C> {
|
|
24
24
|
childInstances: ComponentInternalInstance[];
|
|
25
25
|
collect(instance: ComponentInternalInstance, childProvider: C): void;
|
|
26
26
|
clear(instance: ComponentInternalInstance, childProvider: C): void;
|
|
27
27
|
}
|
|
28
|
-
declare function useChildren<P, C>(key: symbol | string): {
|
|
28
|
+
export declare function useChildren<P, C>(key: symbol | string): {
|
|
29
29
|
length: ComputedRef<number>;
|
|
30
30
|
childInstances: ComponentInternalInstance[];
|
|
31
31
|
childProviders: C[];
|
|
@@ -33,8 +33,8 @@ declare function useChildren<P, C>(key: symbol | string): {
|
|
|
33
33
|
};
|
|
34
34
|
//#endregion
|
|
35
35
|
//#region src/useParent.d.ts
|
|
36
|
-
declare function keyInProvides(key: symbol | string): boolean;
|
|
37
|
-
declare function useParent<P, C>(key: symbol | string): {
|
|
36
|
+
export declare function keyInProvides(key: symbol | string): boolean;
|
|
37
|
+
export declare function useParent<P, C>(key: symbol | string): {
|
|
38
38
|
index: null;
|
|
39
39
|
parentProvider: null;
|
|
40
40
|
bindParent: null;
|
|
@@ -45,14 +45,14 @@ declare function useParent<P, C>(key: symbol | string): {
|
|
|
45
45
|
};
|
|
46
46
|
//#endregion
|
|
47
47
|
//#region src/onWindowResize.d.ts
|
|
48
|
-
declare function onWindowResize(listener: EventListener): void;
|
|
48
|
+
export declare function onWindowResize(listener: EventListener): void;
|
|
49
49
|
//#endregion
|
|
50
50
|
//#region src/useInitialized.d.ts
|
|
51
|
-
declare function useInitialized<T>(source: WatchSource<T>, value: T): import("vue").Ref<boolean, boolean>;
|
|
51
|
+
export declare function useInitialized<T>(source: WatchSource<T>, value: T): import("vue").Ref<boolean, boolean>;
|
|
52
52
|
//#endregion
|
|
53
53
|
//#region src/useTouch.d.ts
|
|
54
|
-
type TouchDirection = 'horizontal' | 'vertical';
|
|
55
|
-
declare function useTouch(): {
|
|
54
|
+
export type TouchDirection = 'horizontal' | 'vertical';
|
|
55
|
+
export declare function useTouch(): {
|
|
56
56
|
startX: import("vue").Ref<number, number>;
|
|
57
57
|
startY: import("vue").Ref<number, number>;
|
|
58
58
|
deltaX: import("vue").Ref<number, number>;
|
|
@@ -77,39 +77,39 @@ declare function useTouch(): {
|
|
|
77
77
|
};
|
|
78
78
|
//#endregion
|
|
79
79
|
//#region src/useId.d.ts
|
|
80
|
-
declare function useId(): import("vue").Ref<string | undefined, string | undefined>;
|
|
80
|
+
export declare function useId(): import("vue").Ref<string | undefined, string | undefined>;
|
|
81
81
|
//#endregion
|
|
82
82
|
//#region src/useClientId.d.ts
|
|
83
|
-
declare function useClientId(): import("vue").Ref<string | undefined, string | undefined>;
|
|
83
|
+
export declare function useClientId(): import("vue").Ref<string | undefined, string | undefined>;
|
|
84
84
|
//#endregion
|
|
85
85
|
//#region src/useWindowSize.d.ts
|
|
86
|
-
interface UseWindowSizeOptions {
|
|
86
|
+
export interface UseWindowSizeOptions {
|
|
87
87
|
initialWidth?: number;
|
|
88
88
|
initialHeight?: number;
|
|
89
89
|
}
|
|
90
|
-
declare function useWindowSize(options?: UseWindowSizeOptions): {
|
|
90
|
+
export declare function useWindowSize(options?: UseWindowSizeOptions): {
|
|
91
91
|
width: import("vue").Ref<number, number>;
|
|
92
92
|
height: import("vue").Ref<number, number>;
|
|
93
93
|
};
|
|
94
94
|
//#endregion
|
|
95
95
|
//#region src/useVModel.d.ts
|
|
96
|
-
interface UseVModelOptions<P, K extends keyof P> {
|
|
96
|
+
export interface UseVModelOptions<P, K extends keyof P> {
|
|
97
97
|
passive?: boolean;
|
|
98
98
|
eventName?: string;
|
|
99
99
|
defaultValue?: P[K];
|
|
100
100
|
emit?: (event: string, value: P[K]) => void;
|
|
101
101
|
}
|
|
102
|
-
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]>;
|
|
102
|
+
export 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]>;
|
|
103
103
|
//#endregion
|
|
104
104
|
//#region src/useMotion.d.ts
|
|
105
|
-
interface UseMotionOptions {
|
|
105
|
+
export interface UseMotionOptions {
|
|
106
106
|
from: number | (() => number);
|
|
107
107
|
to: number | (() => number);
|
|
108
108
|
duration?: number | (() => number);
|
|
109
109
|
timingFunction?: (v: number) => number;
|
|
110
110
|
onFinished?: (value: number) => void;
|
|
111
111
|
}
|
|
112
|
-
declare function useMotion(options: UseMotionOptions): {
|
|
112
|
+
export declare function useMotion(options: UseMotionOptions): {
|
|
113
113
|
value: import("vue").Ref<number, number>;
|
|
114
114
|
state: import("vue").Ref<MotionState, MotionState>;
|
|
115
115
|
start: () => void;
|
|
@@ -118,7 +118,6 @@ declare function useMotion(options: UseMotionOptions): {
|
|
|
118
118
|
};
|
|
119
119
|
//#endregion
|
|
120
120
|
//#region src/useResizeObserver.d.ts
|
|
121
|
-
type UseResizeObserverTarget = Element | Ref<Element | undefined | null> | (() => Element | undefined | null);
|
|
122
|
-
declare function useResizeObserver(target: UseResizeObserverTarget, callback: ResizeObserverCallback): (() => void) | undefined;
|
|
123
|
-
//#endregion
|
|
124
|
-
export { TouchDirection, UseChildrenBaseProvider, UseClickOutsideTarget, UseEventListenerOptions, UseEventListenerTarget, UseMotionOptions, UseResizeObserverTarget, UseVModelOptions, UseWindowSizeOptions, keyInProvides, onSmartMounted, onSmartUnmounted, onWindowResize, useChildren, useClickOutside, useClientId, useEventListener, useId, useInitialized, useMotion, useParent, useResizeObserver, useTouch, useVModel, useWindowSize };
|
|
121
|
+
export type UseResizeObserverTarget = Element | Ref<Element | undefined | null> | (() => Element | undefined | null);
|
|
122
|
+
export declare function useResizeObserver(target: UseResizeObserverTarget, callback: ResizeObserverCallback): (() => void) | undefined;
|
|
123
|
+
//#endregion
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@varlet/use",
|
|
3
|
-
"version": "3.20.
|
|
3
|
+
"version": "3.20.8",
|
|
4
4
|
"description": "composable utils of varlet",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"composable",
|
|
@@ -32,12 +32,12 @@
|
|
|
32
32
|
"lib"
|
|
33
33
|
],
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@varlet/shared": "3.20.
|
|
35
|
+
"@varlet/shared": "3.20.8"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@types/node": "^
|
|
38
|
+
"@types/node": "^22.18.0",
|
|
39
39
|
"typescript": "5.6.3",
|
|
40
|
-
"vite-plus": "
|
|
40
|
+
"vite-plus": "1.1.0",
|
|
41
41
|
"vue": "3.5.21"
|
|
42
42
|
},
|
|
43
43
|
"peerDependencies": {
|