@maltjoy/core-vue 3.19.0 → 3.19.2

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.
Files changed (16) hide show
  1. package/dist/components/JoyBottomSheet/VJoyBottomSheet.vue.d.ts +19 -8
  2. package/dist/components/JoyBottomSheetTrigger/VJoyBottomSheetTrigger.vue.d.ts +28 -15
  3. package/dist/components/JoyDialog/VJoyDialog.vue.d.ts +32 -5
  4. package/dist/components/JoyDialogTrigger/VJoyDialogTrigger.vue.d.ts +72 -10
  5. package/dist/components/JoyDrawer/JoyDrawer.types.d.ts +0 -5
  6. package/dist/components/JoyDrawer/VJoyDrawer.vue.d.ts +40 -7
  7. package/dist/components/JoyDrawerTrigger/VJoyDrawerTrigger.vue.d.ts +72 -10
  8. package/dist/components/JoyIcon/VJoyIcon.vue.d.ts +27 -0
  9. package/dist/components/JoyTooltip/VJoyTooltip.vue.d.ts +1 -1
  10. package/dist/components/components.types.d.ts +0 -2
  11. package/dist/joy-vue.js +1399 -1337
  12. package/dist/joy-vue.umd.cjs +4 -4
  13. package/dist/style.css +1 -1
  14. package/package.json +5 -5
  15. package/dist/components/JoyBottomSheet/JoyBottomSheet.types.d.ts +0 -3
  16. package/dist/components/JoyDialog/JoyDialog.types.d.ts +0 -5
package/dist/components/JoyBottomSheet/VJoyBottomSheet.vue.d.ts CHANGED
@@ -1,13 +1,9 @@
1
1
  import { PropType } from 'vue';
2
- import { IJoyBottomSheetOpenOptions } from './JoyBottomSheet.types';
3
2
  /**
4
- *
5
- * @param {Object} options - openBottomShet options.
6
- * @param {Boolean} options.preventScroll - Mainly for documentation purpose. Default to true.
7
3
  * @returns {void}
8
4
  */
9
- declare function openBottomSheet(options?: IJoyBottomSheetOpenOptions): void;
10
- declare function closeBottomSheet(): void;
5
+ declare function show(): void;
6
+ declare function hide(): void;
11
7
  declare function moveContainer(translationY: number): void;
12
8
  declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
13
9
  /** Automatically renders a CTA that closes the bottom-sheet */
@@ -19,6 +15,13 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
19
15
  type: BooleanConstructor;
20
16
  default: boolean;
21
17
  };
18
+ /**
19
+ * @internal - Mostly for documentation purpose
20
+ */
21
+ preventBodyScroll: {
22
+ type: BooleanConstructor;
23
+ default: boolean;
24
+ };
22
25
  /** By default the dialog is teleported to the end of body tag */
23
26
  teleport: {
24
27
  type: PropType<string | import("vue").RendererElement | null | undefined>;
@@ -29,8 +32,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
29
32
  default: boolean;
30
33
  };
31
34
  }, {
32
- openBottomSheet: typeof openBottomSheet;
33
- closeBottomSheet: typeof closeBottomSheet;
35
+ hide: typeof hide;
36
+ show: typeof show;
34
37
  isOpen: import("vue").Ref<boolean>;
35
38
  moveContainer: typeof moveContainer;
36
39
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -45,6 +48,13 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
45
48
  type: BooleanConstructor;
46
49
  default: boolean;
47
50
  };
51
+ /**
52
+ * @internal - Mostly for documentation purpose
53
+ */
54
+ preventBodyScroll: {
55
+ type: BooleanConstructor;
56
+ default: boolean;
57
+ };
48
58
  /** By default the dialog is teleported to the end of body tag */
