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
1,206 lines • 3.54 MB
JSON
{
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
"framework": "vue",
"name": "bootstrap-vue",
"version": "2.13.1",
"contributions": {
"html": {
"types-syntax": "typescript",
"description-markup": "markdown",
"tags": [
{
"name": "BAlert",
"source": {
"module": "bootstrap-vue",
"symbol": "BAlert"
},
"doc-url": "https:/bootstrap-vue.org/docs/components/alert/",
"description": "Provide contextual feedback messages for typical user actions with the handful of available and flexible alert messages.",
"attributes": [
{
"name": "variant",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"info\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/alert/",
"description": "Applies one of the Bootstrap theme color variants to the component"
},
{
"name": "dismissible",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/alert/",
"type": "boolean",
"description": "When set, enables the dismiss close button"
},
{
"name": "dismissLabel",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"Close\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/alert/",
"description": "Value for the 'aria-label' attribute on the dismiss button"
},
{
"name": "show",
"value": {
"kind": "expression",
"type": "boolean|number|string"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/alert/",
"description": "When set, shows the alert. Set to a number (seconds) to show and automatically dismiss the alert after the number of seconds has elapsed"
},
{
"name": "fade",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/alert/",
"type": "boolean",
"description": "When set to 'true', enables the fade animation/transition on the component"
}
],
"vue-model": {
"prop": "show",
"event": "input"
},
"events": [
{
"name": "dismissed",
"doc-url": "https:/bootstrap-vue.org/docs/components/alert/",
"description": "Alert dismissed either via the dismiss close button or when the dismiss countdown has expired"
},
{
"name": "dismiss-count-down",
"doc-url": "https:/bootstrap-vue.org/docs/components/alert/",
"description": "When prop show is a number, this event emits every second on countdown.",
"arguments": [
{
"name": "dismissCountDown",
"doc-url": "https:/bootstrap-vue.org/docs/components/alert/",
"description": "Time remaining to dismissed",
"type": "number"
}
]
},
{
"name": "input",
"doc-url": "https:/bootstrap-vue.org/docs/components/alert/",
"description": "Used to update the v-model show value",
"arguments": [
{
"name": "show",
"doc-url": "https:/bootstrap-vue.org/docs/components/alert/",
"description": "Boolean state of alert, or Number for current countdown value",
"type": "boolean|number"
}
]
}
],
"slots": [
{
"name": "dismiss",
"doc-url": "https:/bootstrap-vue.org/docs/components/alert/",
"description": "Content for the dismiss button."
}
]
},
{
"name": "BAspect",
"source": {
"module": "bootstrap-vue",
"symbol": "BAspect"
},
"doc-url": "https:/bootstrap-vue.org/docs/components/aspect/",
"description": "The `<b-aspect>` component can be used to maintain a minimum responsive aspect ratio for content.",
"attributes": [
{
"name": "aspect",
"value": {
"kind": "expression",
"type": "number|string"
},
"default": "\"1:1\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/aspect/",
"description": "Aspect as a width to height numeric ratio (such as `1.5`) or `width:height` string (such as '16:9')"
},
{
"name": "tag",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"div\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/aspect/",
"description": "Specify the HTML tag to render instead of the default tag"
}
]
},
{
"name": "BAvatar",
"source": {
"module": "bootstrap-vue",
"symbol": "BAvatar"
},
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Avatars are typically used to display a user profile as a picture, an icon, or short text.",
"attributes": [
{
"name": "src",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Image URL to use for the avatar"
},
{
"name": "text",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Text to place in the avatar"
},
{
"name": "icon",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Icon name to use for the avatar. Must be all lowercase. Defaults to `person-fill` if `text` or `src` props not provided"
},
{
"name": "alt",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"avatar\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Value to place in the 'alt' attribute for image and icon avatars"
},
{
"name": "variant",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"secondary\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Applies one of the Bootstrap theme color variants to the component"
},
{
"name": "size",
"value": {
"kind": "expression",
"type": "number|string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Size of the avatar. Refer to the documentation for details"
},
{
"name": "square",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"type": "boolean",
"description": "Disables rounding of the avatar, rending the avatar with square corners"
},
{
"name": "rounded",
"value": {
"kind": "expression",
"type": "boolean|string"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Specifies the type of rounding to apply to the avatar. The `square` prop takes precedence. Refer to the documentation for details"
},
{
"name": "button",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"type": "boolean",
"description": "When set to `true`, renders the avatar as a button"
},
{
"name": "buttonType",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"button\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Type of button to render (i.e. `button`, `submit`, `reset`). Has no effect if prop button is not set"
},
{
"name": "badge",
"value": {
"kind": "expression",
"type": "boolean|string"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "When `true` shows an empty badge on the avatar, alternatively set to a string for content in the badge"
},
{
"name": "badgeVariant",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"primary\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Applies one of the Bootstrap theme color variants to the badge"
},
{
"name": "badgeTop",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"type": "boolean",
"description": "When `true` places the badge at the top instead of the bottom"
},
{
"name": "badgeLeft",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"type": "boolean",
"description": "When `true` places the badge at the left instead of the right"
},
{
"name": "badgeOffset",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"0px\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "CSS length to offset the badge. Positive values move the badge inwards, while negative values move the badge outwards"
},
{
"name": "href",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Denotes the target URL of the link for standard a links"
},
{
"name": "to",
"value": {
"kind": "expression",
"type": "string|object"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "router-link prop: Denotes the target route of the link. When clicked, the value of the to prop will be passed to router.push() internally, so the value can be either a string or a Location descriptor object"
},
{
"name": "append",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"type": "boolean",
"description": "router-link prop: Setting append prop always appends the relative path to the current path"
},
{
"name": "replace",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"type": "boolean",
"description": "router-link prop: Setting the replace prop will call 'router.replace()' instead of 'router.push()' when clicked, so the navigation will not leave a history record"
},
{
"name": "disabled",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"type": "boolean",
"description": "When set to 'true', disables the component's functionality and places it in a disabled state"
},
{
"name": "rel",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Sets the 'rel' attribute on the rendered link"
},
{
"name": "target",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Sets the 'target' attribute on the rendered link"
},
{
"name": "activeClass",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "router-link prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'"
},
{
"name": "exact",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"type": "boolean",
"description": "router-link prop: The default active class matching behavior is inclusive match. Setting this prop forces the mode to exactly match the route"
},
{
"name": "exactActiveClass",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "router-link prop: Configure the active CSS class applied when the link is active with exact match. Typically you will want to set this to class name 'active'"
},
{
"name": "noPrefetch",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"type": "boolean",
"description": "nuxt-link prop: To improve the responsiveness of your Nuxt.js applications, when the link will be displayed within the viewport, Nuxt.js will automatically prefetch the code splitted page. Setting 'no-prefetch' will disabled this feature for the specific link"
},
{
"name": "ariaLabel",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Sets the value of 'aria-label' attribute on the rendered element"
}
],
"events": [
{
"name": "click",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Emitted when the avatar is clicked when rendered as a button or link. Not emitted otherwise",
"arguments": [
{
"name": "evt",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Native Event object"
}
]
},
{
"name": "img-error",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Emitted if an image `src` is provided and the image fails to load",
"arguments": [
{
"name": "evt",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Native Event object"
}
]
}
],
"slots": [
{
"name": "default",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Content to place in the avatar. Overrides props `text`, `src`, and `icon-name`"
},
{
"name": "badge",
"doc-url": "https:/bootstrap-vue.org/docs/components/avatar/",
"description": "Content to place in the avatars optional badge. Overrides the `badge` prop"
}
]
},
{
"name": "BBadge",
"source": {
"module": "bootstrap-vue",
"symbol": "BBadge"
},
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"description": "Small and adaptive tag for adding context to just about any content.",
"attributes": [
{
"name": "href",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"description": "Denotes the target URL of the link for standard a links"
},
{
"name": "rel",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"description": "Sets the 'rel' attribute on the rendered link"
},
{
"name": "target",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"_self\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"description": "Sets the 'target' attribute on the rendered link"
},
{
"name": "active",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"type": "boolean",
"description": "When set to 'true', places the component in the active state with active styling"
},
{
"name": "disabled",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"type": "boolean",
"description": "When set to 'true', disables the component's functionality and places it in a disabled state"
},
{
"name": "to",
"value": {
"kind": "expression",
"type": "string|object"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"description": "router-link prop: Denotes the target route of the link. When clicked, the value of the to prop will be passed to router.push() internally, so the value can be either a string or a Location descriptor object"
},
{
"name": "append",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"type": "boolean",
"description": "router-link prop: Setting append prop always appends the relative path to the current path"
},
{
"name": "replace",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"type": "boolean",
"description": "router-link prop: Setting the replace prop will call 'router.replace()' instead of 'router.push()' when clicked, so the navigation will not leave a history record"
},
{
"name": "event",
"value": {
"kind": "expression",
"type": "string|any[]"
},
"default": "\"click\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"description": "router-link prop: Specify the event that triggers the link. In most cases you should leave this as the default"
},
{
"name": "activeClass",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"description": "router-link prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'"
},
{
"name": "exact",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"type": "boolean",
"description": "router-link prop: The default active class matching behavior is inclusive match. Setting this prop forces the mode to exactly match the route"
},
{
"name": "exactActiveClass",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"description": "router-link prop: Configure the active CSS class applied when the link is active with exact match. Typically you will want to set this to class name 'active'"
},
{
"name": "routerTag",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"a\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"description": "router-link prop: Specify which tag to render, and it will still listen to click events for navigation. 'router-tag' translates to the tag prop on the final rendered router-link. Typically you should use the default value"
},
{
"name": "noPrefetch",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"type": "boolean",
"description": "nuxt-link prop: To improve the responsiveness of your Nuxt.js applications, when the link will be displayed within the viewport, Nuxt.js will automatically prefetch the code splitted page. Setting 'no-prefetch' will disabled this feature for the specific link"
},
{
"name": "tag",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"span\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"description": "Specify the HTML tag to render instead of the default tag"
},
{
"name": "variant",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"secondary\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"description": "Applies one of the Bootstrap theme color variants to the component"
},
{
"name": "pill",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/badge/",
"type": "boolean",
"description": "When set to 'true', renders the badge in pill style"
}
]
},
{
"name": "BBreadcrumb",
"source": {
"module": "bootstrap-vue",
"symbol": "BBreadcrumb"
},
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "Indicate the current page's location within a navigational hierarchy. Separators are automatically added in CSS through ::before and content.",
"attributes": [
{
"name": "items",
"value": {
"kind": "expression",
"type": "any[]"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "Array of breadcrumb items to render"
}
]
},
{
"name": "BBreadcrumbItem",
"source": {
"module": "bootstrap-vue",
"symbol": "BBreadcrumbItem"
},
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "Indicate the current page's location within a navigational hierarchy. Separators are automatically added in CSS through ::before and content.",
"attributes": [
{
"name": "href",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "Denotes the target URL of the link for standard a links"
},
{
"name": "rel",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "Sets the 'rel' attribute on the rendered link"
},
{
"name": "target",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"_self\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "Sets the 'target' attribute on the rendered link"
},
{
"name": "active",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"type": "boolean",
"description": "When set to 'true', places the component in the active state with active styling"
},
{
"name": "disabled",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"type": "boolean",
"description": "When set to 'true', disables the component's functionality and places it in a disabled state"
},
{
"name": "to",
"value": {
"kind": "expression",
"type": "string|object"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "router-link prop: Denotes the target route of the link. When clicked, the value of the to prop will be passed to router.push() internally, so the value can be either a string or a Location descriptor object"
},
{
"name": "append",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"type": "boolean",
"description": "router-link prop: Setting append prop always appends the relative path to the current path"
},
{
"name": "replace",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"type": "boolean",
"description": "router-link prop: Setting the replace prop will call 'router.replace()' instead of 'router.push()' when clicked, so the navigation will not leave a history record"
},
{
"name": "event",
"value": {
"kind": "expression",
"type": "string|any[]"
},
"default": "\"click\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "router-link prop: Specify the event that triggers the link. In most cases you should leave this as the default"
},
{
"name": "activeClass",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "router-link prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'"
},
{
"name": "exact",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"type": "boolean",
"description": "router-link prop: The default active class matching behavior is inclusive match. Setting this prop forces the mode to exactly match the route"
},
{
"name": "exactActiveClass",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "router-link prop: Configure the active CSS class applied when the link is active with exact match. Typically you will want to set this to class name 'active'"
},
{
"name": "routerTag",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"a\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "router-link prop: Specify which tag to render, and it will still listen to click events for navigation. 'router-tag' translates to the tag prop on the final rendered router-link. Typically you should use the default value"
},
{
"name": "noPrefetch",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"type": "boolean",
"description": "nuxt-link prop: To improve the responsiveness of your Nuxt.js applications, when the link will be displayed within the viewport, Nuxt.js will automatically prefetch the code splitted page. Setting 'no-prefetch' will disabled this feature for the specific link"
},
{
"name": "text",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "Text to render in the breadcrumb item"
},
{
"name": "html",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "HTML string to render in the breadcrumb item. Use with caution"
},
{
"name": "ariaCurrent",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"location\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "Sets the value of the 'aria-current' attribute (when the item is the active item). Supported string values are 'location', 'page', or 'true'"
}
],
"events": [
{
"name": "click",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "Emitted when clicked",
"arguments": [
{
"name": "event",
"doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/",
"description": "Native click event object",
"type": "MouseEvent"
}
]
}
]
},
{
"name": "BButton",
"source": {
"module": "bootstrap-vue",
"symbol": "BButton"
},
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "Use BootstrapVue's <b-button> component for actions in forms, dialogs, and more. Includes support for a handful of contextual variations, sizes, states, and more.",
"attributes": [
{
"name": "href",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "Denotes the target URL of the link for standard a links"
},
{
"name": "rel",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "Sets the 'rel' attribute on the rendered link"
},
{
"name": "target",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"_self\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "Sets the 'target' attribute on the rendered link"
},
{
"name": "active",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"type": "boolean",
"description": "When set to 'true', places the component in the active state with active styling"
},
{
"name": "disabled",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"type": "boolean",
"description": "When set to 'true', disables the component's functionality and places it in a disabled state"
},
{
"name": "to",
"value": {
"kind": "expression",
"type": "string|object"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "router-link prop: Denotes the target route of the link. When clicked, the value of the to prop will be passed to router.push() internally, so the value can be either a string or a Location descriptor object"
},
{
"name": "append",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"type": "boolean",
"description": "router-link prop: Setting append prop always appends the relative path to the current path"
},
{
"name": "replace",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"type": "boolean",
"description": "router-link prop: Setting the replace prop will call 'router.replace()' instead of 'router.push()' when clicked, so the navigation will not leave a history record"
},
{
"name": "event",
"value": {
"kind": "expression",
"type": "string|any[]"
},
"default": "\"click\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "router-link prop: Specify the event that triggers the link. In most cases you should leave this as the default"
},
{
"name": "activeClass",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "router-link prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'"
},
{
"name": "exact",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"type": "boolean",
"description": "router-link prop: The default active class matching behavior is inclusive match. Setting this prop forces the mode to exactly match the route"
},
{
"name": "exactActiveClass",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "router-link prop: Configure the active CSS class applied when the link is active with exact match. Typically you will want to set this to class name 'active'"
},
{
"name": "routerTag",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"a\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "router-link prop: Specify which tag to render, and it will still listen to click events for navigation. 'router-tag' translates to the tag prop on the final rendered router-link. Typically you should use the default value"
},
{
"name": "noPrefetch",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"type": "boolean",
"description": "nuxt-link prop: To improve the responsiveness of your Nuxt.js applications, when the link will be displayed within the viewport, Nuxt.js will automatically prefetch the code splitted page. Setting 'no-prefetch' will disabled this feature for the specific link"
},
{
"name": "block",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"type": "boolean",
"description": "Renders a 100% width button (expands to the width of its parent container)"
},
{
"name": "size",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'"
},
{
"name": "variant",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"secondary\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "Applies one of the Bootstrap theme color variants to the component"
},
{
"name": "type",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"button\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "The value to set the button's 'type' attribute to. Can be one of 'button', 'submit', or 'reset'"
},
{
"name": "tag",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"button\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "Specify the HTML tag to render instead of the default tag"
},
{
"name": "pill",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"type": "boolean",
"description": "Renders the button with the pill style appearance when set to 'true'"
},
{
"name": "squared",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"type": "boolean",
"description": "Renders the button with non-rounded corners when set to 'true'"
},
{
"name": "pressed",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"type": "boolean",
"description": "When set to 'true', gives the button the appearance of being pressed and adds attribute 'aria-pressed=\"true\"'. When set to `false` adds attribute 'aria-pressed=\"false\"'. Tri-state prop. Syncable with the .sync modifier"
}
],
"events": [
{
"name": "click",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "Emitted when non-disabled button clicked",
"arguments": [
{
"name": "mouseEvent",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "Native click event object",
"type": "MouseEvent"
}
]
}
]
},
{
"name": "BBtn",
"source": {
"module": "bootstrap-vue",
"symbol": "BBtn"
},
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "Use BootstrapVue's <b-button> component for actions in forms, dialogs, and more. Includes support for a handful of contextual variations, sizes, states, and more.\n\n*Alias for BButton*",
"attributes": [
{
"name": "href",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "Denotes the target URL of the link for standard a links"
},
{
"name": "rel",
"value": {
"kind": "expression",
"type": "string"
},
"default": "null",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "Sets the 'rel' attribute on the rendered link"
},
{
"name": "target",
"value": {
"kind": "expression",
"type": "string"
},
"default": "\"_self\"",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"description": "Sets the 'target' attribute on the rendered link"
},
{
"name": "active",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"type": "boolean",
"description": "When set to 'true', places the component in the active state with active styling"
},
{
"name": "disabled",
"value": {
"kind": "expression",
"type": "boolean"
},
"default": "false",
"doc-url": "https:/bootstrap-vue.org/docs/components/button/",
"type": "boolean",
"description": "When set to 'true', disables the component's functionality and places it in a disabled state"
},
{
"name": "to