-
-
Notifications
You must be signed in to change notification settings - Fork 112
/
modal.data.ts
521 lines (519 loc) · 16.3 KB
/
modal.data.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
import type {ComponentReference, SlotScopeReference} from './ComponentReference'
const sharedSlots: SlotScopeReference[] = [
{
prop: 'cancel',
type: 'Function',
description:
"Closes the modal and fires the 'cancel' and 'hide' events, with `bvModalEvent.trigger = 'cancel'`",
},
{
prop: 'close',
type: 'Function',
description:
"Closes the modal and fires the close and hide events, with `bvModalEvent.trigger = 'headerclose'`",
},
{
prop: 'hide',
type: 'Function',
description:
"Accepts one argument 'trigger'. Closes the modal and fires the 'hide' event, with the `bvModalEvent.trigger = trigger` (`trigger` is optional)",
},
{
prop: 'ok',
type: 'Function',
description:
"Closes the modal and fires the 'ok' and 'hide' events, with `bvModalEvent.trigger = 'ok'`",
},
{
prop: 'visible',
type: 'boolean',
description:
"The visibility state of the modal. 'true' if the modal is visible and 'false' if not visible",
},
]
export default {
load: (): ComponentReference[] => [
{
component: 'BModal',
props: [
{
prop: 'autoFocus',
type: 'boolean',
default: true,
description: "When set to 'false', disables auto focusing the modal when opened",
},
{
prop: 'autoFocusButton',
type: "'ok' | 'cancel' | 'close'",
default: undefined,
description:
"Specify which built-in button to focus once the modal opens: 'ok', 'cancel', or 'close'",
},
{
prop: 'backdropVariant',
type: 'ColorVariant | null',
default: undefined,
description: 'Applies one of the Bootstrap theme color variants to the backdrop',
},
{
prop: 'bodyBgVariant',
type: 'ColorVariant | null',
default: null,
description: 'Applies one of the Bootstrap theme color variants to the body background',
},
{
prop: 'bodyClass',
type: 'ClassValue',
default: undefined,
description: "CSS class (or classes) to apply to the '.modal-body' wrapper element",
},
{
prop: 'bodyScrolling',
type: 'boolean',
default: false,
description: 'Enables/disables scrolling the body while modal is open',
},
{
prop: 'bodyTextVariant',
type: 'ColorVariant | null',
default: undefined,
description: 'Applies one of the Bootstrap theme color variants to the body text',
},
{
prop: 'bodyVariant',
type: 'ColorVariant | null',
default: null,
description:
'Applies one of the Bootstrap theme color variants to the body (this takes priority over bodyBgVariant and bodyTextVariant)',
},
{
prop: 'busy',
type: 'boolean',
default: false,
description:
'Places the built in default footer OK and Cancel buttons in the disabled state',
},
{
prop: 'cancelDisabled',
type: 'boolean',
default: false,
description: 'Places the built in default footer Cancel button in the disabled state',
},
{
prop: 'cancelTitle',
type: 'string',
default: 'Cancel',
description: 'Text string to place in the default footer Cancel button',
},
{
prop: 'cancelVariant',
type: 'ButtonVariant | null',
default: 'secondary',
description: 'Variant to use for the default footer Cancel button',
},
{
prop: 'centered',
type: 'boolean',
default: false,
description: 'Vertically centers the modal in the viewport',
},
{
prop: 'contentClass',
type: 'ClassValue',
default: undefined,
description: "CSS class (or classes) to apply to the '.modal-content' wrapper element",
},
{
prop: 'dialogClass',
type: 'ClassValue',
default: undefined,
description: "CSS class (or classes) to apply to the '.modal-dialog' wrapper element",
},
{
prop: 'footerBgVariant',
type: 'ColorVariant | null',
default: null,
description: 'Applies one of the Bootstrap theme color variants to the footer background',
},
{
prop: 'footerBorderVariant',
type: 'ColorVariant | null',
default: null,
description: 'Applies one of the Bootstrap theme color variants to the footer border',
},
{
prop: 'footerClass',
type: 'ClassValue',
default: undefined,
description: "CSS class (or classes) to apply to the '.modal-footer' wrapper element",
},
{
prop: 'footerTextVariant',
type: 'ColorVariant | null',
default: null,
description: 'Applies one of the Bootstrap theme color variants to the footer text',
},
{
prop: 'footerVariant',
type: 'ColorVariant | null',
default: null,
description:
'Applies one of the Bootstrap theme color variants to the footer (this takes priority over footerBgVariant and footerTextVariant)',
},
{
prop: 'fullscreen',
type: 'boolean | Breakpoint',
default: false,
description:
"A boolean value will enable/disable full screen mode. A Breakpoint value will set the breakpoint to enable full screen mode below the value of the breakpoint. Breakpoint values are: 'sm', 'md', 'lg', 'xl', 'xxl'",
},
{
prop: 'headerBgVariant',
type: 'ColorVariant | null',
default: null,
description: 'Applies one of the Bootstrap theme color variants to the header background',
},
{
prop: 'headerBorderVariant',
type: 'ColorVariant | null',
default: null,
description: 'Applies one of the Bootstrap theme color variants to the header border',
},
{
prop: 'headerClass',
type: 'ClassValue',
default: undefined,
description: "CSS class (or classes) to apply to the '.modal-header' wrapper element",
},
{
prop: 'headerCloseClass',
type: 'ClassValue',
default: undefined,
description: 'CSS class (or classes) to apply to the header close button',
},
{
prop: 'headerCloseLabel',
type: 'string',
default: 'Close',
description: 'Accessibility label for the header close button',
},
{
prop: 'headerCloseVariant',
type: 'ButtonVariant | null',
default: 'secondary',
description:
'Applies a variant to the header close button when the header close button uses the header-close slot',
},
{
prop: 'headerTextVariant',
type: 'ColorVariant | null',
default: null,
description: 'Applies one of the Bootstrap theme color variants to the header text',
},
{
prop: 'headerVariant',
type: 'ColorVariant | null',
default: null,
description:
'Applies one of the Bootstrap theme color variants to the header (this takes priority over headerBgVariant and headerTextVariant)',
},
{
prop: 'hideBackdrop',
type: 'boolean',
default: false,
description: 'Disables rendering of the modal backdrop',
},
{
prop: 'hideFooter',
type: 'boolean',
default: false,
description: 'Disables rendering of the modal footer',
},
{
prop: 'hideHeader',
type: 'boolean',
default: false,
description: 'Disables rendering of the modal header',
},
{
prop: 'hideHeaderClose',
type: 'boolean',
default: false,
description: 'Disables rendering of the modal header close button',
},
{
prop: 'id',
type: 'string',
default: undefined,
description:
"Used to set the 'id' attribute on the rendered content, and used as the base to generate any additional element IDs as needed",
},
{
prop: 'lazy',
type: 'boolean',
default: false,
description: 'Renders the modal content lazily',
},
{
prop: 'modalClass',
type: 'ClassValue',
default: undefined,
description: "CSS class (or classes) to apply to the '.modal' wrapper element",
},
{
prop: 'modelValue',
type: 'boolean',
default: false,
description: 'Controls the visibility state of the modal',
},
{
prop: 'noCloseOnBackdrop',
type: 'boolean',
default: false,
description:
'Disables closing the modal when clicking on the modal backdrop (outside the modal window)',
},
{
prop: 'noCloseOnEsc',
type: 'boolean',
default: false,
description: 'Disables the ability to close the modal by pressing the ESC key',
},
{
prop: 'noFade',
type: 'boolean',
default: false,
description:
"When set to 'true', disables the fade animation/transition on the component",
},
{
prop: 'okDisabled',
type: 'boolean',
default: false,
description: 'Places the built in default footer OK button in the disabled state',
},
{
prop: 'okOnly',
type: 'boolean',
default: false,
description: 'Disables rendering of the default footer Cancel button',
},
{
prop: 'okTitle',
type: 'string',
default: 'Ok',
description: 'Text string to place in the default footer OK button',
},
{
prop: 'okVariant',
type: 'ButtonVariant | null',
default: 'primary',
description: 'Button color theme variant to apply to the default footer OK button',
},
{
prop: 'scrollable',
type: 'boolean',
default: false,
description: 'Enables scrolling of the modal body',
},
{
prop: 'size',
type: "Size | 'xl'",
default: 'md',
description: "Set the size of the modal's width. 'sm', 'md' (default), 'lg', or 'xl'",
},
{
prop: 'teleportDisabled',
type: 'boolean',
default: false,
description: 'Renders the modal in the exact place it was defined',
},
{
prop: 'teleportTo',
type: 'string | RendererElement | null | undefined',
default: 'body',
description: 'Overrides the default teleport location',
},
{
prop: 'title',
type: 'string',
default: undefined,
description: 'Text content to place in the title',
},
{
prop: 'titleClass',
type: 'ClassValue',
default: undefined,
description: 'CSS class (or classes) to apply to the title',
},
{
prop: 'titleVisibilityHiddenOnly',
type: 'boolean',
default: false,
description: "Wraps the title in an '.visually-hidden' wrapper",
},
{
prop: 'titleTag',
type: 'string',
default: 'h5',
description: 'Specify the HTML tag to render instead of the default tag for the title',
},
{
prop: 'type',
type: 'string',
default: undefined,
description: 'Type of the component',
},
],
emits: [
{
event: 'update:modelValue',
args: [
{
arg: 'value',
description: "The new value of the modal's visible state",
type: 'boolean',
},
],
description: 'Emitted when modal visibility changes',
},
{
event: 'show',
args: [
{
arg: 'value',
description: '',
type: 'BvTriggerableEvent',
},
],
description: 'Always emits just before modal is shown. Cancelable',
},
{
event: 'shown',
args: [
{
arg: 'value',
description: '',
type: 'BvTriggerableEvent',
},
],
description: 'Always emits just after modal is shown. Cancelable',
},
{
event: 'hide',
args: [
{
arg: 'value',
description: '',
type: 'BvTriggerableEvent',
},
],
description:
"Always emits just before modal has hidden. Cancelable (as long as modal wasn't forcibly hidden)",
},
{
event: 'hidden',
args: [
{
arg: 'value',
description: '',
type: 'BvTriggerableEvent',
},
],
description: 'Always emits after modal is hidden',
},
{
event: 'hide-prevented',
args: [],
description:
'Emitted when the modal tried to close, but was prevented from closing. This occurs when preventDefault() is called on the event, the user clicks escape and no-close-onbackdrop is set to true, or the user clicks on the backdrop and no-close-onbackdrop is set to true.',
},
{
event: 'show-prevented',
args: [],
description:
'Emitted when the modal tried to open, but was prevented from opening. This occurs when preventDefault() is called on the event',
},
{
event: 'ok',
args: [
{
arg: 'value',
description: '',
type: 'BvTriggerableEvent',
},
],
description: 'Emitted when the default footer ok button is clicked. Cancelable',
},
{
event: 'cancel',
args: [
{
arg: 'value',
description: '',
type: 'BvTriggerableEvent',
},
],
description: 'Emitted when the default footer cancel button is clicked. Cancelable',
},
{
event: 'close',
args: [
{
arg: 'value',
description: '',
type: 'BvTriggerableEvent',
},
],
description: 'Emitted when the default header close button is clicked. Cancelable',
},
],
slots: [
{
name: 'backdrop',
description: 'Modal Backdrop content',
scope: [],
},
{
name: 'cancel',
description: 'Modal CANCEL button content. Optionally scoped',
scope: sharedSlots,
},
{
name: 'default',
description: 'Content of modal body. Optionally scoped',
scope: sharedSlots,
},
{
name: 'footer',
description:
'Modal footer content. Also removes default OK and Cancel buttons. Optionally scoped',
scope: sharedSlots,
},
{
name: 'header',
description:
'Entire modal header container contents. Also removes the top right X close button. Optionally scoped',
scope: sharedSlots,
},
{
name: 'header-close',
description:
"Content of Modal header close button. If 'header' slot is used, this slot will not be shown",
scope: [],
},
{
name: 'ok',
description: 'Modal OK button content. Optionally scoped',
scope: sharedSlots,
},
{
name: 'title',
description:
"Modal title. If 'header' slot is used, this slot will not be shown. Optionally scoped",
scope: sharedSlots,
},
],
},
],
}