49
59
  teleport: {
50
60
  type: PropType<string | import("vue").RendererElement | null | undefined>;
@@ -59,6 +69,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
59
69
  }, {
60
70
  closeLabel: string;
61
71
  open: boolean;
72
+ preventBodyScroll: boolean;
62
73
  teleport: string | import("vue").RendererElement | null | undefined;
63
74
  frozen: boolean;
64
75
  }, {}>, {
package/dist/components/JoyBottomSheetTrigger/VJoyBottomSheetTrigger.vue.d.ts CHANGED
@@ -1,5 +1,4 @@
1
1
  import { VNode } from 'vue';
2
- import { IJoyBottomSheetOpenOptions } from '../JoyBottomSheet/JoyBottomSheet.types';
3
2
  declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
4
3
  bottomSheet: {
5
4
  type: import("vue").PropType<({
@@ -8,6 +7,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
8
7
  $props: {
9
8
  closeLabel?: string | undefined;
10
9
  open?: boolean | undefined;
10
+ preventBodyScroll?: boolean | undefined;
11
11
  teleport?: string | import("vue").RendererElement | null | undefined;
12
12
  frozen?: boolean | undefined;
13
13
  style?: unknown;
@@ -78,6 +78,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
78
78
  type: BooleanConstructor;
79
79
  default: boolean;
80
80
  };
81
+ preventBodyScroll: {
82
+ type: BooleanConstructor;
83
+ default: boolean;
84
+ };
81
85
  teleport: {
82
86
  type: import("vue").PropType<string | import("vue").RendererElement | null | undefined>;
83
87
  default: string;
@@ -89,8 +93,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
89
93
  }>> & {
90
94
  "onBottom-sheet:close"?: (() => any) | undefined;
91
95
  }, {
92
- openBottomSheet: (options?: IJoyBottomSheetOpenOptions) => void; /** VJoyBottomSheet ref. */
93
- closeBottomSheet: () => void;
96
+ hide: () => void;
97
+ show: () => void;
94
98
  isOpen: import("vue").Ref<boolean>;
95
99
  moveContainer: (translationY: number) => void;
96
100
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -98,6 +102,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
98
102
  }, string, {
99
103
  closeLabel: string;
100
104
  open: boolean;
105
+ preventBodyScroll: boolean;
101
106
  teleport: string | import("vue").RendererElement | null | undefined;
102
107
  frozen: boolean;
103
108
  }, {}, string, {}> & {
@@ -129,6 +134,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
129
134
  type: BooleanConstructor;
130
135
  default: boolean;
131
136
  };
137
+ preventBodyScroll: {
138
+ type: BooleanConstructor;
139
+ default: boolean;
140
+ };
132
141
  teleport: {
133
142
  type: import("vue").PropType<string | import("vue").RendererElement | null | undefined>;
134
143
  default: string;
@@ -140,8 +149,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
140
149
  }>> & {
141
150
  "onBottom-sheet:close"?: (() => any) | undefined;
142
151
  } & import("vue").ShallowUnwrapRef<{
143
- openBottomSheet: (options?: IJoyBottomSheetOpenOptions) => void; /** VJoyBottomSheet ref. */
144
- closeBottomSheet: () => void;
152
+ hide: () => void;
153
+ show: () => void;
145
154
  isOpen: import("vue").Ref<boolean>;
146
155
  moveContainer: (translationY: number) => void;
147
156
  }> & {} & import("vue").ComponentCustomProperties & {} & {
@@ -152,9 +161,6 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
152
161
  }) | null | undefined>;
153
162
  required: true;
154
163
  };
155
- options: {
156
- type: import("vue").PropType<IJoyBottomSheetOpenOptions>;
157
- };
158
164
  }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
159
165
  bottomSheet: {
160
166
  type: import("vue").PropType<({
@@ -163,6 +169,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
163
169
  $props: {
164
170
  closeLabel?: string | undefined;
165
171
  open?: boolean | undefined;
172
+ preventBodyScroll?: boolean | undefined;
166
173
  teleport?: string | import("vue").RendererElement | null | undefined;
167
174
  frozen?: boolean | undefined;
168
175
  style?: unknown;
@@ -233,6 +240,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
233
240
  type: BooleanConstructor;
234
241
  default: boolean;
235
242
  };
243
+ preventBodyScroll: {
244
+ type: BooleanConstructor;
245
+ default: boolean;
246
+ };
236
247
  teleport: {
237
248
  type: import("vue").PropType<string | import("vue").RendererElement | null | undefined>;
238
249
  default: string;
@@ -244,8 +255,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
244
255
  }>> & {
245
256
  "onBottom-sheet:close"?: (() => any) | undefined;
246
257
  }, {
247
- openBottomSheet: (options?: IJoyBottomSheetOpenOptions) => void; /** VJoyBottomSheet ref. */
248
- closeBottomSheet: () => void;
258
+ hide: () => void;
259
+ show: () => void;
249
260
  isOpen: import("vue").Ref<boolean>;
250
261
  moveContainer: (translationY: number) => void;
251
262
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -253,6 +264,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
253
264
  }, string, {
254
265
  closeLabel: string;
255
266
  open: boolean;
267
+ preventBodyScroll: boolean;
256
268
  teleport: string | import("vue").RendererElement | null | undefined;
257
269
  frozen: boolean;
258
270
  }, {}, string, {}> & {
@@ -284,6 +296,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
284
296
  type: BooleanConstructor;
285
297
  default: boolean;
286
298
  };
299
+ preventBodyScroll: {
300
+ type: BooleanConstructor;
301
+ default: boolean;
302
+ };
287
303
  teleport: {
288
304
  type: import("vue").PropType<string | import("vue").RendererElement | null | undefined>;
289
305
  default: string;
@@ -295,8 +311,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
295
311
  }>> & {
296
312
  "onBottom-sheet:close"?: (() => any) | undefined;
297
313
  } & import("vue").ShallowUnwrapRef<{
298
- openBottomSheet: (options?: IJoyBottomSheetOpenOptions) => void; /** VJoyBottomSheet ref. */
299
- closeBottomSheet: () => void;
314
+ hide: () => void;
315
+ show: () => void;
300
316
  isOpen: import("vue").Ref<boolean>;
301
317
  moveContainer: (translationY: number) => void;
302
318
  }> & {} & import("vue").ComponentCustomProperties & {} & {
@@ -307,9 +323,6 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
307
323
  }) | null | undefined>;
308
324
  required: true;
309
325
  };
310
- options: {
311
- type: import("vue").PropType<IJoyBottomSheetOpenOptions>;
312
- };
313
326
  }>>, {}, {}>, Readonly<{
314
327
  /** @slot Default slot where you can render anything you need. */
315
328
  default: () => any;
package/dist/components/JoyDialog/VJoyDialog.vue.d.ts CHANGED
@@ -1,9 +1,13 @@
1
1
  import { PropType } from 'vue';
2
2
  import { TJoyButtonSizes } from '../JoyButton/JoyButton.types';
3
- import { IDialogOpenOption } from './JoyDialog.types';
4
- declare function hideOverlay(): Promise<void>;
5
- declare function openOverlay(options?: IDialogOpenOption): Promise<void>;
3
+ declare function hide(options?: {
4
+ fireHideEvent: boolean;
5
+ }): Promise<void>;
6
+ declare function show(): Promise<void>;
6
7
  declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
8
+ id: {
9
+ type: StringConstructor;
10
+ };
7
11
  /** By default a focus-trap is activated. It means you can loop over all interactive elements within the open dialog. */
8
12
  focusTrap: {
9
13
  type: BooleanConstructor;
@@ -18,6 +22,13 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
18
22
  type: BooleanConstructor;
19
23
  default: boolean;
20
24
  };
25
+ /**
26
+ * @internal - Mostly for documentation purpose
27
+ */
28
+ preventBodyScroll: {
29
+ type: BooleanConstructor;
30
+ default: boolean;
31
+ };
21
32
  /** **For accessibility purpose**. Label associated with the top right corner icon. */
22
33
  closeLabel: {
23
34
  type: StringConstructor;
@@ -55,16 +66,22 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
55
66
  default: number;
56
67
  };
57
68
  }, {
58
- openOverlay: typeof openOverlay;
69
+ focusTrapReturn: import("@vueuse/integrations/useFocusTrap").UseFocusTrapReturn;
59
70
  hasFooterSlots: import("vue").ComputedRef<boolean>;
60
- hideOverlay: typeof hideOverlay;
71
+ hide: typeof hide;
61
72
  isOpen: import("vue").Ref<boolean>;
73
+ show: typeof show;
62
74
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
63
75
  "dialog:open": () => void;
64
76
  "dialog:after-open": () => void;
65
77
  "dialog:hide": () => void;
66
78
  "dialog:after-hide": () => void;
79
+ "dialog:before-unmount": () => void;
80
+ "dialog:confirm": () => void;
67
81
  }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
82
+ id: {
83
+ type: StringConstructor;
84
+ };
68
85
  /** By default a focus-trap is activated. It means you can loop over all interactive elements within the open dialog. */
69
86
  focusTrap: {
70
87
  type: BooleanConstructor;
@@ -79,6 +96,13 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
79
96
  type: BooleanConstructor;
80
97
  default: boolean;
81
98
  };
99
+ /**
100
+ * @internal - Mostly for documentation purpose
101
+ */
102
+ preventBodyScroll: {
103
+ type: BooleanConstructor;
104
+ default: boolean;
105
+ };
82
106
  /** **For accessibility purpose**. Label associated with the top right corner icon. */
83
107
  closeLabel: {
84
108
  type: StringConstructor;
@@ -120,9 +144,12 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
120
144
  "onDialog:after-open"?: (() => any) | undefined;
121
145
  "onDialog:hide"?: (() => any) | undefined;
122
146
  "onDialog:after-hide"?: (() => any) | undefined;
147
+ "onDialog:before-unmount"?: (() => any) | undefined;
148
+ "onDialog:confirm"?: (() => any) | undefined;
123
149
  }, {
124
150
  closeLabel: string;
125
151
  open: boolean;
152
+ preventBodyScroll: boolean;
126
153
  teleport: string | import("vue").RendererElement | null | undefined;
127
154
  focusTrap: boolean;
128
155
  patternConfirm: boolean;
package/dist/components/JoyDialogTrigger/VJoyDialogTrigger.vue.d.ts CHANGED
@@ -7,6 +7,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
7
7
  $props: {
8
8
  closeLabel?: string | undefined;
9
9
  open?: boolean | undefined;
10
+ preventBodyScroll?: boolean | undefined;
10
11
  teleport?: string | import("vue").RendererElement | null | undefined;
11
12
  focusTrap?: boolean | undefined;
12
13
  patternConfirm?: boolean | undefined;
@@ -56,6 +57,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
56
57
  }>) => void) | ((vnode: VNode<import("vue").RendererNode, import("vue").RendererElement, {
57
58
  [key: string]: any;
58
59
  }>) => void)[] | undefined;
