bootstrap-vue
Version:
BootstrapVue, with over 40 plugins and more than 75 custom components, provides one of the most comprehensive implementations of Bootstrap v4 components and grid system for Vue.js. With extensive and automated WAI-ARIA accessibility markup.
230 lines (229 loc) • 7.69 kB
JSON
{
"name": "@bootstrap-vue/modal",
"version": "1.0.0",
"meta": {
"title": "Modal",
"enhanced": true,
"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.",
"directives": [
"VBModal"
],
"components": [
{
"component": "BModal",
"events": [
{
"event": "change",
"description": "New modal visibility state. Used to update the v-model",
"args": [
{
"arg": "isVisible",
"description": "true if modal is visible, false otherwise"
}
]
},
{
"event": "show",
"description": "Always emits just before modal is shown. Cancelable",
"args": [
{
"arg": "bvModalEvt",
"description": "BvModalEvent object. Call bvModalEvt.preventDefault() to cancel show"
}
]
},
{
"event": "shown",
"description": "Always emits when modal is shown",
"args": [
{
"arg": "bvModalEvt",
"description": "BvModalEvent object"
}
]
},
{
"event": "hide",
"description": "Always emits just before modal has hidden. Cancelable (as long as modal wasn't forcibly hidden)",
"args": [
{
"arg": "bvModalEvt",
"description": "BvModalEvent object. Call bvModalEvt.preventDefault() to cancel hide"
}
]
},
{
"event": "hidden",
"description": "Always emits after modal is hidden",
"args": [
{
"arg": "bvModalEvt",
"description": "BvModalEvent object"
}
]
},
{
"event": "ok",
"description": "When default OK button pressed, just before modal has hidden. Cancelable",
"args": [
{
"arg": "bvModalEvt",
"description": "BvModalEvent object. Call bvModalEvt.preventDefault() to cancel hide"
}
]
},
{
"event": "cancel",
"description": "When default CANCEL button pressed, just before modal has hidden. Cancelable",
"args": [
{
"arg": "bvModalEvt",
"description": "BvModalEvent object. Call bvModalEvt.preventDefault() to cancel hide"
}
]
},
{
"event": "close",
"description": "When default header close button pressed, just before modal has hidden. Cancelable",
"args": [
{
"arg": "bvModalEvt",
"description": "BvModalEvent object. Call bvModalEvt.preventDefault() to cancel hide"
}
]
},
{
"event": "bv::modal::show",
"description": "Emitted on $root when modal is about to be shown. Cancelable",
"args": [
{
"arg": "bvModalEvt",
"description": "BvModalEvent object. Call bvEvt.preventDefault() to cancel show"
},
{
"arg": "modalId",
"description": "modal ID"
}
]
},
{
"event": "bv::modal::shown",
"description": "Emitted on $root when modal is shown",
"args": [
{
"arg": "bvModalEvt",
"description": "BvModalEvent object"
},
{
"arg": "modalId",
"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": "bvModalEvt",
"description": "BvModalEvent object. Call bvEvt.preventDefault() to cancel hide"
},
{
"arg": "modalId",
"description": "modal ID"
}
]
},
{
"event": "bv::modal::hidden",
"description": "Emitted on $root when modal is hidden",
"args": [
{
"arg": "bvModalEvt",
"description": "BvModalEvent object"
},
{
"arg": "modalId",
"description": "modal ID"
}
]
}
],
"rootEventListeners": [
{
"event": "bv::show::modal",
"description": "Show modal with specified ID when this event is emitted on $root",
"args": [
{
"arg": "modalId",
"description": "modal ID to show"
},
{
"arg": "elIDtoFocusOnClose",
"description": "(optional), specify the element reference, or CSS selector, to return focus to once the modal is closed"
}
]
},
{
"event": "bv::hide::modal",
"description": "Hide modal with specified ID when this event is emitted on $root",
"args": [
{
"arg": "modalId",
"description": "ID of modal to hide"
}
]
},
{
"event": "bv::toggle::modal",
"description": "Toggle a modal's visibility given it's ID",
"args": [
{
"arg": "modalId",
"description": "ID of modal to toggle visibility"
},
{
"arg": "elIDtoFocusOnClose",
"description": "(optional), specify the element reference, or CSS selector, to return focus to once the modal is closed"
}
]
}
],
"slots": [
{
"name": "modal-header",
"description": "Entire modal header container contents. Also removes the top right X close button. Optionally scoped."
},
{
"name": "modal-title",
"description": "Modal title. If modal-header slot is used, this slot will not be shown. Optionally scoped."
},
{
"name": "modal-footer",
"description": "Modal footer content. Also removes default OK and CANCEL buttons. Optionally scoped."
},
{
"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-cancel",
"description": "Modal CANCEL button content."
},
{
"name": "modal-backdrop",
"description": "Modal Backdrop content."
},
{
"name": "default",
"description": "Content of modal body. Optionally scoped."
}
]
}
]
}
}