package.json
21.7 KB
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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
{
"name": "@bootstrap-vue/modal",
"version": "1.0.0",
"meta": {
"title": "Modal",
"description": "Modals are streamlined, but flexible dialog prompts powered by JavaScript and CSS. They support a number of use cases from user notification to completely custom content and feature a handful of helpful sub-components, sizes, variants, accessibility, and more.",
"plugins": [
"BVModalPlugin"
],
"directives": [
{
"directive": "VBModal",
"description": "Directive for opening a modal by ID",
"expression": "String",
"arg": {
"pattern": "[a-zA-Z][a-zA-Z0-9_\\-]*",
"description": "Modal ID to open",
"required": false
},
"modifiers": [
{
"name": "{modalId}",
"pattern": "[a-zA-Z][a-zA-Z0-9_\\-]*",
"description": "Modal ID to open. Replace `{modalId}` with the modal's ID"
}
]
}
],
"components": [
{
"component": "BModal",
"props": [
{
"prop": "ariaLabel",
"description": "Explicitly supply an 'aria-label' attribute for the modal. Should be set when the modal has no title. When not set 'aria-labelledby' will point to the modal's title"
},
{
"prop": "autoFocusButton",
"version": "2.0.0",
"description": "Specify which built-in button to focus once the modal opens: 'ok', 'cancel', or 'close'"
},
{
"prop": "bodyBgVariant",
"description": "Applies one of the Bootstrap theme color variants to the body background"
},
{
"prop": "bodyClass",
"description": "CSS class (or classes) to apply to the '.modal-body' wrapper element"
},
{
"prop": "bodyTextVariant",
"description": "Applies one of the Bootstrap theme color variants to the body text"
},
{
"prop": "busy",
"description": "Places the built in default footer OK and Cancel buttons in the disabled state"
},
{
"prop": "buttonSize",
"description": "Size of the built in footer buttons: 'sm', 'md' (default), or 'lg'"
},
{
"prop": "cancelDisabled",
"description": "Places the default footer Cancel button in the disabled state"
},
{
"prop": "cancelTitle",
"description": "Text string to place in the default footer Cancel button"
},
{
"prop": "cancelTitleHtml",
"description": "HTML string to place in the default footer Cancel button",
"xss": true
},
{
"prop": "cancelVariant",
"description": "Button color theme variant to apply to the default footer Cancel button"
},
{
"prop": "centered",
"description": "Vertically centers the modal in the viewport"
},
{
"prop": "contentClass",
"description": "CSS class (or classes) to apply to the '.modal-content' wrapper element"
},
{
"prop": "dialogClass",
"description": "CSS class (or classes) to apply to the '.modal-dialog' wrapper element"
},
{
"prop": "footerBgVariant",
"description": "Applies one of the Bootstrap theme color variants to the footer background"
},
{
"prop": "footerBorderVariant",
"description": "Applies one of the Bootstrap theme color variants to the footer border"
},
{
"prop": "footerClass",
"description": "CSS class (or classes) to apply to the '.modal-footer' wrapper element"
},
{
"prop": "footerTextVariant",
"description": "Applies one of the Bootstrap theme color variants to the footer text"
},
{
"prop": "footerTag",
"version": "2.22.0",
"description": "Specify the HTML tag to render instead of the default tag for the footer"
},
{
"prop": "headerBgVariant",
"description": "Applies one of the Bootstrap theme color variants to the header background"
},
{
"prop": "headerBorderVariant",
"description": "Applies one of the Bootstrap theme color variants to the header border"
},
{
"prop": "headerClass",
"description": "CSS class (or classes) to apply to the '.modal-header' wrapper element"
},
{
"prop": "headerCloseContent",
"version": "2.3.0",
"description": "Content of the header close button"
},
{
"prop": "headerCloseLabel",
"description": "Value of the 'aria-label' on the header close button"
},
{
"prop": "headerCloseVariant",
"description": "Text theme color variant to apply to the header close button"
},
{
"prop": "headerTextVariant",
"description": "Applies one of the Bootstrap theme color variants to the header text"
},
{
"prop": "headerTag",
"version": "2.22.0",
"description": "Specify the HTML tag to render instead of the default tag for the footer"
},
{
"prop": "hideBackdrop",
"description": "Disables rendering of the modal backdrop"
},
{
"prop": "hideFooter",
"description": "Disables rendering of the modal footer"
},
{
"prop": "hideHeader",
"description": "Disables rendering of the modal header"
},
{
"prop": "hideHeaderClose",
"description": "Disables rendering of the modal header's close button"
},
{
"prop": "ignoreEnforceFocusSelector",
"version": "2.4.0",
"description": "Ignore certain elements from the enforce focus routine, specified by css selector(s)"
},
{
"prop": "lazy",
"description": "When the modal has the `static` prop set, renders the modal content lazily"
},
{
"prop": "modalClass",
"description": "CSS class (or classes) to apply to the '.modal' wrapper element"
},
{
"prop": "noCloseOnBackdrop",
"description": "Disables the ability to close the modal by clicking the backdrop"
},
{
"prop": "noCloseOnEsc",
"description": "Disables the ability to close the modal by pressing ESC"
},
{
"prop": "noEnforceFocus",
"description": "Disables the enforce focus routine which maintains focus inside the modal"
},
{
"prop": "noStacking",
"description": "Prevents other modals from stacking over this one"
},
{
"prop": "okDisabled",
"description": "Places the default footer OK button in the disabled state"
},
{
"prop": "okOnly",
"description": "Disables rendering of the default footer Cancel button"
},
{
"prop": "okTitle",
"description": "Text string to place in the default footer OK button"
},
{
"prop": "okTitleHtml",
"description": "HTML string to place in the default footer OK button",
"xss": true
},
{
"prop": "okVariant",
"description": "Button color theme variant to apply to the default footer OK button"
},
{
"prop": "returnFocus",
"description": "HTML Element reference, CSS selector, or component reference to return focus to when the modal closes. When not set, will return focus to the element that last had focus before the modal opened"
},
{
"prop": "scrollable",
"description": "Enables scrolling of the modal body"
},
{
"prop": "size",
"description": "Set the size of the modal's width. 'sm', 'md' (default), 'lg', or 'xl'"
},
{
"prop": "titleSrOnly",
"description": "Wraps the title in an '.sr-only' wrapper"
},
{
"prop": "titleTag",
"description": "Specify the HTML tag to render instead of the default tag for the title"
},
{
"prop": "visible",
"description": "The current visibility state of the modal"
}
],
"events": [
{
"event": "bv::modal::hidden",
"description": "Emitted on `$root` when modal is hidden",
"args": [
{
"arg": "bvModalEvent",
"type": "BvModalEvent",
"description": "BvModalEvent object"
},
{
"arg": "modalId",
"type": "String",
"description": "Modal ID"
}
]
},
{
"event": "bv::modal::hide",
"description": "Emitted on `$root` when modal is about to be hidden. Cancelable (as long as modal wasn't forcibly hidden)",
"args": [
{
"arg": "bvModalEvent",
"type": "BvModalEvent",
"description": "BvModalEvent object. Call `bvModalEvent.preventDefault()` to cancel hide"
},
{
"arg": "modalId",
"type": "String",
"description": "Modal ID"
}
]
},
{
"event": "bv::modal::show",
"description": "Emitted on `$root` when modal is about to be shown. Cancelable",
"args": [
{
"arg": "bvModalEvent",
"type": "BvModalEvent",
"description": "BvModalEvent object. Call `bvModalEvent.preventDefault()` to cancel show"
},
{
"arg": "modalId",
"type": "String",
"description": "Modal ID"
}
]
},
{
"event": "bv::modal::shown",
"description": "Emitted on `$root` when modal is shown",
"args": [
{
"arg": "bvModalEvent",
"type": "BvModalEvent",
"description": "BvModalEvent object"
},
{
"arg": "modalId",
"type": "String",
"description": "Modal ID"
}
]
},
{
"event": "cancel",
"description": "When default CANCEL button pressed, just before modal has hidden. Cancelable",
"args": [
{
"arg": "bvModalEvent",
"type": "BvModalEvent",
"description": "BvModalEvent object. Call `bvModalEvent.preventDefault()` to cancel hide"
}
]
},
{
"event": "change",
"description": "New modal visibility state. Used to update the v-model",
"args": [
{
"arg": "isVisible",
"type": "Boolean",
"description": "The visibility state of the modal. `true` if the modal is visible and `false` if not visible"
}
]
},
{
"event": "close",
"description": "When default header close button pressed, just before modal has hidden. Cancelable",
"args": [
{
"arg": "bvModalEvent",
"type": "BvModalEvent",
"description": "BvModalEvent object. Call `bvModalEvent.preventDefault()` to cancel hide"
}
]
},
{
"event": "hidden",
"description": "Always emits after modal is hidden",
"args": [
{
"arg": "bvModalEvent",
"type": "BvModalEvent",
"description": "BvModalEvent object"
}
]
},
{
"event": "hide",
"description": "Always emits just before modal has hidden. Cancelable (as long as modal wasn't forcibly hidden)",
"args": [
{
"arg": "bvModalEvent",
"type": "BvModalEvent",
"description": "BvModalEvent object. Inspect `bvModalEvent.trigger` to find out what action triggered the hide. Call `bvModalEvent.preventDefault()` to cancel hide"
}
]
},
{
"event": "ok",
"description": "When default OK button pressed, just before modal has hidden. Cancelable",
"args": [
{
"arg": "bvModalEvent",
"type": "BvModalEvent",
"description": "BvModalEvent object. Call `bvModalEvent.preventDefault()` to cancel hide"
}
]
},
{
"event": "show",
"description": "Always emits just before modal is shown. Cancelable",
"args": [
{
"arg": "bvModalEvent",
"type": "BvModalEvent",
"description": "BvModalEvent object. Call `bvModalEvent.preventDefault()` to cancel show"
}
]
},
{
"event": "shown",
"description": "Always emits when modal is shown",
"args": [
{
"arg": "bvModalEvent",
"type": "BvModalEvent",
"description": "BvModalEvent object"
}
]
}
],
"rootEventListeners": [
{
"event": "bv::hide::modal",
"description": "Hide modal with specified ID when this event is emitted on `root`",
"args": [
{
"arg": "modalId",
"type": "String",
"description": "ID of modal to hide"
}
]
},
{
"event": "bv::show::modal",
"description": "Show modal with specified ID when this event is emitted on `$root`",
"args": [
{
"arg": "modalId",
"type": "String",
"description": "Modal ID to show"
},
{
"arg": "elIDtoFocusOnClose",
"type": [
"String",
"HTMLElement"
],
"description": "Specify the element reference, or CSS selector, to return focus to once the modal is closed (optional)"
}
]
},
{
"event": "bv::toggle::modal",
"description": "Toggle a modal's visibility given its ID",
"args": [
{
"arg": "modalId",
"type": "String",
"description": "ID of modal to toggle visibility"
},
{
"arg": "elIDtoFocusOnClose",
"type": [
"String",
"HTMLElement"
],
"description": "Specify the element reference, or CSS selector, to return focus to once the modal is closed (optional)"
}
]
}
],
"slots": [
{
"name": "default",
"description": "Content of modal body. Optionally scoped",
"scope": [
{
"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"
}
]
},
{
"name": "modal-backdrop",
"description": "Modal Backdrop content"
},
{
"name": "modal-cancel",
"description": "Modal CANCEL button content"
},
{
"name": "modal-footer",
"description": "Modal footer content. Also removes default OK and Cancel buttons. Optionally scoped",
"scope": [
{
"prop": "cancel",
"type": "Function",
"description": "Closes the modal and fires the 'cancel' and 'hide' events, with `vModalEvent.trigger = 'cancel'`"
},
{
"prop": "close",
"type": "Function",
"description": "Closes the modal and fires the close and hide events, with `vModalEvent.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"
}
]
},
{
"name": "modal-header",
"description": "Entire modal header container contents. Also removes the top right X close button. Optionally scoped",
"scope": [
{
"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"
}
]
},
{
"name": "modal-header-close",
"description": "Content of Modal header close button. If `modal-header` slot is used, this slot will not be shown"
},
{
"name": "modal-ok",
"description": "Modal OK button content"
},
{
"name": "modal-title",
"description": "Modal title. If `modal-header` slot is used, this slot will not be shown. Optionally scoped",
"scope": [
{
"prop": "cancel",
"type": "Function",
"description": "Closes the modal and fires the 'cancel' and 'hide' events, with `vModalEvent.trigger = 'cancel'`"
},
{
"prop": "close",
"type": "Function",
"description": "Closes the modal and fires the close and hide events, with `vModalEvent.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"
}
]
}
]
}
]
}
}