bootstrap-vue/src/components/toast/package.json

BootstrapVue, with over 40 plugins and more than 80 custom components, 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 WAI-AR

{
  "name": "@bootstrap-vue/toast",
  "version": "1.0.0",
  "meta": {
    "title": "Toasts",
    "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": "title",
            "description": "The toast's title text"
          },
          {
            "prop": "toaster",
            "description": "The name of the toaster target to render the toast in"
          },
          {
            "prop": "visible",
            "description": "When true, shows the toast"
          },
          {
            "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": "appendToast",
            "description": "When true, the toast will be appended to the bottom on the visible toasts, otherwise it will be prepended"
          },
          {
            "prop": "noAutoHide",
            "description": "When set, disabled the toast from automatically dismissing itself"
          },
          {
            "prop": "autoHideDelay",
            "description": "The number of milliseconds before the toast auto dismisses itself"
          },
          {
            "prop": "noCloseButton",
            "description": "When set, hides the close button in the toast header"
          },
          {
            "prop": "noHoverPause",
            "description": "When set, disables the pausing of hte 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": "toastClass",
            "description": "CSS class (or classes) to add to the toast wrapper element"
          },
          {
            "prop": "headerClass",
            "description": "CSS class (or classes) to add to the toast header element"
          },
          {
            "prop": "bodyClass",
            "description": "CSS class (or classes) to add to the toast body element"
          }
        ],
        "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": "show",
            "description": "always emits just before toast is shown.",
            "args": [
              {
                "arg": "bvEvt",
                "type": "BvEvent",
                "description": "BvEvent object."
              }
            ]
          },
          {
            "event": "shown",
            "description": "always emits when toast is shown.",
            "args": [
              {
                "arg": "bvEvt",
                "type": "BvEvent",
                "description": "BvEvent object."
              }
            ]
          },
          {
            "event": "hide",
            "description": "always emits just before toast has hidden.",
            "args": [
              {
                "arg": "bvEvt",
                "type": "BvEvent",
                "description": "BvEvent object."
              }
            ]
          },
          {
            "event": "hidden",
            "description": "always emits after toast is hidden",
            "args": [
              {
                "arg": "bvEvt",
                "type": "BvEvent",
                "description": "BvEvent object."
              }
            ]
          }
        ],
        "slots": [
          {
            "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."
              }
            ]
          },
          {
            "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."
              }
            ]
          }
        ]
      },
      {
        "component": "BToaster",
        "props": [
          {
            "prop": "name",
            "description": "The toaster's target name"
          },
          {
            "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"
          }
        ]
      }
    ]
  }
}