@maltjoy/core-vue 3.27.1 → 3.28.0
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/README.md +1 -0
- package/dist/components/JoyBottomSheetTrigger/VJoyBottomSheetTrigger.vue.d.ts +8 -8
- package/dist/components/JoyButton/VJoyButton.vue.d.ts +3 -3
- package/dist/components/JoyCheckbox/VJoyCheckbox.vue.d.ts +4 -4
- package/dist/components/JoyCounter/VJoyCounter.vue.d.ts +7 -7
- package/dist/components/JoyDialog/VJoyDialog.vue.d.ts +1 -1
- package/dist/components/JoyDialogTrigger/VJoyDialogTrigger.vue.d.ts +40 -60
- package/dist/components/JoyDrawer/VJoyDrawer.vue.d.ts +1 -1
- package/dist/components/JoyDrawerTrigger/VJoyDrawerTrigger.vue.d.ts +40 -60
- package/dist/components/JoyDropdown/VJoyDropdown.vue.d.ts +5 -5
- package/dist/components/JoyDropdownList/VJoyDropdownList.vue.d.ts +2 -2
- package/dist/components/JoyFunnel/VJoyFunnel.vue.d.ts +1 -0
- package/dist/components/JoyHighlight/VJoyHighlight.vue.d.ts +3 -3
- package/dist/components/JoyInput/VJoyInput.vue.d.ts +3 -3
- package/dist/components/JoyLabel/VJoyLabel.vue.d.ts +1 -1
- package/dist/components/JoyProductTour/JoyProductTour.store.d.ts +550 -0
- package/dist/components/JoyProductTour/JoyProductTour.types.d.ts +32 -0
- package/dist/components/JoyProductTour/JoyProductTourSpotlight/VJoyProductTourSpotlight.vue.d.ts +2 -0
- package/dist/components/JoyProductTour/VJoyProductTour.vue.d.ts +22 -0
- package/dist/components/JoyProductTour/VJoyProductTourInner.vue.d.ts +55 -0
- package/dist/components/JoyProductTourTrigger/VJoyProductTourTrigger.vue.d.ts +310 -0
- package/dist/components/JoyProgressBar/JoyProgressBar.types.d.ts +2 -2
- package/dist/components/JoyProgressBar/VJoyProgressBar.vue.d.ts +4 -3
- package/dist/components/JoyRadio/VJoyRadio.vue.d.ts +1 -1
- package/dist/components/JoySelect/VJoySelect.vue.d.ts +2 -2
- package/dist/components/JoySelectableItem/VJoySelectableItem.vue.d.ts +4 -3
- package/dist/components/JoySelectableItemGroup/VJoySelectableItemGroup.vue.d.ts +1 -1
- package/dist/components/JoyStepper/VJoyStepper.vue.d.ts +7 -7
- package/dist/components/JoyTag/VJoyTag.vue.d.ts +12 -12
- package/dist/components/JoyTagsInput/VJoyTagsInput.vue.d.ts +18 -18
- package/dist/components/JoyTagsList/VJoyTagsList.vue.d.ts +2 -2
- package/dist/components/JoyText/VJoyText.vue.d.ts +3 -3
- package/dist/components/JoyTextarea/VJoyTextarea.vue.d.ts +1 -1
- package/dist/components/JoyToggle/VJoyToggle.vue.d.ts +2 -2
- package/dist/components/JoyTooltip/VJoyTooltip.vue.d.ts +97 -0
- package/dist/components/JoyWrapper/VJoyWrapper.vue.d.ts +1 -1
- package/dist/components/index.d.ts +3 -1
- package/dist/joy-vue.js +4711 -4053
- package/dist/joy-vue.umd.cjs +12 -4
- package/dist/style.css +1 -1
- package/joy-components.d.ts +2 -0
- package/package.json +6 -7
|
@@ -0,0 +1,550 @@
|
|
|
1
|
+
import { TJoyProductTourEvents } from './JoyProductTour.types';
|
|
2
|
+
import VJoyProductTourInner from './VJoyProductTourInner.vue';
|
|
3
|
+
export declare const productTourEventBus: import("mitt").Emitter<TJoyProductTourEvents>;
|
|
4
|
+
export declare const useProductTourStore: import("pinia").StoreDefinition<"VJoyProductTours", import("pinia")._UnwrapAll<Pick<{
|
|
5
|
+
clearProductTourRef: () => void;
|
|
6
|
+
storeProductTourRef: (productTourInstance?: InstanceType<typeof VJoyProductTourInner>) => void;
|
|
7
|
+
productToursRef: import("vue").ShallowRef<({
|
|
8
|
+
$: import("vue").ComponentInternalInstance;
|
|
9
|
+
$data: {};
|
|
10
|
+
$props: Partial<{
|
|
11
|
+
step: number;
|
|
12
|
+
open: boolean;
|
|
13
|
+
steps: number;
|
|
14
|
+
position: "left" | "right" | "bottom" | "top";
|
|
15
|
+
maxWidth: number;
|
|
16
|
+
disableOverlay: boolean;
|
|
17
|
+
spotlightPadding: number;
|
|
18
|
+
}> & Omit<{
|
|
19
|
+
readonly step: number;
|
|
20
|
+
readonly open: boolean;
|
|
21
|
+
readonly steps: number;
|
|
22
|
+
readonly position: "left" | "right" | "bottom" | "top";
|
|
23
|
+
readonly maxWidth: number;
|
|
24
|
+
readonly disableOverlay: boolean;
|
|
25
|
+
readonly spotlightPadding: number;
|
|
26
|
+
readonly icon?: import("@maltjoy/icons").JoyIconsId | undefined;
|
|
27
|
+
readonly spotlightSelector?: string | undefined;
|
|
28
|
+
} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & Readonly<import("vue").ExtractPropTypes<{
|
|
29
|
+
step: {
|
|
30
|
+
type: import("vue").PropType<number>;
|
|
31
|
+
default: number;
|
|
32
|
+
};
|
|
33
|
+
icon: {
|
|
34
|
+
type: import("vue").PropType<import("@maltjoy/icons").JoyIconsId>;
|
|
35
|
+
};
|
|
36
|
+
open: {
|
|
37
|
+
type: import("vue").PropType<boolean>;
|
|
38
|
+
default: boolean;
|
|
39
|
+
};
|
|
40
|
+
steps: {
|
|
41
|
+
type: import("vue").PropType<number>;
|
|
42
|
+
default: number;
|
|
43
|
+
};
|
|
44
|
+
position: {
|
|
45
|
+
type: import("vue").PropType<"left" | "right" | "bottom" | "top">;
|
|
46
|
+
default: string;
|
|
47
|
+
};
|
|
48
|
+
maxWidth: {
|
|
49
|
+
type: import("vue").PropType<number>;
|
|
50
|
+
default: number;
|
|
51
|
+
};
|
|
52
|
+
disableOverlay: {
|
|
53
|
+
type: import("vue").PropType<boolean>;
|
|
54
|
+
default: boolean;
|
|
55
|
+
};
|
|
56
|
+
spotlightPadding: {
|
|
57
|
+
type: import("vue").PropType<number>;
|
|
58
|
+
default: number;
|
|
59
|
+
};
|
|
60
|
+
spotlightSelector: {
|
|
61
|
+
type: import("vue").PropType<string>;
|
|
62
|
+
};
|
|
63
|
+
}>>, "step" | "open" | "steps" | "position" | "maxWidth" | "disableOverlay" | "spotlightPadding">;
|
|
64
|
+
$attrs: {
|
|
65
|
+
[x: string]: unknown;
|
|
66
|
+
};
|
|
67
|
+
$refs: {
|
|
68
|
+
[x: string]: unknown;
|
|
69
|
+
};
|
|
70
|
+
$slots: Readonly<{
|
|
71
|
+
[name: string]: import("vue").Slot<any> | undefined;
|
|
72
|
+
}>;
|
|
73
|
+
$root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
|
|
74
|
+
$parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
|
|
75
|
+
$emit: (event: string, ...args: any[]) => void;
|
|
76
|
+
$el: any;
|
|
77
|
+
$options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
|
|
78
|
+
step: {
|
|
79
|
+
type: import("vue").PropType<number>;
|
|
80
|
+
default: number;
|
|
81
|
+
};
|
|
82
|
+
icon: {
|
|
83
|
+
type: import("vue").PropType<import("@maltjoy/icons").JoyIconsId>;
|
|
84
|
+
};
|
|
85
|
+
open: {
|
|
86
|
+
type: import("vue").PropType<boolean>;
|
|
87
|
+
default: boolean;
|
|
88
|
+
};
|
|
89
|
+
steps: {
|
|
90
|
+
type: import("vue").PropType<number>;
|
|
91
|
+
default: number;
|
|
92
|
+
};
|
|
93
|
+
position: {
|
|
94
|
+
type: import("vue").PropType<"left" | "right" | "bottom" | "top">;
|
|
95
|
+
default: string;
|
|
96
|
+
};
|
|
97
|
+
maxWidth: {
|
|
98
|
+
type: import("vue").PropType<number>;
|
|
99
|
+
default: number;
|
|
100
|
+
};
|
|
101
|
+
disableOverlay: {
|
|
102
|
+
type: import("vue").PropType<boolean>;
|
|
103
|
+
default: boolean;
|
|
104
|
+
};
|
|
105
|
+
spotlightPadding: {
|
|
106
|
+
type: import("vue").PropType<number>;
|
|
107
|
+
default: number;
|
|
108
|
+
};
|
|
109
|
+
spotlightSelector: {
|
|
110
|
+
type: import("vue").PropType<string>;
|
|
111
|
+
};
|
|
112
|
+
}>>, {
|
|
113
|
+
hide: () => void;
|
|
114
|
+
show: () => void;
|
|
115
|
+
isOpen: import("vue").Ref<boolean>;
|
|
116
|
+
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
|
|
117
|
+
step: number;
|
|
118
|
+
open: boolean;
|
|
119
|
+
steps: number;
|
|
120
|
+
position: "left" | "right" | "bottom" | "top";
|
|
121
|
+
maxWidth: number;
|
|
122
|
+
disableOverlay: boolean;
|
|
123
|
+
spotlightPadding: number;
|
|
124
|
+
}, {}, string, {}> & {
|
|
125
|
+
beforeCreate?: ((() => void) | (() => void)[]) | undefined;
|
|
126
|
+
created?: ((() => void) | (() => void)[]) | undefined;
|
|
127
|
+
beforeMount?: ((() => void) | (() => void)[]) | undefined;
|
|
128
|
+
mounted?: ((() => void) | (() => void)[]) | undefined;
|
|
129
|
+
beforeUpdate?: ((() => void) | (() => void)[]) | undefined;
|
|
130
|
+
updated?: ((() => void) | (() => void)[]) | undefined;
|
|
131
|
+
activated?: ((() => void) | (() => void)[]) | undefined;
|
|
132
|
+
deactivated?: ((() => void) | (() => void)[]) | undefined;
|
|
133
|
+
beforeDestroy?: ((() => void) | (() => void)[]) | undefined;
|
|
134
|
+
beforeUnmount?: ((() => void) | (() => void)[]) | undefined;
|
|
135
|
+
destroyed?: ((() => void) | (() => void)[]) | undefined;
|
|
136
|
+
unmounted?: ((() => void) | (() => void)[]) | undefined;
|
|
137
|
+
renderTracked?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
|
|
138
|
+
renderTriggered?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
|
|
139
|
+
errorCaptured?: (((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void)[]) | undefined;
|
|
140
|
+
};
|
|
141
|
+
$forceUpdate: () => void;
|
|
142
|
+
$nextTick: typeof import("vue").nextTick;
|
|
143
|
+
$watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (args_0: R, args_1: R) => any : (...args: any) => any, options?: import("vue").WatchOptions<boolean> | undefined): import("vue").WatchStopHandle;
|
|
144
|
+
} & Omit<Readonly<import("vue").ExtractPropTypes<{
|
|
145
|
+
step: {
|
|
146
|
+
type: import("vue").PropType<number>;
|
|
147
|
+
default: number;
|
|
148
|
+
};
|
|
149
|
+
icon: {
|
|
150
|
+
type: import("vue").PropType<import("@maltjoy/icons").JoyIconsId>;
|
|
151
|
+
};
|
|
152
|
+
open: {
|
|
153
|
+
type: import("vue").PropType<boolean>;
|
|
154
|
+
default: boolean;
|
|
155
|
+
};
|
|
156
|
+
steps: {
|
|
157
|
+
type: import("vue").PropType<number>;
|
|
158
|
+
default: number;
|
|
159
|
+
};
|
|
160
|
+
position: {
|
|
161
|
+
type: import("vue").PropType<"left" | "right" | "bottom" | "top">;
|
|
162
|
+
default: string;
|
|
163
|
+
};
|
|
164
|
+
maxWidth: {
|
|
165
|
+
type: import("vue").PropType<number>;
|
|
166
|
+
default: number;
|
|
167
|
+
};
|
|
168
|
+
disableOverlay: {
|
|
169
|
+
type: import("vue").PropType<boolean>;
|
|
170
|
+
default: boolean;
|
|
171
|
+
};
|
|
172
|
+
spotlightPadding: {
|
|
173
|
+
type: import("vue").PropType<number>;
|
|
174
|
+
default: number;
|
|
175
|
+
};
|
|
176
|
+
spotlightSelector: {
|
|
177
|
+
type: import("vue").PropType<string>;
|
|
178
|
+
};
|
|
179
|
+
}>>, "hide" | "show" | "isOpen"> & import("vue").ShallowUnwrapRef<{
|
|
180
|
+
hide: () => void;
|
|
181
|
+
show: () => void;
|
|
182
|
+
isOpen: import("vue").Ref<boolean>;
|
|
183
|
+
}> & {} & import("vue").ComponentCustomProperties & {} & {
|
|
184
|
+
$slots: Readonly<import("./JoyProductTour.types").VJoyProductTourSlots> & import("./JoyProductTour.types").VJoyProductTourSlots;
|
|
185
|
+
}) | null>;
|
|
186
|
+
}, "productToursRef">>, Pick<{
|
|
187
|
+
clearProductTourRef: () => void;
|
|
188
|
+
storeProductTourRef: (productTourInstance?: InstanceType<typeof VJoyProductTourInner>) => void;
|
|
189
|
+
productToursRef: import("vue").ShallowRef<({
|
|
190
|
+
$: import("vue").ComponentInternalInstance;
|
|
191
|
+
$data: {};
|
|
192
|
+
$props: Partial<{
|
|
193
|
+
step: number;
|
|
194
|
+
open: boolean;
|
|
195
|
+
steps: number;
|
|
196
|
+
position: "left" | "right" | "bottom" | "top";
|
|
197
|
+
maxWidth: number;
|
|
198
|
+
disableOverlay: boolean;
|
|
199
|
+
spotlightPadding: number;
|
|
200
|
+
}> & Omit<{
|
|
201
|
+
readonly step: number;
|
|
202
|
+
readonly open: boolean;
|
|
203
|
+
readonly steps: number;
|
|
204
|
+
readonly position: "left" | "right" | "bottom" | "top";
|
|
205
|
+
readonly maxWidth: number;
|
|
206
|
+
readonly disableOverlay: boolean;
|
|
207
|
+
readonly spotlightPadding: number;
|
|
208
|
+
readonly icon?: import("@maltjoy/icons").JoyIconsId | undefined;
|
|
209
|
+
readonly spotlightSelector?: string | undefined;
|
|
210
|
+
} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & Readonly<import("vue").ExtractPropTypes<{
|
|
211
|
+
step: {
|
|
212
|
+
type: import("vue").PropType<number>;
|
|
213
|
+
default: number;
|
|
214
|
+
};
|
|
215
|
+
icon: {
|
|
216
|
+
type: import("vue").PropType<import("@maltjoy/icons").JoyIconsId>;
|
|
217
|
+
};
|
|
218
|
+
open: {
|
|
219
|
+
type: import("vue").PropType<boolean>;
|
|
220
|
+
default: boolean;
|
|
221
|
+
};
|
|
222
|
+
steps: {
|
|
223
|
+
type: import("vue").PropType<number>;
|
|
224
|
+
default: number;
|
|
225
|
+
};
|
|
226
|
+
position: {
|
|
227
|
+
type: import("vue").PropType<"left" | "right" | "bottom" | "top">;
|
|
228
|
+
default: string;
|
|
229
|
+
};
|
|
230
|
+
maxWidth: {
|
|
231
|
+
type: import("vue").PropType<number>;
|
|
232
|
+
default: number;
|
|
233
|
+
};
|
|
234
|
+
disableOverlay: {
|
|
235
|
+
type: import("vue").PropType<boolean>;
|
|
236
|
+
default: boolean;
|
|
237
|
+
};
|
|
238
|
+
spotlightPadding: {
|
|
239
|
+
type: import("vue").PropType<number>;
|
|
240
|
+
default: number;
|
|
241
|
+
};
|
|
242
|
+
spotlightSelector: {
|
|
243
|
+
type: import("vue").PropType<string>;
|
|
244
|
+
};
|
|
245
|
+
}>>, "step" | "open" | "steps" | "position" | "maxWidth" | "disableOverlay" | "spotlightPadding">;
|
|
246
|
+
$attrs: {
|
|
247
|
+
[x: string]: unknown;
|
|
248
|
+
};
|
|
249
|
+
$refs: {
|
|
250
|
+
[x: string]: unknown;
|
|
251
|
+
};
|
|
252
|
+
$slots: Readonly<{
|
|
253
|
+
[name: string]: import("vue").Slot<any> | undefined;
|
|
254
|
+
}>;
|
|
255
|
+
$root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
|
|
256
|
+
$parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
|
|
257
|
+
$emit: (event: string, ...args: any[]) => void;
|
|
258
|
+
$el: any;
|
|
259
|
+
$options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
|
|
260
|
+
step: {
|
|
261
|
+
type: import("vue").PropType<number>;
|
|
262
|
+
default: number;
|
|
263
|
+
};
|
|
264
|
+
icon: {
|
|
265
|
+
type: import("vue").PropType<import("@maltjoy/icons").JoyIconsId>;
|
|
266
|
+
};
|
|
267
|
+
open: {
|
|
268
|
+
type: import("vue").PropType<boolean>;
|
|
269
|
+
default: boolean;
|
|
270
|
+
};
|
|
271
|
+
steps: {
|
|
272
|
+
type: import("vue").PropType<number>;
|
|
273
|
+
default: number;
|
|
274
|
+
};
|
|
275
|
+
position: {
|
|
276
|
+
type: import("vue").PropType<"left" | "right" | "bottom" | "top">;
|
|
277
|
+
default: string;
|
|
278
|
+
};
|
|
279
|
+
maxWidth: {
|
|
280
|
+
type: import("vue").PropType<number>;
|
|
281
|
+
default: number;
|
|
282
|
+
};
|
|
283
|
+
disableOverlay: {
|
|
284
|
+
type: import("vue").PropType<boolean>;
|
|
285
|
+
default: boolean;
|
|
286
|
+
};
|
|
287
|
+
spotlightPadding: {
|
|
288
|
+
type: import("vue").PropType<number>;
|
|
289
|
+
default: number;
|
|
290
|
+
};
|
|
291
|
+
spotlightSelector: {
|
|
292
|
+
type: import("vue").PropType<string>;
|
|
293
|
+
};
|
|
294
|
+
}>>, {
|
|
295
|
+
hide: () => void;
|
|
296
|
+
show: () => void;
|
|
297
|
+
isOpen: import("vue").Ref<boolean>;
|
|
298
|
+
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
|
|
299
|
+
step: number;
|
|
300
|
+
open: boolean;
|
|
301
|
+
steps: number;
|
|
302
|
+
position: "left" | "right" | "bottom" | "top";
|
|
303
|
+
maxWidth: number;
|
|
304
|
+
disableOverlay: boolean;
|
|
305
|
+
spotlightPadding: number;
|
|
306
|
+
}, {}, string, {}> & {
|
|
307
|
+
beforeCreate?: ((() => void) | (() => void)[]) | undefined;
|
|
308
|
+
created?: ((() => void) | (() => void)[]) | undefined;
|
|
309
|
+
beforeMount?: ((() => void) | (() => void)[]) | undefined;
|
|
310
|
+
mounted?: ((() => void) | (() => void)[]) | undefined;
|
|
311
|
+
beforeUpdate?: ((() => void) | (() => void)[]) | undefined;
|
|
312
|
+
updated?: ((() => void) | (() => void)[]) | undefined;
|
|
313
|
+
activated?: ((() => void) | (() => void)[]) | undefined;
|
|
314
|
+
deactivated?: ((() => void) | (() => void)[]) | undefined;
|
|
315
|
+
beforeDestroy?: ((() => void) | (() => void)[]) | undefined;
|
|
316
|
+
beforeUnmount?: ((() => void) | (() => void)[]) | undefined;
|
|
317
|
+
destroyed?: ((() => void) | (() => void)[]) | undefined;
|
|
318
|
+
unmounted?: ((() => void) | (() => void)[]) | undefined;
|
|
319
|
+
renderTracked?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
|
|
320
|
+
renderTriggered?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
|
|
321
|
+
errorCaptured?: (((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void)[]) | undefined;
|
|
322
|
+
};
|
|
323
|
+
$forceUpdate: () => void;
|
|
324
|
+
$nextTick: typeof import("vue").nextTick;
|
|
325
|
+
$watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (args_0: R, args_1: R) => any : (...args: any) => any, options?: import("vue").WatchOptions<boolean> | undefined): import("vue").WatchStopHandle;
|
|
326
|
+
} & Omit<Readonly<import("vue").ExtractPropTypes<{
|
|
327
|
+
step: {
|
|
328
|
+
type: import("vue").PropType<number>;
|
|
329
|
+
default: number;
|
|
330
|
+
};
|
|
331
|
+
icon: {
|
|
332
|
+
type: import("vue").PropType<import("@maltjoy/icons").JoyIconsId>;
|
|
333
|
+
};
|
|
334
|
+
open: {
|
|
335
|
+
type: import("vue").PropType<boolean>;
|
|
336
|
+
default: boolean;
|
|
337
|
+
};
|
|
338
|
+
steps: {
|
|
339
|
+
type: import("vue").PropType<number>;
|
|
340
|
+
default: number;
|
|
341
|
+
};
|
|
342
|
+
position: {
|
|
343
|
+
type: import("vue").PropType<"left" | "right" | "bottom" | "top">;
|
|
344
|
+
default: string;
|
|
345
|
+
};
|
|
346
|
+
maxWidth: {
|
|
347
|
+
type: import("vue").PropType<number>;
|
|
348
|
+
default: number;
|
|
349
|
+
};
|
|
350
|
+
disableOverlay: {
|
|
351
|
+
type: import("vue").PropType<boolean>;
|
|
352
|
+
default: boolean;
|
|
353
|
+
};
|
|
354
|
+
spotlightPadding: {
|
|
355
|
+
type: import("vue").PropType<number>;
|
|
356
|
+
default: number;
|
|
357
|
+
};
|
|
358
|
+
spotlightSelector: {
|
|
359
|
+
type: import("vue").PropType<string>;
|
|
360
|
+
};
|
|
361
|
+
}>>, "hide" | "show" | "isOpen"> & import("vue").ShallowUnwrapRef<{
|
|
362
|
+
hide: () => void;
|
|
363
|
+
show: () => void;
|
|
364
|
+
isOpen: import("vue").Ref<boolean>;
|
|
365
|
+
}> & {} & import("vue").ComponentCustomProperties & {} & {
|
|
366
|
+
$slots: Readonly<import("./JoyProductTour.types").VJoyProductTourSlots> & import("./JoyProductTour.types").VJoyProductTourSlots;
|
|
367
|
+
}) | null>;
|
|
368
|
+
}, never>, Pick<{
|
|
369
|
+
clearProductTourRef: () => void;
|
|
370
|
+
storeProductTourRef: (productTourInstance?: InstanceType<typeof VJoyProductTourInner>) => void;
|
|
371
|
+
productToursRef: import("vue").ShallowRef<({
|
|
372
|
+
$: import("vue").ComponentInternalInstance;
|
|
373
|
+
$data: {};
|
|
374
|
+
$props: Partial<{
|
|
375
|
+
step: number;
|
|
376
|
+
open: boolean;
|
|
377
|
+
steps: number;
|
|
378
|
+
position: "left" | "right" | "bottom" | "top";
|
|
379
|
+
maxWidth: number;
|
|
380
|
+
disableOverlay: boolean;
|
|
381
|
+
spotlightPadding: number;
|
|
382
|
+
}> & Omit<{
|
|
383
|
+
readonly step: number;
|
|
384
|
+
readonly open: boolean;
|
|
385
|
+
readonly steps: number;
|
|
386
|
+
readonly position: "left" | "right" | "bottom" | "top";
|
|
387
|
+
readonly maxWidth: number;
|
|
388
|
+
readonly disableOverlay: boolean;
|
|
389
|
+
readonly spotlightPadding: number;
|
|
390
|
+
readonly icon?: import("@maltjoy/icons").JoyIconsId | undefined;
|
|
391
|
+
readonly spotlightSelector?: string | undefined;
|
|
392
|
+
} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & Readonly<import("vue").ExtractPropTypes<{
|
|
393
|
+
step: {
|
|
394
|
+
type: import("vue").PropType<number>;
|
|
395
|
+
default: number;
|
|
396
|
+
};
|
|
397
|
+
icon: {
|
|
398
|
+
type: import("vue").PropType<import("@maltjoy/icons").JoyIconsId>;
|
|
399
|
+
};
|
|
400
|
+
open: {
|
|
401
|
+
type: import("vue").PropType<boolean>;
|
|
402
|
+
default: boolean;
|
|
403
|
+
};
|
|
404
|
+
steps: {
|
|
405
|
+
type: import("vue").PropType<number>;
|
|
406
|
+
default: number;
|
|
407
|
+
};
|
|
408
|
+
position: {
|
|
409
|
+
type: import("vue").PropType<"left" | "right" | "bottom" | "top">;
|
|
410
|
+
default: string;
|
|
411
|
+
};
|
|
412
|
+
maxWidth: {
|
|
413
|
+
type: import("vue").PropType<number>;
|
|
414
|
+
default: number;
|
|
415
|
+
};
|
|
416
|
+
disableOverlay: {
|
|
417
|
+
type: import("vue").PropType<boolean>;
|
|
418
|
+
default: boolean;
|
|
419
|
+
};
|
|
420
|
+
spotlightPadding: {
|
|
421
|
+
type: import("vue").PropType<number>;
|
|
422
|
+
default: number;
|
|
423
|
+
};
|
|
424
|
+
spotlightSelector: {
|
|
425
|
+
type: import("vue").PropType<string>;
|
|
426
|
+
};
|
|
427
|
+
}>>, "step" | "open" | "steps" | "position" | "maxWidth" | "disableOverlay" | "spotlightPadding">;
|
|
428
|
+
$attrs: {
|
|
429
|
+
[x: string]: unknown;
|
|
430
|
+
};
|
|
431
|
+
$refs: {
|
|
432
|
+
[x: string]: unknown;
|
|
433
|
+
};
|
|
434
|
+
$slots: Readonly<{
|
|
435
|
+
[name: string]: import("vue").Slot<any> | undefined;
|
|
436
|
+
}>;
|
|
437
|
+
$root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
|
|
438
|
+
$parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
|
|
439
|
+
$emit: (event: string, ...args: any[]) => void;
|
|
440
|
+
$el: any;
|
|
441
|
+
$options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
|
|
442
|
+
step: {
|
|
443
|
+
type: import("vue").PropType<number>;
|
|
444
|
+
default: number;
|
|
445
|
+
};
|
|
446
|
+
icon: {
|
|
447
|
+
type: import("vue").PropType<import("@maltjoy/icons").JoyIconsId>;
|
|
448
|
+
};
|
|
449
|
+
open: {
|
|
450
|
+
type: import("vue").PropType<boolean>;
|
|
451
|
+
default: boolean;
|
|
452
|
+
};
|
|
453
|
+
steps: {
|
|
454
|
+
type: import("vue").PropType<number>;
|
|
455
|
+
default: number;
|
|
456
|
+
};
|
|
457
|
+
position: {
|
|
458
|
+
type: import("vue").PropType<"left" | "right" | "bottom" | "top">;
|
|
459
|
+
default: string;
|
|
460
|
+
};
|
|
461
|
+
maxWidth: {
|
|
462
|
+
type: import("vue").PropType<number>;
|
|
463
|
+
default: number;
|
|
464
|
+
};
|
|
465
|
+
disableOverlay: {
|
|
466
|
+
type: import("vue").PropType<boolean>;
|
|
467
|
+
default: boolean;
|
|
468
|
+
};
|
|
469
|
+
spotlightPadding: {
|
|
470
|
+
type: import("vue").PropType<number>;
|
|
471
|
+
default: number;
|
|
472
|
+
};
|
|
473
|
+
spotlightSelector: {
|
|
474
|
+
type: import("vue").PropType<string>;
|
|
475
|
+
};
|
|
476
|
+
}>>, {
|
|
477
|
+
hide: () => void;
|
|
478
|
+
show: () => void;
|
|
479
|
+
isOpen: import("vue").Ref<boolean>;
|
|
480
|
+
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {
|
|
481
|
+
step: number;
|
|
482
|
+
open: boolean;
|
|
483
|
+
steps: number;
|
|
484
|
+
position: "left" | "right" | "bottom" | "top";
|
|
485
|
+
maxWidth: number;
|
|
486
|
+
disableOverlay: boolean;
|
|
487
|
+
spotlightPadding: number;
|
|
488
|
+
}, {}, string, {}> & {
|
|
489
|
+
beforeCreate?: ((() => void) | (() => void)[]) | undefined;
|
|
490
|
+
created?: ((() => void) | (() => void)[]) | undefined;
|
|
491
|
+
beforeMount?: ((() => void) | (() => void)[]) | undefined;
|
|
492
|
+
mounted?: ((() => void) | (() => void)[]) | undefined;
|
|
493
|
+
beforeUpdate?: ((() => void) | (() => void)[]) | undefined;
|
|
494
|
+
updated?: ((() => void) | (() => void)[]) | undefined;
|
|
495
|
+
activated?: ((() => void) | (() => void)[]) | undefined;
|
|
496
|
+
deactivated?: ((() => void) | (() => void)[]) | undefined;
|
|
497
|
+
beforeDestroy?: ((() => void) | (() => void)[]) | undefined;
|
|
498
|
+
beforeUnmount?: ((() => void) | (() => void)[]) | undefined;
|
|
499
|
+
destroyed?: ((() => void) | (() => void)[]) | undefined;
|
|
500
|
+
unmounted?: ((() => void) | (() => void)[]) | undefined;
|
|
501
|
+
renderTracked?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
|
|
502
|
+
renderTriggered?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
|
|
503
|
+
errorCaptured?: (((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void)[]) | undefined;
|
|
504
|
+
};
|
|
505
|
+
$forceUpdate: () => void;
|
|
506
|
+
$nextTick: typeof import("vue").nextTick;
|
|
507
|
+
$watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (args_0: R, args_1: R) => any : (...args: any) => any, options?: import("vue").WatchOptions<boolean> | undefined): import("vue").WatchStopHandle;
|
|
508
|
+
} & Omit<Readonly<import("vue").ExtractPropTypes<{
|
|
509
|
+
step: {
|
|
510
|
+
type: import("vue").PropType<number>;
|
|
511
|
+
default: number;
|
|
512
|
+
};
|
|
513
|
+
icon: {
|
|
514
|
+
type: import("vue").PropType<import("@maltjoy/icons").JoyIconsId>;
|
|
515
|
+
};
|
|
516
|
+
open: {
|
|
517
|
+
type: import("vue").PropType<boolean>;
|
|
518
|
+
default: boolean;
|
|
519
|
+
};
|
|
520
|
+
steps: {
|
|
521
|
+
type: import("vue").PropType<number>;
|
|
522
|
+
default: number;
|
|
523
|
+
};
|
|
524
|
+
position: {
|
|
525
|
+
type: import("vue").PropType<"left" | "right" | "bottom" | "top">;
|
|
526
|
+
default: string;
|
|
527
|
+
};
|
|
528
|
+
maxWidth: {
|
|
529
|
+
type: import("vue").PropType<number>;
|
|
530
|
+
default: number;
|
|
531
|
+
};
|
|
532
|
+
disableOverlay: {
|
|
533
|
+
type: import("vue").PropType<boolean>;
|
|
534
|
+
default: boolean;
|
|
535
|
+
};
|
|
536
|
+
spotlightPadding: {
|
|
537
|
+
type: import("vue").PropType<number>;
|
|
538
|
+
default: number;
|
|
539
|
+
};
|
|
540
|
+
spotlightSelector: {
|
|
541
|
+
type: import("vue").PropType<string>;
|
|
542
|
+
};
|
|
543
|
+
}>>, "hide" | "show" | "isOpen"> & import("vue").ShallowUnwrapRef<{
|
|
544
|
+
hide: () => void;
|
|
545
|
+
show: () => void;
|
|
546
|
+
isOpen: import("vue").Ref<boolean>;
|
|
547
|
+
}> & {} & import("vue").ComponentCustomProperties & {} & {
|
|
548
|
+
$slots: Readonly<import("./JoyProductTour.types").VJoyProductTourSlots> & import("./JoyProductTour.types").VJoyProductTourSlots;
|
|
549
|
+
}) | null>;
|
|
550
|
+
}, "clearProductTourRef" | "storeProductTourRef">>;
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { TJoyIconsNames } from '../JoyIcon/JoyIcon.types';
|
|
2
|
+
export declare const PRODUCT_TOUR_POSITIONS: readonly ["left", "right", "top", "bottom"];
|
|
3
|
+
export type TJoyProductTourPositions = (typeof PRODUCT_TOUR_POSITIONS)[number];
|
|
4
|
+
export interface IJoyProductTourShowParams {
|
|
5
|
+
highlightSelector?: HTMLElement;
|
|
6
|
+
}
|
|
7
|
+
export type TJoyProductTourEvents = {
|
|
8
|
+
'product-tour:show': string;
|
|
9
|
+
};
|
|
10
|
+
export interface VJoyProductTourProps {
|
|
11
|
+
icon?: TJoyIconsNames;
|
|
12
|
+
steps?: number;
|
|
13
|
+
step?: number;
|
|
14
|
+
position?: TJoyProductTourPositions;
|
|
15
|
+
open?: boolean;
|
|
16
|
+
maxWidth?: number;
|
|
17
|
+
disableOverlay?: boolean;
|
|
18
|
+
spotlightPadding?: number;
|
|
19
|
+
spotlightSelector?: string;
|
|
20
|
+
}
|
|
21
|
+
export interface VJoyProductTourSlots {
|
|
22
|
+
/** Most of the time we use it to display tags, or short content */
|
|
23
|
+
'product-tour-preheader'?: () => any;
|
|
24
|
+
/** Title of the component */
|
|
25
|
+
'product-tour-header'?: () => any;
|
|
26
|
+
/** Main content. Put whatever you want here */
|
|
27
|
+
'product-tour-content'?: () => any;
|
|
28
|
+
/** The click here will automatically handle slotted VJoyButton with bubbling */
|
|
29
|
+
'product-tour-dismiss'?: () => any;
|
|
30
|
+
/** To display the main CTA. Component hiding needs to be made manually */
|
|
31
|
+
'product-tour-next'?: () => any;
|
|
32
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { VJoyProductTourProps, VJoyProductTourSlots } from './JoyProductTour.types';
|
|
2
|
+
declare function show(): void;
|
|
3
|
+
declare function hide(): void;
|
|
4
|
+
declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_TypePropsToOption<VJoyProductTourProps>, {
|
|
5
|
+
show: typeof show;
|
|
6
|
+
hide: typeof hide;
|
|
7
|
+
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<VJoyProductTourProps>>>, {}, {}>, Readonly<VJoyProductTourSlots> & VJoyProductTourSlots>;
|
|
8
|
+
export default _default;
|
|
9
|
+
type __VLS_WithTemplateSlots<T, S> = T & {
|
|
10
|
+
new (): {
|
|
11
|
+
$slots: S;
|
|
12
|
+
};
|
|
13
|
+
};
|
|
14
|
+
type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
|
|
15
|
+
type __VLS_TypePropsToOption<T> = {
|
|
16
|
+
[K in keyof T]-?: {} extends Pick<T, K> ? {
|
|
17
|
+
type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
|
|
18
|
+
} : {
|
|
19
|
+
type: import('vue').PropType<T[K]>;
|
|
20
|
+
required: true;
|
|
21
|
+
};
|
|
22
|
+
};
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import type { VJoyProductTourProps, VJoyProductTourSlots } from './JoyProductTour.types';
|
|
2
|
+
declare function show(): void;
|
|
3
|
+
declare function hide(): void;
|
|
4
|
+
declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<VJoyProductTourProps>, {
|
|
5
|
+
steps: number;
|
|
6
|
+
step: number;
|
|
7
|
+
position: string;
|
|
8
|
+
open: boolean;
|
|
9
|
+
maxWidth: number;
|
|
10
|
+
disableOverlay: boolean;
|
|
11
|
+
spotlightPadding: number;
|
|
12
|
+
}>, {
|
|
13
|
+
hide: typeof hide;
|
|
14
|
+
show: typeof show;
|
|
15
|
+
isOpen: import("vue").Ref<boolean>;
|
|
16
|
+
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<VJoyProductTourProps>, {
|
|
17
|
+
steps: number;
|
|
18
|
+
step: number;
|
|
19
|
+
position: string;
|
|
20
|
+
open: boolean;
|
|
21
|
+
maxWidth: number;
|
|
22
|
+
disableOverlay: boolean;
|
|
23
|
+
spotlightPadding: number;
|
|
24
|
+
}>>>, {
|
|
25
|
+
step: number;
|
|
26
|
+
open: boolean;
|
|
27
|
+
steps: number;
|
|
28
|
+
position: "left" | "right" | "bottom" | "top";
|
|
29
|
+
maxWidth: number;
|
|
30
|
+
disableOverlay: boolean;
|
|
31
|
+
spotlightPadding: number;
|
|
32
|
+
}, {}>, Readonly<VJoyProductTourSlots> & VJoyProductTourSlots>;
|
|
33
|
+
export default _default;
|
|
34
|
+
type __VLS_WithDefaults<P, D> = {
|
|
35
|
+
[K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
|
|
36
|
+
default: D[K];
|
|
37
|
+
}> : P[K];
|
|
38
|
+
};
|
|
39
|
+
type __VLS_Prettify<T> = {
|
|
40
|
+
[K in keyof T]: T[K];
|
|
41
|
+
} & {};
|
|
42
|
+
type __VLS_WithTemplateSlots<T, S> = T & {
|
|
43
|
+
new (): {
|
|
44
|
+
$slots: S;
|
|
45
|
+
};
|
|
46
|
+
};
|
|
47
|
+
type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
|
|
48
|
+
type __VLS_TypePropsToOption<T> = {
|
|
49
|
+
[K in keyof T]-?: {} extends Pick<T, K> ? {
|
|
50
|
+
type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
|
|
51
|
+
} : {
|
|
52
|
+
type: import('vue').PropType<T[K]>;
|
|
53
|
+
required: true;
|
|
54
|
+
};
|
|
55
|
+
};
|