bootstrap-vue
Version:
With more than 85 components, over 45 available plugins, several directives, and 1000+ icons, BootstrapVue provides one of the most comprehensive implementations of the Bootstrap v4 component and grid system available for Vue.js v2.6, complete with extens
131 lines (130 loc) • 4.78 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": "bgColor",
"description": "CSS color to use as the opaque overlay backdrop color. If set, overrides the `variant` prop"
},
{
"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": "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": "noCenter",
"description": "When set, disables the vertical and horizontal centering of the overlay content"
},
{
"prop": "noFade",
"description": "Disables the fade transition of the overlay"
},
{
"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": "opacity",
"description": "Opacity of the overlay backdrop. Valid range is `0` to `1`"
},
{
"prop": "overlayTag",
"description": "Element tag to use as for the overlay element"
},
{
"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": "show",
"description": "When set, shows the overlay"
},
{
"prop": "spinnerSmall",
"description": "When set, renders the default spinner in a smaller size"
},
{
"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": "variant",
"description": "Background theme color variant to use for the overlay backdrop"
},
{
"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"
}
],
"events": [
{
"event": "click",
"version": "2.13.0",
"description": "Emitted when overlay is clicked",
"args": [
{
"arg": "event",
"type": "MouseEvent",
"description": "Native click event object"
}
]
},
{
"event": "hidden",
"description": "Emitted when the overlay has been hidden"
},
{
"event": "shown",
"description": "Emitted when the overlay has been shown"
}
],
"slots": [
{
"name": "default",
"description": "The content to be overlayed. The default slot is ignored if the prop `no-wrap` is set"
},
{
"name": "overlay",
"description": "Custom content to replace the default overlay spinner",
"scope": [
{
"prop": "spinnerSmall",
"type": "Boolean",
"description": ""
},
{
"prop": "spinnerType",
"type": "String",
"description": ""
},
{
"prop": "spinnerVariant",
"type": "String",
"description": ""
}
]
}
]
}
]
}
}