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
189 lines (188 loc) • 6.06 kB
JSON
{
"name": "@bootstrap-vue/toast",
"version": "1.0.0",
"meta": {
"title": "Toast",
"slug": "toast",
"description": "Push notifications to your visitors with a toast, a lightweight and easily customizable alert message.",
"plugins": [
"BVToastPlugin"
],
"components": [
{
"component": "BToast",
"props": [
{
"prop": "appendToast",
"description": "When true, the toast will be appended to the bottom on the visible toasts, otherwise it will be prepended"
},
{
"prop": "autoHideDelay",
"description": "The number of milliseconds before the toast auto dismisses itself"
},
{
"prop": "bodyClass",
"description": "CSS class (or classes) to add to the toast body element"
},
{
"prop": "headerClass",
"description": "CSS class (or classes) to add to the toast header element"
},
{
"prop": "headerTag",
"version": "2.22.0",
"description": "Specify the HTML tag to render instead of the default tag for the footer"
},
{
"prop": "isStatus",
"description": "When set to 'true', makes the toast have attributes aria-live=polite and role=status. When 'false' aria-live will be 'assertive' and role will be 'alert'"
},
{
"prop": "noAutoHide",
"description": "When set, disabled the toast from automatically dismissing itself"
},
{
"prop": "noCloseButton",
"description": "When set, hides the close button in the toast header"
},
{
"prop": "noHoverPause",
"description": "When set, disables the pausing of the auto hide delay when the mouse hovers the toast"
},
{
"prop": "solid",
"description": "When set, renderes the toast with a solid background rather than translucent"
},
{
"prop": "title",
"description": "The toast's title text"
},
{
"prop": "toastClass",
"description": "CSS class (or classes) to add to the toast wrapper element"
},
{
"prop": "toaster",
"description": "The name of the toaster target to render the toast in"
},
{
"prop": "variant",
"description": "Applies one of the Bootstrap theme color variants to the component"
},
{
"prop": "visible",
"description": "When true, shows the toast"
}
],
"events": [
{
"event": "change",
"description": "Toast visibility state. Used to update the v-model",
"args": [
{
"arg": "visible",
"type": "Boolean",
"description": "`true` if toast is visible, `false` otherwise"
}
]
},
{
"event": "hidden",
"description": "Always emits after toast is hidden",
"args": [
{
"arg": "bvEvent",
"type": "BvEvent",
"description": "BvEvent object"
}
]
},
{
"event": "hide",
"description": "Always emits just before toast has hidden",
"args": [
{
"arg": "bvEvent",
"type": "BvEvent",
"description": "BvEvent object"
}
]
},
{
"event": "show",
"description": "Always emits just before toast is shown",
"args": [
{
"arg": "bvEvent",
"type": "BvEvent",
"description": "BvEvent object"
}
]
},
{
"event": "shown",
"description": "Always emits when toast is shown",
"args": [
{
"arg": "bvEvent",
"type": "BvEvent",
"description": "BvEvent object"
}
]
}
],
"slots": [
{
"name": "default",
"description": "Toast body content. Optionally scoped",
"scope": [
{
"prop": "hide",
"type": "Function",
"description": "Hides the toast when called. Useful if you are providing your own close button"
}
]
},
{
"name": "toast-title",
"description": "Toast title. Optionally scoped",
"scope": [
{
"prop": "hide",
"type": "Function",
"description": "Hides the toast when called. Useful if you are providing your own close button"
}
]
}
]
},
{
"component": "BToaster",
"props": [
{
"prop": "ariaAtomic",
"description": "When screen reader's should read out the entire contents (set to string 'true') or just the changes (set to string 'false'). Leave blank for most cases"
},
{
"prop": "ariaLive",
"description": "When the rendered element is an aria-live region (for screen reader users), set to either 'polite' or 'assertive'"
},
{
"prop": "name",
"description": "The toaster's target name"
},
{
"prop": "role",
"description": "Sets the ARIA attribute 'role' to a specific value"
}
],
"slots": [
{
"name": "default",
"description": "Content (toasts) to place in the toaster element"
}
]
}
]
}
}