60
+ readonly id?: string | undefined;
59
61
  readonly cancelText?: string | undefined;
60
62
  readonly confirmText?: string | undefined;
61
63
  readonly bannerSrc?: string | undefined;
@@ -64,6 +66,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
64
66
  "onDialog:after-open"?: (() => any) | undefined;
65
67
  "onDialog:hide"?: (() => any) | undefined;
66
68
  "onDialog:after-hide"?: (() => any) | undefined;
69
+ "onDialog:before-unmount"?: (() => any) | undefined;
70
+ "onDialog:confirm"?: (() => any) | undefined;
67
71
  };
68
72
  $attrs: {
69
73
  [x: string]: unknown;
@@ -76,9 +80,12 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
76
80
  }>;
77
81
  $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
78
82
  $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
79
- $emit: ((event: "dialog:open") => void) & ((event: "dialog:after-open") => void) & ((event: "dialog:hide") => void) & ((event: "dialog:after-hide") => void);
83
+ $emit: ((event: "dialog:open") => void) & ((event: "dialog:after-open") => void) & ((event: "dialog:hide") => void) & ((event: "dialog:after-hide") => void) & ((event: "dialog:before-unmount") => void) & ((event: "dialog:confirm") => void);
80
84
  $el: any;
81
85
  $options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
