bootstrap-vue
Version:
BootstrapVue, with more than 85 custom components, over 45 plugins, several custom directives, and over 300 icons, provides one of the most comprehensive implementations of Bootstrap v4 components and grid system for Vue.js. With extensive and automated W
131 lines (130 loc) • 4.91 kB
JSON
{
"name": "@bootstrap-vue/overlay",
"version": "1.0.0",
"meta": {
"title": "Overlay",
"version": "2.7.0",
"description": "The b-overlay component is used to visually obscure a particular element or component and its content. It signals to the user of a state change within the element or component and can be used for creating loaders, warnings/alerts and more.",
"components": [
{
"component": "BOverlay",
"version": "2.7.0",
"props": [
{
"prop": "show",
"description": "When set, shows the overlay"
},
{
"prop": "variant",
"description": "Background theme color variant to use for the overlay backdrop"
},
{
"prop": "bgColor",
"description": "CSS color to use as the opaque overlay backdrop color. If set, overrides the `variant` prop"
},
{
"prop": "opacity",
"description": "Opacity of the overlay backdrop. Valid range is `0` to `1`"
},
{
"prop": "blur",
"description": "Value for the CSS blur backdrop-filter. Be sure to include the CSS units. Not supported in IE 11. Set to null or an empty string to disable blurring"
},
{
"prop": "noFade",
"description": "Disables the fade transition of the overlay"
},
{
"prop": "rounded",
"description": "Apply rounding to the overlay to match your content routing. Valid values are `true`, `'sm'`, `lg`, `circle`, `pill`, `top`, `right`, `bottom`, or `left`"
},
{
"prop": "noCenter",
"description": "When set, disables the vertical and horizontal centering of the overlay content"
},
{
"prop": "overlayTag",
"description": "Element tag to use as for the overlay element"
},
{
"prop": "noWrap",
"description": "Disabled generating the wrapper element, and ignored the default slot. Requires that `<b-overlay>` be placed in an element with position relative set"
},
{
"prop": "fixed",
"description": "When prop `no-wrap` is set, will use fixed positioning instead of absolute positioning. Handy if you want to obscure the entire application page"
},
{
"prop": "wrapTag",
"description": "Element tag to use for the overall wrapper element. Has no effect if prop `no-wrap` is set"
},
{
"prop": "zIndex",
"description": "Z-index value to apply to the overlay. You may need to increase this value to suit your content or placement"
},
{
"prop": "spinnerType",
"description": "Type of the default spinner to show. Current supported types are 'border' and 'grow'"
},
{
"prop": "spinnerVariant",
"description": "Applies one of the Bootstrap theme color variants to the default spinner. Default is to use the current font color"
},
{
"prop": "spinnerSmall",
"description": "When set, renders the default spinner in a smaller size"
}
],
"events": [
{
"event": "click",
"version": "2.13.0",
"description": "Emitted when overlay is clicked",
"args": [
{
"arg": "event",
"type": "MouseEvent",
"description": "Native click event object"
}
]
},
{
"event": "shown",
"description": "Emitted when the overlay has been shown"
},
{
"event": "hidden",
"description": "Emitted when the overlay has been hidden"
}
],
"slots": [
{
"name": "overlay",
"description": "Custom content to replace the default overlay spinner",
"scope": [
{
"prop": "spinnerType",
"type": "String",
"description": ""
},
{
"prop": "spinnerVariant",
"type": "String",
"description": ""
},
{
"prop": "spinnerSmall",
"type": "Boolean",
"description": ""
}
]
},
{
"name": "default",
"description": "The content to be overlayed. The default slot is ignored if the prop `no-wrap` is set"
}
]
}
]
}
}