86
+ id: {
87
+ type: StringConstructor;
88
+ };
82
89
  focusTrap: {
83
90
  type: BooleanConstructor;
84
91
  default: boolean;
@@ -91,6 +98,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
91
98
  type: BooleanConstructor;
92
99
  default: boolean;
93
100
  };
101
+ preventBodyScroll: {
102
+ type: BooleanConstructor;
103
+ default: boolean;
104
+ };
94
105
  closeLabel: {
95
106
  type: StringConstructor;
96
107
  default: string;
@@ -124,19 +135,27 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
124
135
  "onDialog:after-open"?: (() => any) | undefined;
125
136
  "onDialog:hide"?: (() => any) | undefined;
126
137
  "onDialog:after-hide"?: (() => any) | undefined;
138
+ "onDialog:before-unmount"?: (() => any) | undefined;
139
+ "onDialog:confirm"?: (() => any) | undefined;
127
140
  }, {
128
- openOverlay: (options?: import("../components.types").IDialogOpenOption | undefined) => Promise<void>;
141
+ focusTrapReturn: import("@vueuse/integrations/useFocusTrap").UseFocusTrapReturn;
129
142
  hasFooterSlots: import("vue").ComputedRef<boolean>;
130
- hideOverlay: () => Promise<void>;
143
+ hide: (options?: {
144
+ fireHideEvent: boolean;
145
+ }) => Promise<void>;
131
146
  isOpen: import("vue").Ref<boolean>;
147
+ show: () => Promise<void>;
132
148
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
133
149
  "dialog:open": () => void;
134
150
  "dialog:after-open": () => void;
135
151
  "dialog:hide": () => void;
136
152
  "dialog:after-hide": () => void;
153
+ "dialog:before-unmount": () => void;
154
+ "dialog:confirm": () => void;
137
155
  }, string, {
138
156
  closeLabel: string;
139
157
  open: boolean;
158
+ preventBodyScroll: boolean;
140
159
  teleport: string | import("vue").RendererElement | null | undefined;
141
160
  focusTrap: boolean;
142
161
  patternConfirm: boolean;
@@ -163,6 +182,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
163
182
  $nextTick: typeof import("vue").nextTick;
164
183
  $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;
165
184
  } & Readonly<import("vue").ExtractPropTypes<{
185
+ id: {
186
+ type: StringConstructor;
187
+ };
166
188
  focusTrap: {
167
189
  type: BooleanConstructor;
168
190
  default: boolean;
@@ -175,6 +197,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
175
197
  type: BooleanConstructor;
176
198
  default: boolean;
177
199
  };
200
+ preventBodyScroll: {
201
+ type: BooleanConstructor;
202
+ default: boolean;
203
+ };
178
204
  closeLabel: {
179
205
  type: StringConstructor;
180
206
  default: string;
@@ -208,11 +234,16 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
208
234
  "onDialog:after-open"?: (() => any) | undefined;
209
235
  "onDialog:hide"?: (() => any) | undefined;
210
236
  "onDialog:after-hide"?: (() => any) | undefined;
237
+ "onDialog:before-unmount"?: (() => any) | undefined;
238
+ "onDialog:confirm"?: (() => any) | undefined;
211
239
  } & import("vue").ShallowUnwrapRef<{
212
- openOverlay: (options?: import("../components.types").IDialogOpenOption | undefined) => Promise<void>;
240
+ focusTrapReturn: import("@vueuse/integrations/useFocusTrap").UseFocusTrapReturn;
213
241
  hasFooterSlots: import("vue").ComputedRef<boolean>;
214
- hideOverlay: () => Promise<void>;
242
+ hide: (options?: {
243
+ fireHideEvent: boolean;
244
+ }) => Promise<void>;
215
245
  isOpen: import("vue").Ref<boolean>;
246
+ show: () => Promise<void>;
216
247
  }> & {} & import("vue").ComponentCustomProperties & {} & {
217
248
  $slots: {
218
249
  "dialog-header"?(_: {}): any;
@@ -233,6 +264,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
233
264
  $props: {
234
265
  closeLabel?: string | undefined;
235
266
  open?: boolean | undefined;
267
+ preventBodyScroll?: boolean | undefined;
236
268
  teleport?: string | import("vue").RendererElement | null | undefined;
237
269
  focusTrap?: boolean | undefined;
238
270
  patternConfirm?: boolean | undefined;
@@ -282,6 +314,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
282
314
  }>) => void) | ((vnode: VNode<import("vue").RendererNode, import("vue").RendererElement, {
283
315
  [key: string]: any;
284
316
  }>) => void)[] | undefined;
317
+ readonly id?: string | undefined;
285
318
  readonly cancelText?: string | undefined;
286
319
  readonly confirmText?: string | undefined;
287
320
  readonly bannerSrc?: string | undefined;
@@ -290,6 +323,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
290
323
  "onDialog:after-open"?: (() => any) | undefined;
291
324
  "onDialog:hide"?: (() => any) | undefined;
292
325
  "onDialog:after-hide"?: (() => any) | undefined;
326
+ "onDialog:before-unmount"?: (() => any) | undefined;
327
+ "onDialog:confirm"?: (() => any) | undefined;
293
328
  };
294
329
  $attrs: {
295
330
  [x: string]: unknown;
@@ -302,9 +337,12 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
302
337
  }>;
303
338
  $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
304
339
  $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
305
- $emit: ((event: "dialog:open") => void) & ((event: "dialog:after-open") => void) & ((event: "dialog:hide") => void) & ((event: "dialog:after-hide") => void);
340
+ $emit: ((event: "dialog:open") => void) & ((event: "dialog:after-open") => void) & ((event: "dialog:hide") => void) & ((event: "dialog:after-hide") => void) & ((event: "dialog:before-unmount") => void) & ((event: "dialog:confirm") => void);
306
341
  $el: any;
307
342
  $options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
343
+ id: {
344
+ type: StringConstructor;
345
+ };
308
346
  focusTrap: {
309
347
  type: BooleanConstructor;
310
348
  default: boolean;
@@ -317,6 +355,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
317
355
  type: BooleanConstructor;
318
356
  default: boolean;
319
357
  };
358
+ preventBodyScroll: {
359
+ type: BooleanConstructor;
360
+ default: boolean;
361
+ };
320
362
  closeLabel: {
321
363
  type: StringConstructor;
322
364
  default: string;
@@ -350,19 +392,27 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
350
392
  "onDialog:after-open"?: (() => any) | undefined;
351
393
  "onDialog:hide"?: (() => any) | undefined;
352
394
  "onDialog:after-hide"?: (() => any) | undefined;
395
+ "onDialog:before-unmount"?: (() => any) | undefined;
396
+ "onDialog:confirm"?: (() => any) | undefined;
353
397
  }, {
354
- openOverlay: (options?: import("../components.types").IDialogOpenOption | undefined) => Promise<void>;
398
+ focusTrapReturn: import("@vueuse/integrations/useFocusTrap").UseFocusTrapReturn;
355
399
  hasFooterSlots: import("vue").ComputedRef<boolean>;
356
- hideOverlay: () => Promise<void>;
400
+ hide: (options?: {
401
+ fireHideEvent: boolean;
402
+ }) => Promise<void>;
357
403
  isOpen: import("vue").Ref<boolean>;
404
+ show: () => Promise<void>;
358
405
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
359
406
  "dialog:open": () => void;
360
407
  "dialog:after-open": () => void;
361
408
  "dialog:hide": () => void;
362
409
  "dialog:after-hide": () => void;
410
+ "dialog:before-unmount": () => void;
411
+ "dialog:confirm": () => void;
363
412
  }, string, {
364
413
  closeLabel: string;
365
414
  open: boolean;
415
+ preventBodyScroll: boolean;
366
416
  teleport: string | import("vue").RendererElement | null | undefined;
367
417
  focusTrap: boolean;
368
418
  patternConfirm: boolean;
@@ -389,6 +439,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
389
439
  $nextTick: typeof import("vue").nextTick;
390
440
  $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;
391
441
  } & Readonly<import("vue").ExtractPropTypes<{
442
+ id: {
443
+ type: StringConstructor;
444
+ };
392
445
  focusTrap: {
393
446
  type: BooleanConstructor;
394
447
  default: boolean;
@@ -401,6 +454,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
401
454
  type: BooleanConstructor;
402
455
  default: boolean;
403
456
  };
457
+ preventBodyScroll: {
458
+ type: BooleanConstructor;
459
+ default: boolean;
460
+ };
404
461
  closeLabel: {
405
462
  type: StringConstructor;
406
463
  default: string;
@@ -434,11 +491,16 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
434
491
  "onDialog:after-open"?: (() => any) | undefined;
435
492
  "onDialog:hide"?: (() => any) | undefined;
436
493
  "onDialog:after-hide"?: (() => any) | undefined;
494
+ "onDialog:before-unmount"?: (() => any) | undefined;
495
+ "onDialog:confirm"?: (() => any) | undefined;
437
496
  } & import("vue").ShallowUnwrapRef<{
438
- openOverlay: (options?: import("../components.types").IDialogOpenOption | undefined) => Promise<void>;
497
+ focusTrapReturn: import("@vueuse/integrations/useFocusTrap").UseFocusTrapReturn;
439
498
  hasFooterSlots: import("vue").ComputedRef<boolean>;
440
- hideOverlay: () => Promise<void>;
499
+ hide: (options?: {
500
+ fireHideEvent: boolean;
501
+ }) => Promise<void>;
441
502
  isOpen: import("vue").Ref<boolean>;
503
+ show: () => Promise<void>;
442
504
  }> & {} & import("vue").ComponentCustomProperties & {} & {
443
505
  $slots: {
444
506
  "dialog-header"?(_: {}): any;
package/dist/components/JoyDrawer/JoyDrawer.types.d.ts CHANGED
@@ -1,7 +1,2 @@
1
- export interface IDrawerOpenOption {
2
- callback?: (...args: any) => void;
3
- preventBodyScroll?: boolean;
4
- patternConfirm?: boolean;
5
- }
6
1
  export declare const DRAWER_SIZES: readonly ["default", "large"];
7
2
  export type TJoyDrawerSizes = (typeof DRAWER_SIZES)[number];
package/dist/components/JoyDrawer/VJoyDrawer.vue.d.ts CHANGED
@@ -1,9 +1,19 @@
1
1
  import { PropType } from 'vue';
2
2
  import { TJoyButtonSizes } from '../JoyButton/JoyButton.types';
3
- import { IDrawerOpenOption } from './JoyDrawer.types';
4
- declare function hideOverlay(): Promise<void>;
5
- declare function openOverlay(options?: IDrawerOpenOption): Promise<void>;
3
+ declare function hide(options?: {
4
+ fireHideEvent: boolean;
5
+ }): Promise<void>;
6
+ /**
7
+ * @param {Object} options -
8
+ * @param {Boolean} options.preventBodyScroll - By default body has an overflow hidden.
9
+ * @param {Boolean} options.focusTrap - By default a focus-trap is activated on the drawer, when opened.
10
+ * @returns {Promise<void>} -
11
+ */
12
+ declare function show(): Promise<void>;
6
13
  declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
14
+ id: {
15
+ type: StringConstructor;
16
+ };
7
17
  /** By default a focus-trap is activated. It means you can loop over all interactive elements within the open drawer. */
8
18
  focusTrap: {
9
19
  type: BooleanConstructor;
@@ -22,11 +32,18 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
22
32
  type: BooleanConstructor;
23
33
  default: boolean;
24
34
  };
25
- /** Removes the overlay and allows interacting with background content */
35
+ /** Removes the overlay and allows interacting with background content. It deactivates the focusTrap as well. */
26
36
  elevated: {
27
37
  type: BooleanConstructor;
28
38
  default: boolean;
29
39
  };
40
+ /**
41
+ * @internal - Mostly for documentation purpose
42
+ */
43
+ preventBodyScroll: {
44
+ type: BooleanConstructor;
45
+ default: boolean;
46
+ };
30
47
  /** **For accessibility purpose**. Label associated with the top right corner icon. */
31
48
  closeLabel: {
32
49
  type: StringConstructor;
@@ -45,16 +62,22 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
45
62
  default: string;
46
63
  };
47
64
  }, {
48
- openOverlay: typeof openOverlay;
65
+ focusTrapReturn: import("@vueuse/integrations/useFocusTrap").UseFocusTrapReturn;
49
66
  hasFooterSlots: import("vue").ComputedRef<boolean>;
50
- hideOverlay: typeof hideOverlay;
67
+ hide: typeof hide;
51
68
  isOpen: import("vue").Ref<boolean>;
69
+ show: typeof show;
52
70
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
53
71
  "drawer:open": () => void;
54
72
  "drawer:after-open": () => void;
55
73
  "drawer:hide": () => void;
56
74
  "drawer:after-hide": () => void;
75
+ "drawer:before-unmount": () => void;
76
+ "drawer:confirm": () => void;
57
77
  }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
78
+ id: {
79
+ type: StringConstructor;
80
+ };
58
81
  /** By default a focus-trap is activated. It means you can loop over all interactive elements within the open drawer. */
59
82
  focusTrap: {
60
83
  type: BooleanConstructor;
@@ -73,11 +96,18 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
73
96
  type: BooleanConstructor;
74
97
  default: boolean;
75
98
  };
76
- /** Removes the overlay and allows interacting with background content */
99
+ /** Removes the overlay and allows interacting with background content. It deactivates the focusTrap as well. */
77
100
  elevated: {
78
101
  type: BooleanConstructor;
79
102
  default: boolean;
80
103
  };
104
+ /**
105
+ * @internal - Mostly for documentation purpose
106
+ */
107
+ preventBodyScroll: {
108
+ type: BooleanConstructor;
109
+ default: boolean;
110
+ };
81
111
  /** **For accessibility purpose**. Label associated with the top right corner icon. */
82
112
  closeLabel: {
83
113
  type: StringConstructor;
@@ -100,10 +130,13 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
100
130
  "onDrawer:after-open"?: (() => any) | undefined;
101
131
  "onDrawer:hide"?: (() => any) | undefined;
102
132
  "onDrawer:after-hide"?: (() => any) | undefined;
133
+ "onDrawer:before-unmount"?: (() => any) | undefined;
134
+ "onDrawer:confirm"?: (() => any) | undefined;
103
135
  }, {
104
136
  size: "default" | "large";
105
137
  closeLabel: string;
106
138
  open: boolean;
139
+ preventBodyScroll: boolean;
107
140
  teleport: string | import("vue").RendererElement | null | undefined;
108
141
  focusTrap: boolean;
109
142
  buttonSize: TJoyButtonSizes;