{ "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json", "framework": "vue", "name": "bootstrap-vue", "version": "2.21.2", "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": "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": "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": "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": "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" }, { "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" } ], "vue-model": { "prop": "show", "event": "input" }, "events": [ { "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": "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": "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": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/alert/", "description": "Content to place in the alert" } ] }, { "name": "BAspect", "source": { "module": "bootstrap-vue", "symbol": "BAspect" }, "doc-url": "https:/bootstrap-vue.org/docs/components/aspect/", "description": "The `` 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" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/aspect/", "description": "Content to place in the aspect" } ] }, { "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": "activeClass", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "description": " prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'" }, { "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": "append", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "type": "boolean", "description": " prop: Setting append prop always appends the relative path to the current path" }, { "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" }, { "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": "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": "null", "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": "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": "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": "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": "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": "exact", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "type": "boolean", "description": " 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": " 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": "href", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "description": " prop: Denotes the target URL of the link for standard a links" }, { "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": "noPrefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "type": "boolean", "description": " 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": "prefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "type": "boolean", "description": " 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 `prefetch` to `true` or `false` will overwrite the default value of `router.prefetchLinks`" }, { "name": "rel", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "description": " prop: Sets the `rel` attribute on the rendered link" }, { "name": "replace", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "type": "boolean", "description": " 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": "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": "routerComponentName", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "description": " prop: BootstrapVue auto detects between `` and ``. In cases where you want to use a 3rd party link component based on ``, set this prop to the component name. e.g. set it to 'g-link' if you are using Gridsome (note only `` specific props are passed 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": "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": "target", "value": { "kind": "expression", "type": "string" }, "default": "\"_self\"", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "description": " prop: Sets the `target` attribute on the rendered link" }, { "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": "to", "value": { "kind": "expression", "type": "object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "description": " 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": "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" } ], "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": "event", "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": "event", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "description": "Native Event object" } ] } ], "slots": [ { "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": "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": "BAvatarGroup", "source": { "module": "bootstrap-vue", "symbol": "BAvatarGroup" }, "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": "overlap", "value": { "kind": "expression", "type": "number|string" }, "default": "0.3", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "description": "Floating point number specifying the amount of overlap where `0` is no overlap and `1` is 100% overlap" }, { "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 child avatars. The `square` prop takes precedence. Refer to the documentation for details" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "description": "Size of all the child avatars. 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 child avatars, rendering each avatar with square corners" }, { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "variant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "description": "Applies one of the Bootstrap theme color variants to all child avatars" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/avatar/", "description": "Content (avatars) to place in the avatar group" } ] }, { "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": "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": "activeClass", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/badge/", "description": " prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'" }, { "name": "append", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/badge/", "type": "boolean", "description": " prop: Setting append prop always appends the relative path to the current path" }, { "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": "exact", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/badge/", "type": "boolean", "description": " 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": " 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": "href", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/badge/", "description": " prop: Denotes the target URL of the link for standard a links" }, { "name": "noPrefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/badge/", "type": "boolean", "description": " 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": "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": "prefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/badge/", "type": "boolean", "description": " 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 `prefetch` to `true` or `false` will overwrite the default value of `router.prefetchLinks`" }, { "name": "rel", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/badge/", "description": " prop: Sets the `rel` attribute on the rendered link" }, { "name": "replace", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/badge/", "type": "boolean", "description": " 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": "routerComponentName", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/badge/", "description": " prop: BootstrapVue auto detects between `` and ``. In cases where you want to use a 3rd party link component based on ``, set this prop to the component name. e.g. set it to 'g-link' if you are using Gridsome (note only `` specific props are passed to the component)" }, { "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": "target", "value": { "kind": "expression", "type": "string" }, "default": "\"_self\"", "doc-url": "https:/bootstrap-vue.org/docs/components/badge/", "description": " prop: Sets the `target` attribute on the rendered link" }, { "name": "to", "value": { "kind": "expression", "type": "object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/badge/", "description": " 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": "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" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/badge/", "description": "Content to place in the badge" } ] }, { "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" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/", "description": "Content (breadcrumb items) to place in the breadcrumb" } ] }, { "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": "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": "activeClass", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/", "description": " prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'" }, { "name": "append", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/", "type": "boolean", "description": " prop: Setting append prop always appends the relative path to the current path" }, { "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'" }, { "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": "exact", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/", "type": "boolean", "description": " 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": " 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": "href", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/", "description": " prop: Denotes the target URL of the link for standard a links" }, { "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" }, { "name": "noPrefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/", "type": "boolean", "description": " 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": "prefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/", "type": "boolean", "description": " 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 `prefetch` to `true` or `false` will overwrite the default value of `router.prefetchLinks`" }, { "name": "rel", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/", "description": " prop: Sets the `rel` attribute on the rendered link" }, { "name": "replace", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/", "type": "boolean", "description": " 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": "routerComponentName", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/", "description": " prop: BootstrapVue auto detects between `` and ``. In cases where you want to use a 3rd party link component based on ``, set this prop to the component name. e.g. set it to 'g-link' if you are using Gridsome (note only `` specific props are passed to the component)" }, { "name": "target", "value": { "kind": "expression", "type": "string" }, "default": "\"_self\"", "doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/", "description": " prop: Sets the `target` attribute on the rendered 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": "to", "value": { "kind": "expression", "type": "object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/", "description": " 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" } ], "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" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/breadcrumb/", "description": "Content to place in the breadcrumb item" } ] }, { "name": "BButton", "source": { "module": "bootstrap-vue", "symbol": "BButton" }, "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "Use BootstrapVue's component for actions in forms, dialogs, and more. Includes support for a handful of contextual variations, sizes, states, and more.", "attributes": [ { "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": "activeClass", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": " prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'" }, { "name": "append", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "type": "boolean", "description": " prop: Setting append prop always appends the relative path to the current path" }, { "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": "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": "exact", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "type": "boolean", "description": " 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": " 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": "href", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": " prop: Denotes the target URL of the link for standard a links" }, { "name": "noPrefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "type": "boolean", "description": " 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": "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": "prefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "type": "boolean", "description": " 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 `prefetch` to `true` or `false` will overwrite the default value of `router.prefetchLinks`" }, { "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" }, { "name": "rel", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": " prop: Sets the `rel` attribute on the rendered link" }, { "name": "replace", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "type": "boolean", "description": " 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": "routerComponentName", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": " prop: BootstrapVue auto detects between `` and ``. In cases where you want to use a 3rd party link component based on ``, set this prop to the component name. e.g. set it to 'g-link' if you are using Gridsome (note only `` specific props are passed to the component)" }, { "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": "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": "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": "target", "value": { "kind": "expression", "type": "string" }, "default": "\"_self\"", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": " prop: Sets the `target` attribute on the rendered link" }, { "name": "to", "value": { "kind": "expression", "type": "object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": " 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": "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": "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" } ], "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" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "Content to place in the button" } ] }, { "name": "BBtn", "source": { "module": "bootstrap-vue", "symbol": "BBtn" }, "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "Use BootstrapVue's 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": "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": "activeClass", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": " prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'" }, { "name": "append", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "type": "boolean", "description": " prop: Setting append prop always appends the relative path to the current path" }, { "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": "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": "exact", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "type": "boolean", "description": " 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": " 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": "href", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": " prop: Denotes the target URL of the link for standard a links" }, { "name": "noPrefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "type": "boolean", "description": " 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": "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": "prefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "type": "boolean", "description": " 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 `prefetch` to `true` or `false` will overwrite the default value of `router.prefetchLinks`" }, { "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" }, { "name": "rel", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": " prop: Sets the `rel` attribute on the rendered link" }, { "name": "replace", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "type": "boolean", "description": " 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": "routerComponentName", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": " prop: BootstrapVue auto detects between `` and ``. In cases where you want to use a 3rd party link component based on ``, set this prop to the component name. e.g. set it to 'g-link' if you are using Gridsome (note only `` specific props are passed to the component)" }, { "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": "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": "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": "target", "value": { "kind": "expression", "type": "string" }, "default": "\"_self\"", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": " prop: Sets the `target` attribute on the rendered link" }, { "name": "to", "value": { "kind": "expression", "type": "object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": " 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": "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": "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" } ], "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" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "Content to place in the button" } ] }, { "name": "BButtonClose", "source": { "module": "bootstrap-vue", "symbol": "BButtonClose" }, "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "Use BootstrapVue's component for actions in forms, dialogs, and more. Includes support for a handful of contextual variations, sizes, states, and more.", "attributes": [ { "name": "ariaLabel", "value": { "kind": "expression", "type": "string" }, "default": "\"Close\"", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "Sets the value of 'aria-label' attribute on the rendered element" }, { "name": "content", "value": { "kind": "expression", "type": "string" }, "default": "\"×\"", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "The content of the close button" }, { "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": "textVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "Applies one of the Bootstrap theme color variants to the text" } ], "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" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "Content to place in the button. Overrides the `content` prop" } ] }, { "name": "BBtnClose", "source": { "module": "bootstrap-vue", "symbol": "BBtnClose" }, "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "Use BootstrapVue's component for actions in forms, dialogs, and more. Includes support for a handful of contextual variations, sizes, states, and more.\n\n*Alias for BButtonClose*", "attributes": [ { "name": "ariaLabel", "value": { "kind": "expression", "type": "string" }, "default": "\"Close\"", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "Sets the value of 'aria-label' attribute on the rendered element" }, { "name": "content", "value": { "kind": "expression", "type": "string" }, "default": "\"×\"", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "The content of the close button" }, { "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": "textVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "Applies one of the Bootstrap theme color variants to the text" } ], "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" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/button/", "description": "Content to place in the button. Overrides the `content` prop" } ] }, { "name": "BButtonGroup", "source": { "module": "bootstrap-vue", "symbol": "BButtonGroup" }, "doc-url": "https:/bootstrap-vue.org/docs/components/button-group/", "description": "Group a series of buttons together on a single line with .", "attributes": [ { "name": "ariaRole", "value": { "kind": "expression", "type": "string" }, "default": "\"group\"", "doc-url": "https:/bootstrap-vue.org/docs/components/button-group/", "description": "Sets the ARIA attribute `role` to a specific value" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button-group/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/button-group/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "vertical", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button-group/", "type": "boolean", "description": "When set, rendered the button group in vertical mode" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/button-group/", "description": "Content (buttons) to place in the button group" } ] }, { "name": "BBtnGroup", "source": { "module": "bootstrap-vue", "symbol": "BBtnGroup" }, "doc-url": "https:/bootstrap-vue.org/docs/components/button-group/", "description": "Group a series of buttons together on a single line with .\n\n*Alias for BButtonGroup*", "attributes": [ { "name": "ariaRole", "value": { "kind": "expression", "type": "string" }, "default": "\"group\"", "doc-url": "https:/bootstrap-vue.org/docs/components/button-group/", "description": "Sets the ARIA attribute `role` to a specific value" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/button-group/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/button-group/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "vertical", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button-group/", "type": "boolean", "description": "When set, rendered the button group in vertical mode" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/button-group/", "description": "Content (buttons) to place in the button group" } ] }, { "name": "BButtonToolbar", "source": { "module": "bootstrap-vue", "symbol": "BButtonToolbar" }, "doc-url": "https:/bootstrap-vue.org/docs/components/button-toolbar/", "description": "Group a series of and/or together on a single line, with optional keyboard navigation.", "attributes": [ { "name": "justify", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button-toolbar/", "type": "boolean", "description": "Make the toolbar span the maximum available width, by increasing spacing between the button groups, input groups and dropdowns" }, { "name": "keyNav", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button-toolbar/", "type": "boolean", "description": "When set, enabled keyboard navigation mode for the toolbar. Do not set this prop when the toolbar has inputs" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/button-toolbar/", "description": "Content to place in the button toolbar" } ] }, { "name": "BBtnToolbar", "source": { "module": "bootstrap-vue", "symbol": "BBtnToolbar" }, "doc-url": "https:/bootstrap-vue.org/docs/components/button-toolbar/", "description": "Group a series of and/or together on a single line, with optional keyboard navigation.\n\n*Alias for BButtonToolbar*", "attributes": [ { "name": "justify", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button-toolbar/", "type": "boolean", "description": "Make the toolbar span the maximum available width, by increasing spacing between the button groups, input groups and dropdowns" }, { "name": "keyNav", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/button-toolbar/", "type": "boolean", "description": "When set, enabled keyboard navigation mode for the toolbar. Do not set this prop when the toolbar has inputs" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/button-toolbar/", "description": "Content to place in the button toolbar" } ] }, { "name": "BCalendar", "source": { "module": "bootstrap-vue", "symbol": "BCalendar" }, "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "BootstrapVue custom calendar widget for selecting dates and controlling other components, fully WAI-ARIA accessible (a11y) and supports internationalization (i18n).", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "value", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Initially selected date value. Accepts either a `YYYY-MM-DD` string or a `Date` object" }, { "name": "ariaControls", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "If this component controls another component or element, set this to the ID of the controlled component or element" }, { "name": "block", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "type": "boolean", "description": "Makes the calendar full width" }, { "name": "dateDisabledFn", "value": { "kind": "expression", "type": "function" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Set to a function reference which returns `true` if the date is disabled, or `false` if the date should be enabled. See documentation for details" }, { "name": "dateFormatOptions", "value": { "kind": "expression", "type": "object" }, "default": "{\"year\":\"numeric\",\"month\":\"long\",\"day\":\"numeric\",\"weekday\":\"long\"}", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Format object for displayed text string that is passed to `Intl.DateTimeFormat`" }, { "name": "dateInfoFn", "value": { "kind": "expression", "type": "function" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Set to a function reference which returns a class (string), or classes (array of strings) to apply to the date cell. See documentation for details" }, { "name": "direction", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Set to the string 'rtl' or 'ltr' to explicitly force the calendar to render in right-to-left or left-ro-right (respectively) mode. Defaults to the resolved locale's directionality" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "type": "boolean", "description": "Places the calendar in a non-interactive disabled state" }, { "name": "hidden", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "type": "boolean", "description": "When `true`, renders a comment node instead of the calendar widget while keeping the Vue instance active. Mainly used when implementing a custom date picker" }, { "name": "hideHeader", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "type": "boolean", "description": "When `true`, visually hides the selected date header" }, { "name": "initialDate", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "When a `value` is not specified, sets the initial calendar month date that will be presented to the user. Accepts a value in `YYYY-MM-DD` format or a `Date` object. Defaults to the current date (or min or max if the current date is out of range)" }, { "name": "labelCalendar", "value": { "kind": "expression", "type": "string" }, "default": "\"Calendar\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Value of the `aria-label` and `role-description` attributes applied to the calendar grid" }, { "name": "labelCurrentMonth", "value": { "kind": "expression", "type": "string" }, "default": "\"Current month\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Value of the `aria-label` and `title` attributes on the `Current Month` navigation button" }, { "name": "labelHelp", "value": { "kind": "expression", "type": "string" }, "default": "\"Use cursor keys to navigate calendar dates\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Help text that appears at the bottom of the calendar grid" }, { "name": "labelNav", "value": { "kind": "expression", "type": "string" }, "default": "\"Calendar navigation\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Value of the `aria-label` attribute on to the calendar navigation button wrapper" }, { "name": "labelNextDecade", "value": { "kind": "expression", "type": "string" }, "default": "\"Next decade\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Value of the `aria-label` and `title` attributes on the optional `Next Decade` navigation button" }, { "name": "labelNextMonth", "value": { "kind": "expression", "type": "string" }, "default": "\"Next month\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Value of the `aria-label` and `title` attributes on the `Next Month` navigation button" }, { "name": "labelNextYear", "value": { "kind": "expression", "type": "string" }, "default": "\"Next year\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Value of the `aria-label` and `title` attributes on the `Next Year` navigation button" }, { "name": "labelNoDateSelected", "value": { "kind": "expression", "type": "string" }, "default": "\"No date selected\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Label to use when no date is currently selected" }, { "name": "labelPrevDecade", "value": { "kind": "expression", "type": "string" }, "default": "\"Previous decade\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Value of the `aria-label` and `title` attributes on the optional `Previous Decade` navigation button" }, { "name": "labelPrevMonth", "value": { "kind": "expression", "type": "string" }, "default": "\"Previous month\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Value of the `aria-label` and `title` attributes on the `Previous Month` navigation button" }, { "name": "labelPrevYear", "value": { "kind": "expression", "type": "string" }, "default": "\"Previous year\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Value of the `aria-label` and `title` attributes on the `Previous Year` navigation button" }, { "name": "labelSelected", "value": { "kind": "expression", "type": "string" }, "default": "\"Selected date\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Value of the `aria-label` attribute set on the calendar grid date button that is selected" }, { "name": "labelToday", "value": { "kind": "expression", "type": "string" }, "default": "\"Today\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Value of the `aria-label` attribute for the calendar grid date button to signify that the date is today's date" }, { "name": "locale", "value": { "kind": "expression", "type": "any[]|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Locale (or locales) for the calendar to use. When passing an array of locales, the order of the locales is from most preferred to least preferred" }, { "name": "max", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "The maximum date the calendar will show" }, { "name": "min", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "The minimum date the calendar will show" }, { "name": "navButtonVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"secondary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Theme color variant to use for the navigation buttons" }, { "name": "noHighlightToday", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "type": "boolean", "description": "Disabled the highlighting of todays date in the calendar" }, { "name": "noKeyNav", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "type": "boolean", "description": "Disable keyboard navigation of the calendar components" }, { "name": "readonly", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "type": "boolean", "description": "Places the calendar in an interactive readonly state. Disables updating the v-model, while still allowing date navigation" }, { "name": "roleDescription", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Sets a value for the `role-description` attribute on the component" }, { "name": "selectedVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"primary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Theme color variant to use for the selected date button" }, { "name": "showDecadeNav", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "type": "boolean", "description": "When `true`, shows the +/- decade navigation buttons" }, { "name": "startWeekday", "value": { "kind": "expression", "type": "number|string" }, "default": "0", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Day of week to start the calendar. `0` for Sunday, `1` for Monday, `6` for Saturday, etc" }, { "name": "todayVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Theme color variant to use for highlighting todays date button. Defaults to the `selectedVariant` prop" }, { "name": "valueAsDate", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "type": "boolean", "description": "Returns a `Date` object for the v-model instead of a `YYYY-MM-DD` string" }, { "name": "weekdayHeaderFormat", "value": { "kind": "expression", "type": "string" }, "default": "\"short\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Format to use for the calendar weekday headings. Possible values are `long`, `short` (default), or `narrow`" }, { "name": "width", "value": { "kind": "expression", "type": "string" }, "default": "\"270px\"", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "The width of the calendar. Has no effect if prop `block` is set" } ], "vue-model": { "prop": "value", "event": "input" }, "events": [ { "name": "context", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Emitted when when the user changes the active date via date navigation buttons or cursor control", "arguments": [ { "name": "context", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "The context object. See documentaion for details", "type": "object" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Emitted when updating the v-model", "arguments": [ { "name": "date", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Either a string in the format of `YYYY-MM-DD` or a `Date` object (if `value-as-date` prop is `true`)", "type": "string|Date" } ] }, { "name": "selected", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Emitted when user has selected (clicked) a date. Note this event will also be emitted if the user clicks on the currently selected date", "arguments": [ { "name": "ymd", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "The selected date as a string in the format of `YYYY-MM-DD`", "type": "string" }, { "name": "date", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "The selected date as a `Date` object", "type": "Date" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Used to place custom controls at the bottom of the calendar component" }, { "name": "nav-next-decade", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Used to place custom content in the next decade navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-next-month", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Used to place custom content in the next month navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-next-year", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Used to place custom content in the next year navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-prev-decade", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Used to place custom content in the previous decade navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Will be `true` if the nav bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-prev-month", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Used to place custom content in the previous month navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-prev-year", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Used to place custom content in the previous year navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-this-month", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Used to place custom content in the this month/day navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/calendar/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] } ] }, { "name": "BCard", "source": { "module": "bootstrap-vue", "symbol": "BCard" }, "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "A card is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options.", "attributes": [ { "name": "align", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Text alignment for the card's content: 'left', 'center' or 'right'" }, { "name": "bgVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the background" }, { "name": "bodyBgVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the body background" }, { "name": "bodyBorderVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the body border" }, { "name": "bodyClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "CSS class (or classes) to apply to the body" }, { "name": "bodyTag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag for the body" }, { "name": "bodyTextVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the body text" }, { "name": "borderVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the border" }, { "name": "footer", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Text content to place in the footer" }, { "name": "footerBgVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the footer background" }, { "name": "footerBorderVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the footer border" }, { "name": "footerClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "CSS class (or classes) to apply to the footer" }, { "name": "footerHtml", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "HTML string content to place in the footer" }, { "name": "footerTag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag for the footer" }, { "name": "footerTextVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the footer text" }, { "name": "header", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Text content to place in the header" }, { "name": "headerBgVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the header background" }, { "name": "headerBorderVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the header border" }, { "name": "headerClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "CSS class (or classes) to apply to the header" }, { "name": "headerHtml", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "HTML string content to place in the header" }, { "name": "headerTag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag for the header" }, { "name": "headerTextVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the header text" }, { "name": "imgAlt", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Value to set the image attribute 'alt'" }, { "name": "imgBottom", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image should appear at the bottom of the card" }, { "name": "imgEnd", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image should appear at the end (right) of the card" }, { "name": "imgHeight", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "The value to set on the image's 'height' attribute" }, { "name": "imgLeft", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image should appear at the start (left) of the card. Synonym for the 'left' prop" }, { "name": "imgRight", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image should appear at the end (right) of the card. Synonym for the 'right' prop" }, { "name": "imgSrc", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "URL for the optional image" }, { "name": "imgStart", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image should appear at the start (left) of the card" }, { "name": "imgTop", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image should appear at the top of the card" }, { "name": "imgWidth", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "The value to set on the image's 'width' attribute" }, { "name": "noBody", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Disable rendering of the default inner card-body element" }, { "name": "overlay", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "When set, will overlay the card body on top of the image (if the card has an image)" }, { "name": "subTitle", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Text content to place in the sub title" }, { "name": "subTitleTag", "value": { "kind": "expression", "type": "string" }, "default": "\"h6\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag for the sub title" }, { "name": "subTitleTextVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"muted\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the sub title text" }, { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "textVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the text" }, { "name": "title", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Text content to place in the title" }, { "name": "titleTag", "value": { "kind": "expression", "type": "string" }, "default": "\"h4\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag for the title" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Content to place in the card" }, { "name": "footer", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "For custom rendering of footer content" }, { "name": "header", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "For custom rendering of header content" } ] }, { "name": "BCardHeader", "source": { "module": "bootstrap-vue", "symbol": "BCardHeader" }, "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "A card is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options.", "attributes": [ { "name": "header", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Text content to place in the header" }, { "name": "headerBgVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the header background" }, { "name": "headerBorderVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the header border" }, { "name": "headerClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "CSS class (or classes) to apply to the header" }, { "name": "headerHtml", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "HTML string content to place in the header" }, { "name": "headerTag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag for the header" }, { "name": "headerTextVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the header text" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Content to place in the card header" } ] }, { "name": "BCardFooter", "source": { "module": "bootstrap-vue", "symbol": "BCardFooter" }, "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "A card is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options.", "attributes": [ { "name": "footer", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Text content to place in the footer" }, { "name": "footerBgVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the footer background" }, { "name": "footerBorderVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the footer border" }, { "name": "footerClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "CSS class (or classes) to apply to the footer" }, { "name": "footerHtml", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "HTML string content to place in the footer" }, { "name": "footerTag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag for the footer" }, { "name": "footerTextVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the footer text" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Content to place in the card footer" } ] }, { "name": "BCardBody", "source": { "module": "bootstrap-vue", "symbol": "BCardBody" }, "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "A card is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options.", "attributes": [ { "name": "bodyBgVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the body background" }, { "name": "bodyBorderVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the body border" }, { "name": "bodyClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "CSS class (or classes) to apply to the body" }, { "name": "bodyTag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag for the body" }, { "name": "bodyTextVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the body text" }, { "name": "overlay", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "When set, will overlay the card body on top of the image (if the card has an image)" }, { "name": "subTitle", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Text content to place in the sub title" }, { "name": "subTitleTag", "value": { "kind": "expression", "type": "string" }, "default": "\"h6\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag for the sub title" }, { "name": "subTitleTextVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"muted\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the sub title text" }, { "name": "title", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Text content to place in the title" }, { "name": "titleTag", "value": { "kind": "expression", "type": "string" }, "default": "\"h4\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag for the title" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Content to place in the card body" } ] }, { "name": "BCardTitle", "source": { "module": "bootstrap-vue", "symbol": "BCardTitle" }, "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "A card is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options.", "attributes": [ { "name": "title", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Text content to place in the title" }, { "name": "titleTag", "value": { "kind": "expression", "type": "string" }, "default": "\"h4\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag for the title" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Content to place in the card title" } ] }, { "name": "BCardSubTitle", "source": { "module": "bootstrap-vue", "symbol": "BCardSubTitle" }, "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "A card is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options.", "attributes": [ { "name": "subTitle", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Text content to place in the sub title" }, { "name": "subTitleTag", "value": { "kind": "expression", "type": "string" }, "default": "\"h6\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag for the sub title" }, { "name": "subTitleTextVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"muted\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Applies one of the Bootstrap theme color variants to the sub title text" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Content to place in the card sub-title" } ] }, { "name": "BCardImg", "source": { "module": "bootstrap-vue", "symbol": "BCardImg" }, "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "A card is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options.", "attributes": [ { "name": "alt", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Value to set for the `alt` attribute" }, { "name": "bottom", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image will be placed at the bottom of the card" }, { "name": "end", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image will be placed at the end (right) of the card" }, { "name": "height", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "The value to set on the image's 'height' attribute" }, { "name": "left", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image will be placed at the start (left) of the card. Synonym for the 'left' prop" }, { "name": "right", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image will be placed at the end (right) of the card. Synonym for the 'right' prop" }, { "name": "src", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "URL to set for the `src` attribute" }, { "name": "start", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image will be placed at the start (left) of the card" }, { "name": "top", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image will be placed at the top of the card" }, { "name": "width", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "The value to set on the image's 'width' attribute" } ] }, { "name": "BCardImgLazy", "source": { "module": "bootstrap-vue", "symbol": "BCardImgLazy" }, "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "A card is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options.", "attributes": [ { "name": "blankHeight", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Value of the 'height' attribute for the placeholder image" }, { "name": "blankSrc", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "URL of placeholder image. If not set, an SVG placeholder placeholder will be used" }, { "name": "blankWidth", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Value of the 'width' attribute for the placeholder image" }, { "name": "bottom", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image will be placed at the bottom of the card" }, { "name": "end", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image will be placed at the end (right) of the card" }, { "name": "left", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image will be placed at the start (left) of the card. Synonym for the 'left' prop" }, { "name": "offset", "value": { "kind": "expression", "type": "number|string" }, "default": "360", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Number of pixels away from the viewport edge before the lazy image is loaded" }, { "name": "right", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image will be placed at the end (right) of the card. Synonym for the 'right' prop" }, { "name": "show", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "If set to true, will force show the image specified via the 'src' prop" }, { "name": "start", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image will be placed at the start (left) of the card" }, { "name": "top", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "Set if the image will be placed at the top of the card" } ] }, { "name": "BCardText", "source": { "module": "bootstrap-vue", "symbol": "BCardText" }, "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "A card is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options.", "attributes": [ { "name": "textTag", "value": { "kind": "expression", "type": "string" }, "default": "\"p\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag for the text content" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Content to place in the card text" } ] }, { "name": "BCardGroup", "source": { "module": "bootstrap-vue", "symbol": "BCardGroup" }, "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "A card is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options.", "attributes": [ { "name": "columns", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "When set, renders the card group in a masonry-like columnar style" }, { "name": "deck", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "type": "boolean", "description": "When set renders the card group with gutters between cards" }, { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Specify the HTML tag to render instead of the default tag" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/card/", "description": "Content (cards) to place in the card group" } ] }, { "name": "BCarousel", "source": { "module": "bootstrap-vue", "symbol": "BCarousel" }, "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "The component is a slideshow for cycling through a series of content, built with CSS 3D transforms. It works with a series of images, text, or custom markup.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "value", "value": { "kind": "expression", "type": "number" }, "default": "0", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "The currently active slide (zero-indexed)" }, { "name": "background", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Set the CSS color of the carousel's background" }, { "name": "controls", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "type": "boolean", "description": "Enable the previous and next controls" }, { "name": "fade", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "type": "boolean", "description": "When set, changes the slide animation to a crossfade instead of a sliding effect" }, { "name": "imgHeight", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Set the default image 'height' attribute for all b-tab children" }, { "name": "imgWidth", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Set the default image 'width' attribute for all b-tab children" }, { "name": "indicators", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "type": "boolean", "description": "Enable the indicator buttons for jumping to specific slides" }, { "name": "interval", "value": { "kind": "expression", "type": "number" }, "default": "5000", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Set the delay time (in milliseconds) between slides" }, { "name": "labelGotoSlide", "value": { "kind": "expression", "type": "string" }, "default": "\"Goto slide\"", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Sets the prefix for the 'aria-label' on the slide indicator controls. Will be suffixed with the slide number (1 indexed)" }, { "name": "labelIndicators", "value": { "kind": "expression", "type": "string" }, "default": "\"Select a slide to display\"", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Sets the 'aria-label' on the indicator controls wrapper" }, { "name": "labelNext", "value": { "kind": "expression", "type": "string" }, "default": "\"Next slide\"", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Sets the 'aria-label' value for the next slide control" }, { "name": "labelPrev", "value": { "kind": "expression", "type": "string" }, "default": "\"Previous slide\"", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Sets the 'aria-label' value for the previous slide control" }, { "name": "noAnimation", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "type": "boolean", "description": "When set, disables animation when transitioning between slides" }, { "name": "noHoverPause", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "type": "boolean", "description": "When set, disables the pausing of the slide show when the current slide is hovered" }, { "name": "noTouch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "type": "boolean", "description": "Disable controlling the slides via touch swipes" }, { "name": "noWrap", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "type": "boolean", "description": "Do not restart the slide show when then end is reached" } ], "vue-model": { "prop": "value", "event": "input" }, "events": [ { "name": "sliding-end", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Emitted when transitioning to a new slide has ended", "arguments": [ { "name": "slide", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Slide number that was slid to", "type": "number" } ] }, { "name": "sliding-start", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Emitted when transitioning to a new slide has started", "arguments": [ { "name": "slide", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Slide number that is being slid to", "type": "number" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Content (slides) to place in the carousel" } ] }, { "name": "BCarouselSlide", "source": { "module": "bootstrap-vue", "symbol": "BCarouselSlide" }, "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "The component is a slideshow for cycling through a series of content, built with CSS 3D transforms. It works with a series of images, text, or custom markup.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "background", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "CSS color to use as the slide's background color" }, { "name": "caption", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Text content to place in the caption" }, { "name": "captionHtml", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "HTML string content to place in the caption" }, { "name": "captionTag", "value": { "kind": "expression", "type": "string" }, "default": "\"h3\"", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Specify the HTML tag to render instead of the default tag for the caption wrapper" }, { "name": "contentTag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Specify the HTML tag to render instead of the default tag for the content wrapper" }, { "name": "contentVisibleUp", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Specify the breakpoint that the textual content will start to be shown. Leave at default to always show the textual content" }, { "name": "imgAlt", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Sets the value of the 'alt' attribute on the image" }, { "name": "imgBlank", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "type": "boolean", "description": "If set, will render a blank image instead of the img-src" }, { "name": "imgBlankColor", "value": { "kind": "expression", "type": "string" }, "default": "\"transparent\"", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Set the CSS color to use as the fill of the blank image" }, { "name": "imgHeight", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Set the default image 'height' attribute for all b-tab children" }, { "name": "imgSrc", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Sets the URL of the image" }, { "name": "imgWidth", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Set the default image 'width' attribute for all b-tab children" }, { "name": "text", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Text content to place in the text of the slide" }, { "name": "textHtml", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "HTML string content to place in the text of the slide" }, { "name": "textTag", "value": { "kind": "expression", "type": "string" }, "default": "\"p\"", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Specify the HTML tag to render instead of the default tag for the text content" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Content to place in the carousel slide" }, { "name": "img", "doc-url": "https:/bootstrap-vue.org/docs/components/carousel/", "description": "Slot for img element or image component" } ] }, { "name": "BCollapse", "source": { "module": "bootstrap-vue", "symbol": "BCollapse" }, "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "Easily toggle content visibility on your pages. Includes support for making accordions.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "visible", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "type": "boolean", "description": "When 'true', expands the collapse" }, { "name": "accordion", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "The name of the accordion group that this collapse belongs to" }, { "name": "appear", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "type": "boolean", "description": "When set, and prop 'visible' is true on mount, will animate on initial mount" }, { "name": "isNav", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "type": "boolean", "description": "When set, signifies that the collapse is part of a navbar, enabling certain features for navbar support" }, { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "Specify the HTML tag to render instead of the default tag" } ], "vue-model": { "prop": "visible", "event": "input" }, "events": [ { "name": "bv::collapse::state", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "Emitted on $root when collapse has changed its state", "arguments": [ { "name": "id", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "Changed state collapse ID", "type": "string" }, { "name": "state", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "`true` or `false`, i.e. opened or closed", "type": "boolean" } ] }, { "name": "hidden", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "Emitted when collapse has finished closing" }, { "name": "hide", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "Emitted when collapse has started to close" }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "Used to update the v-model", "arguments": [ { "name": "visible", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "Will be true if the collapse is visible", "type": "boolean" } ] }, { "name": "show", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "Emitted when collapse has started to open" }, { "name": "shown", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "Emitted when collapse has finished opening" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "vue-properties": [ { "name": "close", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "Method for closing the collapse", "type": "function" }, { "name": "visible", "doc-url": "https:/bootstrap-vue.org/docs/components/collapse/", "description": "Visible state of the collapse. `true` if the collapse is visible", "type": "boolean" } ] } ] }, { "name": "BDropdown", "source": { "module": "bootstrap-vue", "symbol": "BDropdown" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "boundary", "value": { "kind": "expression", "type": "HTMLElement|string" }, "default": "\"scrollParent\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "The boundary constraint of the menu: 'scrollParent', 'window', 'viewport', or a reference to an HTMLElement" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "dropleft", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, positions the menu to the left of the button" }, { "name": "dropright", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, positions the menu to the right of the button" }, { "name": "dropup", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, positions the menu on the top of the button" }, { "name": "noFlip", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "Prevent the menu from auto flipping positions" }, { "name": "offset", "value": { "kind": "expression", "type": "number|string" }, "default": "0", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Specify the number of pixels to shift the menu by. Negative values supported" }, { "name": "popperOpts", "value": { "kind": "expression", "type": "object" }, "default": "{}", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Additional configuration to pass to Popper.js" }, { "name": "right", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "Align the right edge of the menu with the right of the button" }, { "name": "block", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "Renders a 100% width toggle button (expands to the width of its parent container)" }, { "name": "html", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "HTML string to place in the toggle button, or in the split button is split mode" }, { "name": "lazy", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, will only mount the menu content into the DOM when the menu is open" }, { "name": "menuClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "CSS class (or classes) to add to the menu container" }, { "name": "noCaret", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "Hide the caret indicator on the toggle button" }, { "name": "role", "value": { "kind": "expression", "type": "string" }, "default": "\"menu\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Sets the ARIA attribute `role` to a specific value" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "split", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, renders a split button dropdown" }, { "name": "splitButtonType", "value": { "kind": "expression", "type": "string" }, "default": "\"button\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Value to place in the 'type' attribute on the split button: 'button', 'submit', 'reset'" }, { "name": "splitClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "CSS class (or classes) to add to the split button" }, { "name": "splitHref", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Denotes the target URL of the link for the split button" }, { "name": "splitTo", "value": { "kind": "expression", "type": "object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Denotes the target route of the split button. 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": "splitVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the split button. Defaults to the 'variant' prop value" }, { "name": "text", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Text to place in the toggle button, or in the split button is split mode" }, { "name": "toggleClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "CSS class (or classes) to add to the toggle button" }, { "name": "toggleTag", "value": { "kind": "expression", "type": "string" }, "default": "\"button\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "toggleText", "value": { "kind": "expression", "type": "string" }, "default": "\"Toggle dropdown\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "ARIA label (sr-only) to set on the toggle when in split mode" }, { "name": "variant", "value": { "kind": "expression", "type": "string" }, "default": "\"secondary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "events": [ { "name": "bv::dropdown::hide", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted on $root just before dropdown is hidden. Cancelable", "arguments": [ { "name": "bvEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "BvEvent object. Call bvEvent.preventDefault() to cancel hide", "type": "BvEvent" } ] }, { "name": "bv::dropdown::show", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted on $root just before dropdown is shown. Cancelable", "arguments": [ { "name": "bvEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "BvEvent object. Call bvEvent.preventDefault() to cancel show", "type": "BvEvent" } ] }, { "name": "click", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when split button is clicked in split mode", "arguments": [ { "name": "event", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Native click event object", "type": "MouseEvent" } ] }, { "name": "hidden", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when dropdown is hidden" }, { "name": "hide", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted just before dropdown is hidden. Cancelable", "arguments": [ { "name": "bvEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "BvEvent object. Call bvEvent.preventDefault() to cancel hide", "type": "BvEvent" } ] }, { "name": "show", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted just before dropdown is shown. Cancelable", "arguments": [ { "name": "bvEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "BvEvent object. Call bvEvent.preventDefault() to cancel show", "type": "BvEvent" } ] }, { "name": "shown", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when dropdown is shown" }, { "name": "toggle", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when toggle button is clicked" } ], "slots": [ { "name": "button-content", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Can be used to implement custom text with icons and more styling" }, { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Optionally scoped default slot for dropdown menu content", "vue-properties": [ { "name": "hide", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Can be used to close the dropdown menu. Accepts an optional boolean argument, which if true returns focus to the toggle button", "type": "function" } ] } ] }, { "name": "BDd", "source": { "module": "bootstrap-vue", "symbol": "BDd" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.\n\n*Alias for BDropdown*", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "boundary", "value": { "kind": "expression", "type": "HTMLElement|string" }, "default": "\"scrollParent\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "The boundary constraint of the menu: 'scrollParent', 'window', 'viewport', or a reference to an HTMLElement" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "dropleft", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, positions the menu to the left of the button" }, { "name": "dropright", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, positions the menu to the right of the button" }, { "name": "dropup", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, positions the menu on the top of the button" }, { "name": "noFlip", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "Prevent the menu from auto flipping positions" }, { "name": "offset", "value": { "kind": "expression", "type": "number|string" }, "default": "0", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Specify the number of pixels to shift the menu by. Negative values supported" }, { "name": "popperOpts", "value": { "kind": "expression", "type": "object" }, "default": "{}", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Additional configuration to pass to Popper.js" }, { "name": "right", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "Align the right edge of the menu with the right of the button" }, { "name": "block", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "Renders a 100% width toggle button (expands to the width of its parent container)" }, { "name": "html", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "HTML string to place in the toggle button, or in the split button is split mode" }, { "name": "lazy", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, will only mount the menu content into the DOM when the menu is open" }, { "name": "menuClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "CSS class (or classes) to add to the menu container" }, { "name": "noCaret", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "Hide the caret indicator on the toggle button" }, { "name": "role", "value": { "kind": "expression", "type": "string" }, "default": "\"menu\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Sets the ARIA attribute `role` to a specific value" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "split", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, renders a split button dropdown" }, { "name": "splitButtonType", "value": { "kind": "expression", "type": "string" }, "default": "\"button\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Value to place in the 'type' attribute on the split button: 'button', 'submit', 'reset'" }, { "name": "splitClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "CSS class (or classes) to add to the split button" }, { "name": "splitHref", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Denotes the target URL of the link for the split button" }, { "name": "splitTo", "value": { "kind": "expression", "type": "object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Denotes the target route of the split button. 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": "splitVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the split button. Defaults to the 'variant' prop value" }, { "name": "text", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Text to place in the toggle button, or in the split button is split mode" }, { "name": "toggleClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "CSS class (or classes) to add to the toggle button" }, { "name": "toggleTag", "value": { "kind": "expression", "type": "string" }, "default": "\"button\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "toggleText", "value": { "kind": "expression", "type": "string" }, "default": "\"Toggle dropdown\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "ARIA label (sr-only) to set on the toggle when in split mode" }, { "name": "variant", "value": { "kind": "expression", "type": "string" }, "default": "\"secondary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "events": [ { "name": "bv::dropdown::hide", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted on $root just before dropdown is hidden. Cancelable", "arguments": [ { "name": "bvEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "BvEvent object. Call bvEvent.preventDefault() to cancel hide", "type": "BvEvent" } ] }, { "name": "bv::dropdown::show", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted on $root just before dropdown is shown. Cancelable", "arguments": [ { "name": "bvEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "BvEvent object. Call bvEvent.preventDefault() to cancel show", "type": "BvEvent" } ] }, { "name": "click", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when split button is clicked in split mode", "arguments": [ { "name": "event", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Native click event object", "type": "MouseEvent" } ] }, { "name": "hidden", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when dropdown is hidden" }, { "name": "hide", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted just before dropdown is hidden. Cancelable", "arguments": [ { "name": "bvEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "BvEvent object. Call bvEvent.preventDefault() to cancel hide", "type": "BvEvent" } ] }, { "name": "show", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted just before dropdown is shown. Cancelable", "arguments": [ { "name": "bvEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "BvEvent object. Call bvEvent.preventDefault() to cancel show", "type": "BvEvent" } ] }, { "name": "shown", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when dropdown is shown" }, { "name": "toggle", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when toggle button is clicked" } ], "slots": [ { "name": "button-content", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Can be used to implement custom text with icons and more styling" }, { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Optionally scoped default slot for dropdown menu content", "vue-properties": [ { "name": "hide", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Can be used to close the dropdown menu. Accepts an optional boolean argument, which if true returns focus to the toggle button", "type": "function" } ] } ] }, { "name": "BDropdownItem", "source": { "module": "bootstrap-vue", "symbol": "BDropdownItem" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.", "attributes": [ { "name": "active", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, places the component in the active state with active styling" }, { "name": "activeClass", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'" }, { "name": "append", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": " prop: Setting append prop always appends the relative path to the current path" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "exact", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": " 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/dropdown/", "description": " 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": "href", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Denotes the target URL of the link for standard a links" }, { "name": "linkClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Class or classes to apply to the inner link element" }, { "name": "noPrefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": " 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": "prefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": " 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 `prefetch` to `true` or `false` will overwrite the default value of `router.prefetchLinks`" }, { "name": "rel", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Sets the `rel` attribute on the rendered link" }, { "name": "replace", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": " 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": "routerComponentName", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: BootstrapVue auto detects between `` and ``. In cases where you want to use a 3rd party link component based on ``, set this prop to the component name. e.g. set it to 'g-link' if you are using Gridsome (note only `` specific props are passed to the component)" }, { "name": "target", "value": { "kind": "expression", "type": "string" }, "default": "\"_self\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Sets the `target` attribute on the rendered link" }, { "name": "to", "value": { "kind": "expression", "type": "object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " 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": "variant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "events": [ { "name": "click", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when item is clicked", "arguments": [ { "name": "mouseEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Native click event object", "type": "MouseEvent" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content to place in the dropdown item" } ] }, { "name": "BDdItem", "source": { "module": "bootstrap-vue", "symbol": "BDdItem" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.\n\n*Alias for BDropdownItem*", "attributes": [ { "name": "active", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, places the component in the active state with active styling" }, { "name": "activeClass", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'" }, { "name": "append", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": " prop: Setting append prop always appends the relative path to the current path" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "exact", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": " 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/dropdown/", "description": " 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": "href", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Denotes the target URL of the link for standard a links" }, { "name": "linkClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Class or classes to apply to the inner link element" }, { "name": "noPrefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": " 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": "prefetch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": " 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 `prefetch` to `true` or `false` will overwrite the default value of `router.prefetchLinks`" }, { "name": "rel", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Sets the `rel` attribute on the rendered link" }, { "name": "replace", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": " 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": "routerComponentName", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: BootstrapVue auto detects between `` and ``. In cases where you want to use a 3rd party link component based on ``, set this prop to the component name. e.g. set it to 'g-link' if you are using Gridsome (note only `` specific props are passed to the component)" }, { "name": "target", "value": { "kind": "expression", "type": "string" }, "default": "\"_self\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Sets the `target` attribute on the rendered link" }, { "name": "to", "value": { "kind": "expression", "type": "object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " 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": "variant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "events": [ { "name": "click", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when item is clicked", "arguments": [ { "name": "mouseEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Native click event object", "type": "MouseEvent" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content to place in the dropdown item" } ] }, { "name": "BDropdownItemButton", "source": { "module": "bootstrap-vue", "symbol": "BDropdownItemButton" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.", "attributes": [ { "name": "active", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, places the component in the active state with active styling" }, { "name": "activeClass", "value": { "kind": "expression", "type": "string" }, "default": "\"active\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'" }, { "name": "buttonClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Class or classes to apply to the inner button element" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "variant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "events": [ { "name": "click", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when button item is clicked", "arguments": [ { "name": "mouseEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Native click event object", "type": "MouseEvent" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content to place in the dropdown item-button" } ] }, { "name": "BDropdownItemBtn", "source": { "module": "bootstrap-vue", "symbol": "BDropdownItemBtn" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.\n\n*Alias for BDropdownItemButton*", "attributes": [ { "name": "active", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, places the component in the active state with active styling" }, { "name": "activeClass", "value": { "kind": "expression", "type": "string" }, "default": "\"active\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'" }, { "name": "buttonClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Class or classes to apply to the inner button element" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "variant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "events": [ { "name": "click", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when button item is clicked", "arguments": [ { "name": "mouseEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Native click event object", "type": "MouseEvent" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content to place in the dropdown item-button" } ] }, { "name": "BDdItemButton", "source": { "module": "bootstrap-vue", "symbol": "BDdItemButton" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.\n\n*Alias for BDropdownItemButton*", "attributes": [ { "name": "active", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, places the component in the active state with active styling" }, { "name": "activeClass", "value": { "kind": "expression", "type": "string" }, "default": "\"active\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'" }, { "name": "buttonClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Class or classes to apply to the inner button element" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "variant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "events": [ { "name": "click", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when button item is clicked", "arguments": [ { "name": "mouseEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Native click event object", "type": "MouseEvent" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content to place in the dropdown item-button" } ] }, { "name": "BDdItemBtn", "source": { "module": "bootstrap-vue", "symbol": "BDdItemBtn" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.\n\n*Alias for BDropdownItemButton*", "attributes": [ { "name": "active", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, places the component in the active state with active styling" }, { "name": "activeClass", "value": { "kind": "expression", "type": "string" }, "default": "\"active\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": " prop: Configure the active CSS class applied when the link is active. Typically you will want to set this to class name 'active'" }, { "name": "buttonClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Class or classes to apply to the inner button element" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "variant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "events": [ { "name": "click", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Emitted when button item is clicked", "arguments": [ { "name": "mouseEvent", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Native click event object", "type": "MouseEvent" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content to place in the dropdown item-button" } ] }, { "name": "BDropdownDivider", "source": { "module": "bootstrap-vue", "symbol": "BDropdownDivider" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.", "attributes": [ { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"hr\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Specify the HTML tag to render instead of the default tag" } ] }, { "name": "BDdDivider", "source": { "module": "bootstrap-vue", "symbol": "BDdDivider" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.\n\n*Alias for BDropdownDivider*", "attributes": [ { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"hr\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Specify the HTML tag to render instead of the default tag" } ] }, { "name": "BDropdownForm", "source": { "module": "bootstrap-vue", "symbol": "BDropdownForm" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.", "attributes": [ { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "formClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "CSS class (or classes) to add to the form" }, { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "inline", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, the form will be in inline mode which display labels, form controls, and buttons on a single horizontal row" }, { "name": "novalidate", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, disables browser native HTML5 validation on controls in the form" }, { "name": "validated", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, adds the Bootstrap class 'was-validated' on the form, triggering the native browser validation states" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content to place in the dropdown form" } ] }, { "name": "BDdForm", "source": { "module": "bootstrap-vue", "symbol": "BDdForm" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.\n\n*Alias for BDropdownForm*", "attributes": [ { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "formClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "CSS class (or classes) to add to the form" }, { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "inline", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, the form will be in inline mode which display labels, form controls, and buttons on a single horizontal row" }, { "name": "novalidate", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, disables browser native HTML5 validation on controls in the form" }, { "name": "validated", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "type": "boolean", "description": "When set, adds the Bootstrap class 'was-validated' on the form, triggering the native browser validation states" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content to place in the dropdown form" } ] }, { "name": "BDropdownText", "source": { "module": "bootstrap-vue", "symbol": "BDropdownText" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.", "attributes": [ { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"p\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "textClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Class or classes to apply to the inner element" }, { "name": "variant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content to place in the dropdown text" } ] }, { "name": "BDdText", "source": { "module": "bootstrap-vue", "symbol": "BDdText" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.\n\n*Alias for BDropdownText*", "attributes": [ { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"p\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "textClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Class or classes to apply to the inner element" }, { "name": "variant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content to place in the dropdown text" } ] }, { "name": "BDropdownGroup", "source": { "module": "bootstrap-vue", "symbol": "BDropdownGroup" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.", "attributes": [ { "name": "ariaDescribedby", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "The ID of the element that provides additional context for this component. Used as the value for the `aria-describedby` attribute" }, { "name": "header", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Text content to place in the header" }, { "name": "headerClasses", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "CSS class (or classes) to add to the header" }, { "name": "headerTag", "value": { "kind": "expression", "type": "string" }, "default": "\"header\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Specify the HTML tag to render instead of the default tag for the header" }, { "name": "headerVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the header" }, { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content (items) to place in the dropdown group" }, { "name": "header", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Optional header content for the dropdown group" } ] }, { "name": "BDdGroup", "source": { "module": "bootstrap-vue", "symbol": "BDdGroup" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.\n\n*Alias for BDropdownGroup*", "attributes": [ { "name": "ariaDescribedby", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "The ID of the element that provides additional context for this component. Used as the value for the `aria-describedby` attribute" }, { "name": "header", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Text content to place in the header" }, { "name": "headerClasses", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "CSS class (or classes) to add to the header" }, { "name": "headerTag", "value": { "kind": "expression", "type": "string" }, "default": "\"header\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Specify the HTML tag to render instead of the default tag for the header" }, { "name": "headerVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the header" }, { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content (items) to place in the dropdown group" }, { "name": "header", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Optional header content for the dropdown group" } ] }, { "name": "BDropdownHeader", "source": { "module": "bootstrap-vue", "symbol": "BDropdownHeader" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"header\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "variant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content to place in the dropdown header" } ] }, { "name": "BDdHeader", "source": { "module": "bootstrap-vue", "symbol": "BDdHeader" }, "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a dropdown menu format.\n\n*Alias for BDropdownHeader*", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"header\"", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "variant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/dropdown/", "description": "Content to place in the dropdown header" } ] }, { "name": "BEmbed", "source": { "module": "bootstrap-vue", "symbol": "BEmbed" }, "doc-url": "https:/bootstrap-vue.org/docs/components/embed/", "description": "Create responsive video or slideshow embeds based on the width of the parent by creating an intrinsic ratio that scales on any device.", "attributes": [ { "name": "aspect", "value": { "kind": "expression", "type": "string" }, "default": "\"16by9\"", "doc-url": "https:/bootstrap-vue.org/docs/components/embed/", "description": "Aspect ratio of the embed. Supported values are '16by9', '21by9', '4by3', and '1by1' and are translated to CSS classes. Refer to the docs for more details" }, { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/embed/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "type", "value": { "kind": "expression", "type": "string" }, "default": "\"iframe\"", "doc-url": "https:/bootstrap-vue.org/docs/components/embed/", "description": "Type of embed. Possible values are 'iframe', 'video', 'embed' and 'object'" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/embed/", "description": "Content to place in the embed" } ] }, { "name": "BForm", "source": { "module": "bootstrap-vue", "symbol": "BForm" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Form component and form helper components that optionally supports inline form styles and validation states.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "inline", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "type": "boolean", "description": "When set, the form will be in inline mode which display labels, form controls, and buttons on a single horizontal row" }, { "name": "novalidate", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "type": "boolean", "description": "When set, disables browser native HTML5 validation on controls in the form" }, { "name": "validated", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "type": "boolean", "description": "When set, adds the Bootstrap class 'was-validated' on the form, triggering the native browser validation states" } ], "events": [ { "name": "submit", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Emitted when the form is being submitted", "arguments": [ { "name": "event", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Native submit event", "type": "Event" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Content to place in the form" } ] }, { "name": "BFormText", "source": { "module": "bootstrap-vue", "symbol": "BFormText" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Form component and form helper components that optionally supports inline form styles and validation states.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "inline", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "type": "boolean", "description": "When set, renders the help text as an inline element, rather than a block element" }, { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"small\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "textVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"muted\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Applies one of the Bootstrap theme color variants to the text" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Content to place in the form text" } ] }, { "name": "BFormInvalidFeedback", "source": { "module": "bootstrap-vue", "symbol": "BFormInvalidFeedback" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Form component and form helper components that optionally supports inline form styles and validation states.", "attributes": [ { "name": "ariaLive", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "When the rendered element is an `aria-live` region (for screen reader users), set to either 'polite' or 'assertive'" }, { "name": "forceShow", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "type": "boolean", "description": "Shows the feedback text, regardless of the value of the 'state' prop" }, { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "role", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Sets the ARIA attribute `role` to a specific value" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "type": "boolean", "description": "When explicitly 'false', forces the feedback to show" }, { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "tooltip", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "type": "boolean", "description": "Renders the feedback text in a rudimentary tooltip style" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Content to place in the form invalid feedback" } ] }, { "name": "BFormValidFeedback", "source": { "module": "bootstrap-vue", "symbol": "BFormValidFeedback" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Form component and form helper components that optionally supports inline form styles and validation states.", "attributes": [ { "name": "ariaLive", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "When the rendered element is an `aria-live` region (for screen reader users), set to either 'polite' or 'assertive'" }, { "name": "forceShow", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "type": "boolean", "description": "Shows the feedback text, regardless of the value of the 'state' prop" }, { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "role", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Sets the ARIA attribute `role` to a specific value" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "type": "boolean", "description": "When explicitly 'true', forces the feedback to show" }, { "name": "tag", "value": { "kind": "expression", "type": "string" }, "default": "\"div\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Specify the HTML tag to render instead of the default tag" }, { "name": "tooltip", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "type": "boolean", "description": "Renders the feedback text in a rudimentary tooltip style" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Content to place in the form valid feedback element" } ] }, { "name": "BFormDatalist", "source": { "module": "bootstrap-vue", "symbol": "BFormDatalist" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Form component and form helper components that optionally supports inline form styles and validation states.", "attributes": [ { "name": "disabledField", "value": { "kind": "expression", "type": "string" }, "default": "\"disabled\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Field name in the `options` array that should be used for the disabled state" }, { "name": "htmlField", "value": { "kind": "expression", "type": "string" }, "default": "\"html\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Field name in the `options` array that should be used for the html label instead of text field" }, { "name": "options", "value": { "kind": "expression", "type": "any[]|object" }, "default": "[]", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Array of items to render in the component" }, { "name": "textField", "value": { "kind": "expression", "type": "string" }, "default": "\"text\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Field name in the `options` array that should be used for the text label" }, { "name": "valueField", "value": { "kind": "expression", "type": "string" }, "default": "\"value\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Field name in the `options` array that should be used for the value" }, { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "required": true, "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Content to place in the from datalist" } ] }, { "name": "BDatalist", "source": { "module": "bootstrap-vue", "symbol": "BDatalist" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Form component and form helper components that optionally supports inline form styles and validation states.\n\n*Alias for BFormDatalist*", "attributes": [ { "name": "disabledField", "value": { "kind": "expression", "type": "string" }, "default": "\"disabled\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Field name in the `options` array that should be used for the disabled state" }, { "name": "htmlField", "value": { "kind": "expression", "type": "string" }, "default": "\"html\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Field name in the `options` array that should be used for the html label instead of text field" }, { "name": "options", "value": { "kind": "expression", "type": "any[]|object" }, "default": "[]", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Array of items to render in the component" }, { "name": "textField", "value": { "kind": "expression", "type": "string" }, "default": "\"text\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Field name in the `options` array that should be used for the text label" }, { "name": "valueField", "value": { "kind": "expression", "type": "string" }, "default": "\"value\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Field name in the `options` array that should be used for the value" }, { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "required": true, "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form/", "description": "Content to place in the from datalist" } ] }, { "name": "BFormCheckboxGroup", "source": { "module": "bootstrap-vue", "symbol": "BFormCheckboxGroup" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Custom checkbox input and checkbox group to replace the browser default checkbox input, built on top of semantic and accessible markup. Optionally supports switch styling.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "checked", "value": { "kind": "expression", "type": "any[]" }, "default": "[]", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "The current value of the checked checkboxes in the group. Must be an array when there are multiple checkboxes" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "disabledField", "value": { "kind": "expression", "type": "string" }, "default": "\"disabled\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Field name in the `options` array that should be used for the disabled state" }, { "name": "htmlField", "value": { "kind": "expression", "type": "string" }, "default": "\"html\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Field name in the `options` array that should be used for the html label instead of text field" }, { "name": "options", "value": { "kind": "expression", "type": "any[]|object" }, "default": "[]", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Array of items to render in the component" }, { "name": "textField", "value": { "kind": "expression", "type": "string" }, "default": "\"text\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Field name in the `options` array that should be used for the text label" }, { "name": "valueField", "value": { "kind": "expression", "type": "string" }, "default": "\"value\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Field name in the `options` array that should be used for the value" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "plain", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Render the form control in plain mode, rather than custom styled mode" }, { "name": "ariaInvalid", "value": { "kind": "expression", "type": "boolean|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Sets the 'aria-invalid' attribute value on the wrapper element. When not provided, the 'state' prop will control the attribute" }, { "name": "buttonVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Specifies the Bootstrap contextual color theme variant the apply to the button style checkboxes" }, { "name": "buttons", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renderes the checkboxes in this group with button styling" }, { "name": "stacked", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkbox group in stacked mode" }, { "name": "validated", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, adds the Bootstrap class 'was-validated' to the group wrapper" }, { "name": "switches", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkboxes in the group with switch styling" } ], "vue-model": { "prop": "checked", "event": "input" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Emitted when selected value(s) is changed due to user interaction", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value of checkboxes. Value will be an array", "type": "any[]" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Emitted when the checked value is changed", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value of checkboxes. Value will be an array", "type": "any[]" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Content (form checkboxes) to place in the form checkbox group" }, { "name": "first", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Slot to place b-form-checks so that they appear before checks generated from options prop" } ] }, { "name": "BCheckboxGroup", "source": { "module": "bootstrap-vue", "symbol": "BCheckboxGroup" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Custom checkbox input and checkbox group to replace the browser default checkbox input, built on top of semantic and accessible markup. Optionally supports switch styling.\n\n*Alias for BFormCheckboxGroup*", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "checked", "value": { "kind": "expression", "type": "any[]" }, "default": "[]", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "The current value of the checked checkboxes in the group. Must be an array when there are multiple checkboxes" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "disabledField", "value": { "kind": "expression", "type": "string" }, "default": "\"disabled\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Field name in the `options` array that should be used for the disabled state" }, { "name": "htmlField", "value": { "kind": "expression", "type": "string" }, "default": "\"html\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Field name in the `options` array that should be used for the html label instead of text field" }, { "name": "options", "value": { "kind": "expression", "type": "any[]|object" }, "default": "[]", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Array of items to render in the component" }, { "name": "textField", "value": { "kind": "expression", "type": "string" }, "default": "\"text\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Field name in the `options` array that should be used for the text label" }, { "name": "valueField", "value": { "kind": "expression", "type": "string" }, "default": "\"value\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Field name in the `options` array that should be used for the value" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "plain", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Render the form control in plain mode, rather than custom styled mode" }, { "name": "ariaInvalid", "value": { "kind": "expression", "type": "boolean|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Sets the 'aria-invalid' attribute value on the wrapper element. When not provided, the 'state' prop will control the attribute" }, { "name": "buttonVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Specifies the Bootstrap contextual color theme variant the apply to the button style checkboxes" }, { "name": "buttons", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renderes the checkboxes in this group with button styling" }, { "name": "stacked", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkbox group in stacked mode" }, { "name": "validated", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, adds the Bootstrap class 'was-validated' to the group wrapper" }, { "name": "switches", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkboxes in the group with switch styling" } ], "vue-model": { "prop": "checked", "event": "input" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Emitted when selected value(s) is changed due to user interaction", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value of checkboxes. Value will be an array", "type": "any[]" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Emitted when the checked value is changed", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value of checkboxes. Value will be an array", "type": "any[]" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Content (form checkboxes) to place in the form checkbox group" }, { "name": "first", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Slot to place b-form-checks so that they appear before checks generated from options prop" } ] }, { "name": "BCheckGroup", "source": { "module": "bootstrap-vue", "symbol": "BCheckGroup" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Custom checkbox input and checkbox group to replace the browser default checkbox input, built on top of semantic and accessible markup. Optionally supports switch styling.\n\n*Alias for BFormCheckboxGroup*", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "checked", "value": { "kind": "expression", "type": "any[]" }, "default": "[]", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "The current value of the checked checkboxes in the group. Must be an array when there are multiple checkboxes" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "disabledField", "value": { "kind": "expression", "type": "string" }, "default": "\"disabled\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Field name in the `options` array that should be used for the disabled state" }, { "name": "htmlField", "value": { "kind": "expression", "type": "string" }, "default": "\"html\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Field name in the `options` array that should be used for the html label instead of text field" }, { "name": "options", "value": { "kind": "expression", "type": "any[]|object" }, "default": "[]", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Array of items to render in the component" }, { "name": "textField", "value": { "kind": "expression", "type": "string" }, "default": "\"text\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Field name in the `options` array that should be used for the text label" }, { "name": "valueField", "value": { "kind": "expression", "type": "string" }, "default": "\"value\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Field name in the `options` array that should be used for the value" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "plain", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Render the form control in plain mode, rather than custom styled mode" }, { "name": "ariaInvalid", "value": { "kind": "expression", "type": "boolean|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Sets the 'aria-invalid' attribute value on the wrapper element. When not provided, the 'state' prop will control the attribute" }, { "name": "buttonVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Specifies the Bootstrap contextual color theme variant the apply to the button style checkboxes" }, { "name": "buttons", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renderes the checkboxes in this group with button styling" }, { "name": "stacked", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkbox group in stacked mode" }, { "name": "validated", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, adds the Bootstrap class 'was-validated' to the group wrapper" }, { "name": "switches", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkboxes in the group with switch styling" } ], "vue-model": { "prop": "checked", "event": "input" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Emitted when selected value(s) is changed due to user interaction", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value of checkboxes. Value will be an array", "type": "any[]" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Emitted when the checked value is changed", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value of checkboxes. Value will be an array", "type": "any[]" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Content (form checkboxes) to place in the form checkbox group" }, { "name": "first", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Slot to place b-form-checks so that they appear before checks generated from options prop" } ] }, { "name": "BFormCheckbox", "source": { "module": "bootstrap-vue", "symbol": "BFormCheckbox" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Custom checkbox input and checkbox group to replace the browser default checkbox input, built on top of semantic and accessible markup. Optionally supports switch styling.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "checked", "value": { "kind": "expression", "type": "any" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "The current value of the checkbox(es). Must be an array when there are multiple checkboxes bound to the same v-model" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "plain", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Render the form control in plain mode, rather than custom styled mode" }, { "name": "ariaLabel", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Sets the value of `aria-label` attribute on the rendered element" }, { "name": "ariaLabelledby", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "The ID of the element that provides a label for this component. Used as the value for the `aria-labelledby` attribute" }, { "name": "button", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkbox with the appearance of a button" }, { "name": "buttonVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Applies on of Bootstrap's theme colors when in 'button' mode" }, { "name": "inline", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkbox as an inline element rather than as a 100% width block" }, { "name": "value", "value": { "kind": "expression", "type": "any" }, "default": "true", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value returned when this checkbox is checked" }, { "name": "indeterminate", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Renders the checkbox in an indeterminate state. Syncable via the .sync modifier" }, { "name": "switch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkbox with the appearance of a switch" }, { "name": "uncheckedValue", "value": { "kind": "expression", "type": "any" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value returned when this checkbox is unchecked. Note not applicable when multiple checkboxes bound to the same v-model array" } ], "vue-model": { "prop": "checked", "event": "input" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Emitted when selected value(s) is changed due to user interaction", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value of checkbox(es). When bound to multiple checkboxes, value will be an array", "type": "boolean|string|number|object|any[]" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Emitted when the selected value(s) is changed", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value of checkbox(es). When bound to multiple checkboxes, value will be an array", "type": "boolean|string|number|object|any[]" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Content to place in the form checkbox" } ] }, { "name": "BCheckbox", "source": { "module": "bootstrap-vue", "symbol": "BCheckbox" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Custom checkbox input and checkbox group to replace the browser default checkbox input, built on top of semantic and accessible markup. Optionally supports switch styling.\n\n*Alias for BFormCheckbox*", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "checked", "value": { "kind": "expression", "type": "any" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "The current value of the checkbox(es). Must be an array when there are multiple checkboxes bound to the same v-model" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "plain", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Render the form control in plain mode, rather than custom styled mode" }, { "name": "ariaLabel", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Sets the value of `aria-label` attribute on the rendered element" }, { "name": "ariaLabelledby", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "The ID of the element that provides a label for this component. Used as the value for the `aria-labelledby` attribute" }, { "name": "button", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkbox with the appearance of a button" }, { "name": "buttonVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Applies on of Bootstrap's theme colors when in 'button' mode" }, { "name": "inline", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkbox as an inline element rather than as a 100% width block" }, { "name": "value", "value": { "kind": "expression", "type": "any" }, "default": "true", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value returned when this checkbox is checked" }, { "name": "indeterminate", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Renders the checkbox in an indeterminate state. Syncable via the .sync modifier" }, { "name": "switch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkbox with the appearance of a switch" }, { "name": "uncheckedValue", "value": { "kind": "expression", "type": "any" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value returned when this checkbox is unchecked. Note not applicable when multiple checkboxes bound to the same v-model array" } ], "vue-model": { "prop": "checked", "event": "input" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Emitted when selected value(s) is changed due to user interaction", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value of checkbox(es). When bound to multiple checkboxes, value will be an array", "type": "boolean|string|number|object|any[]" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Emitted when the selected value(s) is changed", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value of checkbox(es). When bound to multiple checkboxes, value will be an array", "type": "boolean|string|number|object|any[]" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Content to place in the form checkbox" } ] }, { "name": "BCheck", "source": { "module": "bootstrap-vue", "symbol": "BCheck" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Custom checkbox input and checkbox group to replace the browser default checkbox input, built on top of semantic and accessible markup. Optionally supports switch styling.\n\n*Alias for BFormCheckbox*", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "checked", "value": { "kind": "expression", "type": "any" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "The current value of the checkbox(es). Must be an array when there are multiple checkboxes bound to the same v-model" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "plain", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Render the form control in plain mode, rather than custom styled mode" }, { "name": "ariaLabel", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Sets the value of `aria-label` attribute on the rendered element" }, { "name": "ariaLabelledby", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "The ID of the element that provides a label for this component. Used as the value for the `aria-labelledby` attribute" }, { "name": "button", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkbox with the appearance of a button" }, { "name": "buttonVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Applies on of Bootstrap's theme colors when in 'button' mode" }, { "name": "inline", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkbox as an inline element rather than as a 100% width block" }, { "name": "value", "value": { "kind": "expression", "type": "any" }, "default": "true", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value returned when this checkbox is checked" }, { "name": "indeterminate", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "Renders the checkbox in an indeterminate state. Syncable via the .sync modifier" }, { "name": "switch", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "type": "boolean", "description": "When set, renders the checkbox with the appearance of a switch" }, { "name": "uncheckedValue", "value": { "kind": "expression", "type": "any" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value returned when this checkbox is unchecked. Note not applicable when multiple checkboxes bound to the same v-model array" } ], "vue-model": { "prop": "checked", "event": "input" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Emitted when selected value(s) is changed due to user interaction", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value of checkbox(es). When bound to multiple checkboxes, value will be an array", "type": "boolean|string|number|object|any[]" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Emitted when the selected value(s) is changed", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Value of checkbox(es). When bound to multiple checkboxes, value will be an array", "type": "boolean|string|number|object|any[]" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form-checkbox/", "description": "Content to place in the form checkbox" } ] }, { "name": "BFormDatepicker", "source": { "module": "bootstrap-vue", "symbol": "BFormDatepicker" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "BootstrapVue custom date picker input form control, which provides full WAI-ARIA accessibility (a11y) and supports internationalization (i18n).", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "value", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Initially selected date value. Accepts either a `YYYY-MM-DD` string or a `Date` object" }, { "name": "ariaControls", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "If this component controls another component or element, set this to the ID of the controlled component or element" }, { "name": "boundary", "value": { "kind": "expression", "type": "HTMLElement|string" }, "default": "\"scrollParent\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The boundary constraint of the menu: `'scrollParent'`, `'window'`, `'viewport'`, or a reference to an `HTMLElement`" }, { "name": "buttonOnly", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Renders the datepicker as a dropdown button instead of a form-control" }, { "name": "buttonVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"secondary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The button variant to use when in `button-only` mode. Has no effect if prop `button-only` is not set" }, { "name": "calendarWidth", "value": { "kind": "expression", "type": "string" }, "default": "\"270px\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Sets the width of the calendar dropdown (see the `b-calendar` prop `width` for details)" }, { "name": "closeButton", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, shows the optional close button" }, { "name": "closeButtonVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"outline-secondary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Button variant to use for the optional `close` button" }, { "name": "dark", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, gives the popup calendar dialog a dark background" }, { "name": "dateDisabledFn", "value": { "kind": "expression", "type": "function" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Set to a function reference which returns `true` if the date is disabled, or `false` if the date should be enabled. See documentation for details" }, { "name": "dateFormatOptions", "value": { "kind": "expression", "type": "object" }, "default": "{\"year\":\"numeric\",\"month\":\"long\",\"day\":\"numeric\",\"weekday\":\"long\"}", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Format object for displayed text string that is passed to `Intl.DateTimeFormat`" }, { "name": "dateInfoFn", "value": { "kind": "expression", "type": "function" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Set to a function reference which returns a class (string), or classes (array of strings) to apply to the date cell. See calendar documentation for details. Passed through to the child calendar component" }, { "name": "direction", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Set to the string 'rtl' or 'ltr' to explicitly force the calendar to render in right-to-left or left-ro-right (respectively) mode. Defaults to the resolved locale's directionality" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Places the calendar in a non-interactive disabled state" }, { "name": "dropleft", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, positions the menu to the left of the button" }, { "name": "dropright", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, positions the menu to the right of the button" }, { "name": "dropup", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, positions the menu on the top of the button" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "hideHeader", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When `true`, visually hides the selected date header" }, { "name": "initialDate", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "When a `value` is not specified, sets the initial calendar month date that will be presented to the user. Accepts a value in `YYYY-MM-DD` format or a `Date` object. Defaults to the current date (or min or max if the current date is out of range)" }, { "name": "labelCalendar", "value": { "kind": "expression", "type": "string" }, "default": "\"Calendar\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `role-description` attributes applied to the calendar grid" }, { "name": "labelCloseButton", "value": { "kind": "expression", "type": "string" }, "default": "\"Close\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Content for the optional `Close` button" }, { "name": "labelCurrentMonth", "value": { "kind": "expression", "type": "string" }, "default": "\"Current month\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the `Current Month` navigation button" }, { "name": "labelHelp", "value": { "kind": "expression", "type": "string" }, "default": "\"Use cursor keys to navigate calendar dates\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Help text that appears at the bottom of the calendar grid" }, { "name": "labelNav", "value": { "kind": "expression", "type": "string" }, "default": "\"Calendar navigation\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` attribute on to the calendar navigation button wrapper" }, { "name": "labelNextDecade", "value": { "kind": "expression", "type": "string" }, "default": "\"Next decade\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the optional `Next Decade` navigation button" }, { "name": "labelNextMonth", "value": { "kind": "expression", "type": "string" }, "default": "\"Next month\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the `Next Month` navigation button" }, { "name": "labelNextYear", "value": { "kind": "expression", "type": "string" }, "default": "\"Next year\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the `Next Year` navigation button" }, { "name": "labelNoDateSelected", "value": { "kind": "expression", "type": "string" }, "default": "\"No date selected\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Label to use when no date is currently selected" }, { "name": "labelPrevDecade", "value": { "kind": "expression", "type": "string" }, "default": "\"Previous decade\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the optional `Previous Decade` navigation button" }, { "name": "labelPrevMonth", "value": { "kind": "expression", "type": "string" }, "default": "\"Previous month\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the `Previous Month` navigation button" }, { "name": "labelPrevYear", "value": { "kind": "expression", "type": "string" }, "default": "\"Previous year\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the `Previous Year` navigation button" }, { "name": "labelResetButton", "value": { "kind": "expression", "type": "string" }, "default": "\"Reset\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Content for the optional `Reset` button" }, { "name": "labelSelected", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` attribute set on the calendar grid date button that is selected" }, { "name": "labelToday", "value": { "kind": "expression", "type": "string" }, "default": "\"Today\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` attribute for the calendar grid date button to signify that the date is today's date" }, { "name": "labelTodayButton", "value": { "kind": "expression", "type": "string" }, "default": "\"Select today\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Content for the optional `Select today` button" }, { "name": "locale", "value": { "kind": "expression", "type": "any[]|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Locale (or locales) for the calendar to use. When passing an array of locales, the order of the locales is from most preferred to least preferred" }, { "name": "max", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The maximum date the calendar will show" }, { "name": "menuClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Class (or classes) to apply to to popup menu wrapper" }, { "name": "min", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The minimum date the calendar will show" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "navButtonVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"secondary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Theme color variant to use for the navigation buttons" }, { "name": "noCloseOnSelect", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Disables closing the popup date picker when a date is clicked/selected" }, { "name": "noFlip", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Prevent the menu from auto flipping positions" }, { "name": "noHighlightToday", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Disabled the highlighting of todays date in the calendar" }, { "name": "offset", "value": { "kind": "expression", "type": "number|string" }, "default": "0", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Specify the number of pixels to shift the menu by. Negative values supported" }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Text so show in the form control when no date is selected. Defaults to the `label-no-date-selected` prop value" }, { "name": "popperOpts", "value": { "kind": "expression", "type": "object" }, "default": "{}", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Additional configuration to pass to Popper.js" }, { "name": "readonly", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Places the calendar in an interactive readonly state. Disables updating the v-model, while still allowing date navigation" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, adds the `aria-required=\"true\"` attribute on the component. Required validation needs to be handled by your application" }, { "name": "resetButton", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, shows the optional `reset` button" }, { "name": "resetButtonVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"outline-danger\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Button variant to use for the optional `reset` button" }, { "name": "resetValue", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "When the optional `reset` button is clicked, the selected date will be set to this value. Default is to clear the selected value" }, { "name": "right", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Align the right edge of the menu with the right of the button" }, { "name": "selectedVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"primary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Theme color variant to use for the selected date button" }, { "name": "showDecadeNav", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When `true`, shows the +/- decade navigation buttons" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "startWeekday", "value": { "kind": "expression", "type": "number|string" }, "default": "0", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Day of week to start the calendar. `0` for Sunday, `1` for Monday, `6` for Saturday, etc." }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "todayButton", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, shows the optional `select today` button" }, { "name": "todayButtonVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"outline-primary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Button variant to use for the optional `select today` button" }, { "name": "todayVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Theme color variant to use for highlighting todays date button. Defaults to the `selectedVariant` prop" }, { "name": "valueAsDate", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Returns a `Date` object for the v-model instead of a `YYYY-MM-DD` string" }, { "name": "weekdayHeaderFormat", "value": { "kind": "expression", "type": "string" }, "default": "\"short\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Format to use for the calendar weekday headings. Possible values are `long`, `short` (default), or `narrow`" } ], "vue-model": { "prop": "value", "event": "input" }, "events": [ { "name": "context", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "`b-calendar` context event. Emitted when the user changes the active date via date navigation buttons or cursor control", "arguments": [ { "name": "context", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The `b-calendar` context object. See the `b-calendar` documentaion for details", "type": "object" } ] }, { "name": "hidden", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Emitted when the picker popup has hidden" }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Emitted when updating the v-model", "arguments": [ { "name": "date", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Either a string in the format of `YYYY-MM-DD` or a `Date` object (if `value-as-date` prop is `true`)", "type": "string|Date" } ] }, { "name": "shown", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Emitted when the picker popup has shown" } ], "slots": [ { "name": "button-content", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Content to place in the datepicker's icon button", "vue-properties": [ { "name": "isHovered", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "`true` if the component is hovered", "type": "boolean" }, { "name": "hasFocus", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "`true` if the datepicker icon button has focus", "type": "boolean" }, { "name": "state", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The value of the `state` prop. `true` (valid), `false` (invalid), or `null`", "type": "boolean" }, { "name": "open", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The visibility state of the popup. `true` if the popup is visible and `false` if not", "type": "boolean" } ] }, { "name": "nav-next-decade", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the next decade navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-next-month", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the next month navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-next-year", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the next year navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-prev-decade", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the previous decade navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-prev-month", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the previous month navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-prev-year", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the previous year navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-this-month", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the this month/day navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] } ] }, { "name": "BDatepicker", "source": { "module": "bootstrap-vue", "symbol": "BDatepicker" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "BootstrapVue custom date picker input form control, which provides full WAI-ARIA accessibility (a11y) and supports internationalization (i18n).\n\n*Alias for BFormDatepicker*", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "value", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Initially selected date value. Accepts either a `YYYY-MM-DD` string or a `Date` object" }, { "name": "ariaControls", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "If this component controls another component or element, set this to the ID of the controlled component or element" }, { "name": "boundary", "value": { "kind": "expression", "type": "HTMLElement|string" }, "default": "\"scrollParent\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The boundary constraint of the menu: `'scrollParent'`, `'window'`, `'viewport'`, or a reference to an `HTMLElement`" }, { "name": "buttonOnly", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Renders the datepicker as a dropdown button instead of a form-control" }, { "name": "buttonVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"secondary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The button variant to use when in `button-only` mode. Has no effect if prop `button-only` is not set" }, { "name": "calendarWidth", "value": { "kind": "expression", "type": "string" }, "default": "\"270px\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Sets the width of the calendar dropdown (see the `b-calendar` prop `width` for details)" }, { "name": "closeButton", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, shows the optional close button" }, { "name": "closeButtonVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"outline-secondary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Button variant to use for the optional `close` button" }, { "name": "dark", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, gives the popup calendar dialog a dark background" }, { "name": "dateDisabledFn", "value": { "kind": "expression", "type": "function" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Set to a function reference which returns `true` if the date is disabled, or `false` if the date should be enabled. See documentation for details" }, { "name": "dateFormatOptions", "value": { "kind": "expression", "type": "object" }, "default": "{\"year\":\"numeric\",\"month\":\"long\",\"day\":\"numeric\",\"weekday\":\"long\"}", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Format object for displayed text string that is passed to `Intl.DateTimeFormat`" }, { "name": "dateInfoFn", "value": { "kind": "expression", "type": "function" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Set to a function reference which returns a class (string), or classes (array of strings) to apply to the date cell. See calendar documentation for details. Passed through to the child calendar component" }, { "name": "direction", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Set to the string 'rtl' or 'ltr' to explicitly force the calendar to render in right-to-left or left-ro-right (respectively) mode. Defaults to the resolved locale's directionality" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Places the calendar in a non-interactive disabled state" }, { "name": "dropleft", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, positions the menu to the left of the button" }, { "name": "dropright", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, positions the menu to the right of the button" }, { "name": "dropup", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, positions the menu on the top of the button" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "hideHeader", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When `true`, visually hides the selected date header" }, { "name": "initialDate", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "When a `value` is not specified, sets the initial calendar month date that will be presented to the user. Accepts a value in `YYYY-MM-DD` format or a `Date` object. Defaults to the current date (or min or max if the current date is out of range)" }, { "name": "labelCalendar", "value": { "kind": "expression", "type": "string" }, "default": "\"Calendar\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `role-description` attributes applied to the calendar grid" }, { "name": "labelCloseButton", "value": { "kind": "expression", "type": "string" }, "default": "\"Close\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Content for the optional `Close` button" }, { "name": "labelCurrentMonth", "value": { "kind": "expression", "type": "string" }, "default": "\"Current month\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the `Current Month` navigation button" }, { "name": "labelHelp", "value": { "kind": "expression", "type": "string" }, "default": "\"Use cursor keys to navigate calendar dates\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Help text that appears at the bottom of the calendar grid" }, { "name": "labelNav", "value": { "kind": "expression", "type": "string" }, "default": "\"Calendar navigation\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` attribute on to the calendar navigation button wrapper" }, { "name": "labelNextDecade", "value": { "kind": "expression", "type": "string" }, "default": "\"Next decade\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the optional `Next Decade` navigation button" }, { "name": "labelNextMonth", "value": { "kind": "expression", "type": "string" }, "default": "\"Next month\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the `Next Month` navigation button" }, { "name": "labelNextYear", "value": { "kind": "expression", "type": "string" }, "default": "\"Next year\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the `Next Year` navigation button" }, { "name": "labelNoDateSelected", "value": { "kind": "expression", "type": "string" }, "default": "\"No date selected\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Label to use when no date is currently selected" }, { "name": "labelPrevDecade", "value": { "kind": "expression", "type": "string" }, "default": "\"Previous decade\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the optional `Previous Decade` navigation button" }, { "name": "labelPrevMonth", "value": { "kind": "expression", "type": "string" }, "default": "\"Previous month\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the `Previous Month` navigation button" }, { "name": "labelPrevYear", "value": { "kind": "expression", "type": "string" }, "default": "\"Previous year\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` and `title` attributes on the `Previous Year` navigation button" }, { "name": "labelResetButton", "value": { "kind": "expression", "type": "string" }, "default": "\"Reset\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Content for the optional `Reset` button" }, { "name": "labelSelected", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` attribute set on the calendar grid date button that is selected" }, { "name": "labelToday", "value": { "kind": "expression", "type": "string" }, "default": "\"Today\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Value of the `aria-label` attribute for the calendar grid date button to signify that the date is today's date" }, { "name": "labelTodayButton", "value": { "kind": "expression", "type": "string" }, "default": "\"Select today\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Content for the optional `Select today` button" }, { "name": "locale", "value": { "kind": "expression", "type": "any[]|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Locale (or locales) for the calendar to use. When passing an array of locales, the order of the locales is from most preferred to least preferred" }, { "name": "max", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The maximum date the calendar will show" }, { "name": "menuClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Class (or classes) to apply to to popup menu wrapper" }, { "name": "min", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The minimum date the calendar will show" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "navButtonVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"secondary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Theme color variant to use for the navigation buttons" }, { "name": "noCloseOnSelect", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Disables closing the popup date picker when a date is clicked/selected" }, { "name": "noFlip", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Prevent the menu from auto flipping positions" }, { "name": "noHighlightToday", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Disabled the highlighting of todays date in the calendar" }, { "name": "offset", "value": { "kind": "expression", "type": "number|string" }, "default": "0", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Specify the number of pixels to shift the menu by. Negative values supported" }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Text so show in the form control when no date is selected. Defaults to the `label-no-date-selected` prop value" }, { "name": "popperOpts", "value": { "kind": "expression", "type": "object" }, "default": "{}", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Additional configuration to pass to Popper.js" }, { "name": "readonly", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Places the calendar in an interactive readonly state. Disables updating the v-model, while still allowing date navigation" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, adds the `aria-required=\"true\"` attribute on the component. Required validation needs to be handled by your application" }, { "name": "resetButton", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, shows the optional `reset` button" }, { "name": "resetButtonVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"outline-danger\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Button variant to use for the optional `reset` button" }, { "name": "resetValue", "value": { "kind": "expression", "type": "Date|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "When the optional `reset` button is clicked, the selected date will be set to this value. Default is to clear the selected value" }, { "name": "right", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Align the right edge of the menu with the right of the button" }, { "name": "selectedVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"primary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Theme color variant to use for the selected date button" }, { "name": "showDecadeNav", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When `true`, shows the +/- decade navigation buttons" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "startWeekday", "value": { "kind": "expression", "type": "number|string" }, "default": "0", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Day of week to start the calendar. `0` for Sunday, `1` for Monday, `6` for Saturday, etc." }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "todayButton", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "When set, shows the optional `select today` button" }, { "name": "todayButtonVariant", "value": { "kind": "expression", "type": "string" }, "default": "\"outline-primary\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Button variant to use for the optional `select today` button" }, { "name": "todayVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Theme color variant to use for highlighting todays date button. Defaults to the `selectedVariant` prop" }, { "name": "valueAsDate", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "type": "boolean", "description": "Returns a `Date` object for the v-model instead of a `YYYY-MM-DD` string" }, { "name": "weekdayHeaderFormat", "value": { "kind": "expression", "type": "string" }, "default": "\"short\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Format to use for the calendar weekday headings. Possible values are `long`, `short` (default), or `narrow`" } ], "vue-model": { "prop": "value", "event": "input" }, "events": [ { "name": "context", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "`b-calendar` context event. Emitted when the user changes the active date via date navigation buttons or cursor control", "arguments": [ { "name": "context", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The `b-calendar` context object. See the `b-calendar` documentaion for details", "type": "object" } ] }, { "name": "hidden", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Emitted when the picker popup has hidden" }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Emitted when updating the v-model", "arguments": [ { "name": "date", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Either a string in the format of `YYYY-MM-DD` or a `Date` object (if `value-as-date` prop is `true`)", "type": "string|Date" } ] }, { "name": "shown", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Emitted when the picker popup has shown" } ], "slots": [ { "name": "button-content", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Content to place in the datepicker's icon button", "vue-properties": [ { "name": "isHovered", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "`true` if the component is hovered", "type": "boolean" }, { "name": "hasFocus", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "`true` if the datepicker icon button has focus", "type": "boolean" }, { "name": "state", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The value of the `state` prop. `true` (valid), `false` (invalid), or `null`", "type": "boolean" }, { "name": "open", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "The visibility state of the popup. `true` if the popup is visible and `false` if not", "type": "boolean" } ] }, { "name": "nav-next-decade", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the next decade navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-next-month", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the next month navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-next-year", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the next year navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-prev-decade", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the previous decade navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-prev-month", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the previous month navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-prev-year", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the previous year navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] }, { "name": "nav-this-month", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Used to place custom content in the this month/day navigation button", "vue-properties": [ { "name": "isRTL", "doc-url": "https:/bootstrap-vue.org/docs/components/form-datepicker/", "description": "Will be `true` if the date navigation bar is rendered right to left", "type": "boolean" } ] } ] }, { "name": "BFormFile", "source": { "module": "bootstrap-vue", "symbol": "BFormFile" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Customized, cross-browser consistent, file input control that supports single file, multiple files, and directory upload.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "value", "value": { "kind": "expression", "type": "any[]|File" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "The current value of the file input. Will be a single `File` object or an array of `File` objects (if `multiple` or `directory` is set). Can be set to `null`, or an empty array to reset the file input" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "plain", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "Render the form control in plain mode, rather than custom styled mode" }, { "name": "accept", "value": { "kind": "expression", "type": "string" }, "default": "\"\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Value to set on the file input's `accept` attribute" }, { "name": "browseText", "value": { "kind": "expression", "type": "string" }, "default": "\"Browse\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Text content for the file browse button" }, { "name": "capture", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "When set, will instruction the browser to use the devices camera (if supported)" }, { "name": "directory", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "Enable `directory` mode (on browsers that support it)" }, { "name": "dropPlaceholder", "value": { "kind": "expression", "type": "string" }, "default": "\"Drop files here\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Text to display as the placeholder when files are being dragged and it's allowed to drop them" }, { "name": "fileNameFormatter", "value": { "kind": "expression", "type": "function" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Method to format the file names for display. Refer to the docs for details" }, { "name": "multiple", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "When set, will allow multiple files to be selected. `v-model` will be an array" }, { "name": "noDrop", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "Disable drag and drop mode" }, { "name": "noDropPlaceholder", "value": { "kind": "expression", "type": "string" }, "default": "\"Not allowed\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Text to display as the placeholder when files are being dragged and it isn't allowed to drop them" }, { "name": "noTraverse", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "Wether to returns files as a flat array when in `directory` mode" }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "default": "\"No file chosen\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Sets the `placeholder` attribute value on the form control" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" } ], "vue-model": { "prop": "value", "event": "input" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Original change event of the input", "arguments": [ { "name": "event", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Native change event object", "type": "Event" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Updates the `v-model` value (see docs for more details)", "arguments": [ { "name": "file", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Will be a single File object in single mode or an array of File objects in multiple mode", "type": "File|any[]" } ] } ], "slots": [ { "name": "drop-placeholder", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Placeholder content when files are about to be dropped. Defaults to value of `drop-placeholder` prop", "vue-properties": [ { "name": "allowed", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Wether its currently allowed to drop files", "type": "boolean" } ] }, { "name": "file-name", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Scoped slot for formatting the file names", "vue-properties": [ { "name": "files", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Flat array of `File` objects", "type": "any[]" }, { "name": "filesTraversed", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Array of arrays of `File` objects when in `directory` mode", "type": "any[]" }, { "name": "names", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Flat array of file names (strings)", "type": "any[]" } ] }, { "name": "placeholder", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Placeholder content, when no files selected. Defaults to `placeholder` prop value" } ] }, { "name": "BFile", "source": { "module": "bootstrap-vue", "symbol": "BFile" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Customized, cross-browser consistent, file input control that supports single file, multiple files, and directory upload.\n\n*Alias for BFormFile*", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "value", "value": { "kind": "expression", "type": "any[]|File" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "The current value of the file input. Will be a single `File` object or an array of `File` objects (if `multiple` or `directory` is set). Can be set to `null`, or an empty array to reset the file input" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "plain", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "Render the form control in plain mode, rather than custom styled mode" }, { "name": "accept", "value": { "kind": "expression", "type": "string" }, "default": "\"\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Value to set on the file input's `accept` attribute" }, { "name": "browseText", "value": { "kind": "expression", "type": "string" }, "default": "\"Browse\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Text content for the file browse button" }, { "name": "capture", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "When set, will instruction the browser to use the devices camera (if supported)" }, { "name": "directory", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "Enable `directory` mode (on browsers that support it)" }, { "name": "dropPlaceholder", "value": { "kind": "expression", "type": "string" }, "default": "\"Drop files here\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Text to display as the placeholder when files are being dragged and it's allowed to drop them" }, { "name": "fileNameFormatter", "value": { "kind": "expression", "type": "function" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Method to format the file names for display. Refer to the docs for details" }, { "name": "multiple", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "When set, will allow multiple files to be selected. `v-model` will be an array" }, { "name": "noDrop", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "Disable drag and drop mode" }, { "name": "noDropPlaceholder", "value": { "kind": "expression", "type": "string" }, "default": "\"Not allowed\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Text to display as the placeholder when files are being dragged and it isn't allowed to drop them" }, { "name": "noTraverse", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "type": "boolean", "description": "Wether to returns files as a flat array when in `directory` mode" }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "default": "\"No file chosen\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Sets the `placeholder` attribute value on the form control" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" } ], "vue-model": { "prop": "value", "event": "input" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Original change event of the input", "arguments": [ { "name": "event", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Native change event object", "type": "Event" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Updates the `v-model` value (see docs for more details)", "arguments": [ { "name": "file", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Will be a single File object in single mode or an array of File objects in multiple mode", "type": "File|any[]" } ] } ], "slots": [ { "name": "drop-placeholder", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Placeholder content when files are about to be dropped. Defaults to value of `drop-placeholder` prop", "vue-properties": [ { "name": "allowed", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Wether its currently allowed to drop files", "type": "boolean" } ] }, { "name": "file-name", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Scoped slot for formatting the file names", "vue-properties": [ { "name": "files", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Flat array of `File` objects", "type": "any[]" }, { "name": "filesTraversed", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Array of arrays of `File` objects when in `directory` mode", "type": "any[]" }, { "name": "names", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Flat array of file names (strings)", "type": "any[]" } ] }, { "name": "placeholder", "doc-url": "https:/bootstrap-vue.org/docs/components/form-file/", "description": "Placeholder content, when no files selected. Defaults to `placeholder` prop value" } ] }, { "name": "BFormGroup", "source": { "module": "bootstrap-vue", "symbol": "BFormGroup" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Easily add some structure to forms. Its purpose is to pair form controls with a legend or label, and to provide help text and invalid/valid feedback text, as well as visual (color) contextual state feedback.", "attributes": [ { "name": "contentCols", "value": { "kind": "expression", "type": "boolean|number|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Number of columns for the content width 'xs' screens and up" }, { "name": "contentColsLg", "value": { "kind": "expression", "type": "boolean|number|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Number of columns for the content width 'lg' screens and up" }, { "name": "contentColsMd", "value": { "kind": "expression", "type": "boolean|number|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Number of columns for the content width 'md' screens and up" }, { "name": "contentColsSm", "value": { "kind": "expression", "type": "boolean|number|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Number of columns for the content width 'sm' screens and up" }, { "name": "contentColsXl", "value": { "kind": "expression", "type": "boolean|number|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Number of columns for the content width 'xl' screens and up" }, { "name": "description", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Text to place in the help text area of the form group" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "type": "boolean", "description": "Disabled the fieldset element, which in turn disables the form controls (on browsers that support disabled fieldsets). Has no effect if `label-for` is set" }, { "name": "feedbackAriaLive", "value": { "kind": "expression", "type": "string" }, "default": "\"assertive\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Value to use for the `aria-live` attribute on the feedback text" }, { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "invalidFeedback", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Text to show when the form group has an invalid state" }, { "name": "label", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Text to place in the label/legend of the form group" }, { "name": "labelAlign", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Text alignment 'left', 'center', 'right' for the label 'xs' screens and up" }, { "name": "labelAlignLg", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Text alignment 'left', 'center', 'right' for the label 'lg' screens and up" }, { "name": "labelAlignMd", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Text alignment 'left', 'center', 'right' for the label 'md' screens and up" }, { "name": "labelAlignSm", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Text alignment 'left', 'center', 'right' for the label 'sm' screens and up" }, { "name": "labelAlignXl", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Text alignment 'left', 'center', 'right' for the label 'xl' screens and up" }, { "name": "labelClass", "value": { "kind": "expression", "type": "any[]|object|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "CSS class (or classes) to add to the label/legend element" }, { "name": "labelCols", "value": { "kind": "expression", "type": "boolean|number|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Number of columns for the label width 'xs' screens and up" }, { "name": "labelColsLg", "value": { "kind": "expression", "type": "boolean|number|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Number of columns for the label width 'lg' screens and up" }, { "name": "labelColsMd", "value": { "kind": "expression", "type": "boolean|number|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Number of columns for the label width 'md' screens and up" }, { "name": "labelColsSm", "value": { "kind": "expression", "type": "boolean|number|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Number of columns for the label width 'sm' screens and up" }, { "name": "labelColsXl", "value": { "kind": "expression", "type": "boolean|number|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Number of columns for the label width 'xl' screens and up" }, { "name": "labelFor", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Set to the ID of the singular form control in the form group. Do not set a value if there is more than one form control in the group" }, { "name": "labelSize", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Sets the text size of the label: 'sm', 'md' (default) or 'lg'. Use this prop to have the label size match the form control size" }, { "name": "labelSrOnly", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "type": "boolean", "description": "Visually hides the label content, but makes it available to screen reader users" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "type": "boolean", "description": "Controls the validation state of the feedback. `true` force shows valid-feedback, `false` force shows invalid feedback, `null` does not force show the feedback" }, { "name": "tooltip", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "type": "boolean", "description": "Renders the feedback text in a rudimentary tooltip style" }, { "name": "validFeedback", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Text to show when the form group has a valid state" }, { "name": "validated", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "type": "boolean", "description": "When set, adds the Bootstrap validation trigger class 'was-validated' on the component" } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Content to place in the form group", "vue-properties": [ { "name": "ariaDescribedby", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "The value for the `aria-describedby` attribute for input elements in the form group. Will be auto-assigned when `label-for` prop is given", "type": "string" }, { "name": "id", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "The ID of the form group. Will equal `id` prop, when provided", "type": "string" }, { "name": "descriptionId", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "The ID of the description element. Will be `null` when no description content given", "type": "string" }, { "name": "labelId", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "The ID of the label element. Will be `null` when no description content given", "type": "string" } ] }, { "name": "description", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Content to place in the description area. Overrides the `description` prop" }, { "name": "invalid-feedback", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Content to place in the invalid feedback area. Overrides the `invalid-feedback` prop" }, { "name": "label", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Content to place inside the label element. Overrides the `label` prop" }, { "name": "valid-feedback", "doc-url": "https:/bootstrap-vue.org/docs/components/form-group/", "description": "Content to place in the valid feedback area. Overrides the `valid-feedback` prop" } ] }, { "name": "BFormInput", "source": { "module": "bootstrap-vue", "symbol": "BFormInput" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Create various type inputs such as: text, password, number, url, email, search, range, date and more.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "value", "value": { "kind": "expression", "type": "number|string" }, "default": "\"\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "The current value of the input. Result will always be a string, except when the `number` prop is used" }, { "name": "ariaInvalid", "value": { "kind": "expression", "type": "boolean|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Sets the 'aria-invalid' attribute with the specified value" }, { "name": "autocomplete", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Sets the 'autocomplete' attribute value on the form control" }, { "name": "debounce", "value": { "kind": "expression", "type": "number|string" }, "default": "0", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "When set to a number of milliseconds greater than zero, will debounce the user input. Has no effect if prop 'lazy' is set" }, { "name": "formatter", "value": { "kind": "expression", "type": "function" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Reference to a function for formatting the input" }, { "name": "lazy", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "When set, updates the v-model on 'change'/'blur' events instead of 'input'. Emulates the Vue '.lazy' v-model modifier" }, { "name": "lazyFormatter", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "When set, the input is formatted on blur instead of each keystroke (if there is a formatter specified)" }, { "name": "number", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "When set attempts to convert the input value to a native number. Emulates the Vue '.number' v-model modifier" }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Sets the `placeholder` attribute value on the form control" }, { "name": "plaintext", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "Set the form control as readonly and renders the control to look like plain text (no borders)" }, { "name": "readonly", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "Sets the `readonly` attribute on the form control" }, { "name": "trim", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "When set, trims any leading and trailing white space from the input value. Emulates the Vue '.trim' v-model modifier" }, { "name": "list", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "The ID of the associated datalist element or component" }, { "name": "max", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Value to set in the 'max' attribute on the input. Used by number-like inputs" }, { "name": "min", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Value to set in the 'min' attribute on the input. Used by number-like inputs" }, { "name": "noWheel", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "For number-like inputs, disables the mouse wheel from incrementing or decrementing the value" }, { "name": "step", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Value to set in the 'step' attribute on the input. Used by number-like inputs" }, { "name": "type", "value": { "kind": "expression", "type": "string" }, "default": "\"text\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "The type of input to render. See the docs for supported types" } ], "vue-model": { "prop": "value", "event": "update" }, "events": [ { "name": "blur", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Emitted after the input looses focus", "arguments": [ { "name": "event", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Native blur event (before any formatting)", "type": "FocusEvent" } ] }, { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Change event triggered by user interaction. Emitted after any formatting (not including 'trim' or 'number' props) and after the v-model is updated", "arguments": [ { "name": "value", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Current value of input", "type": "string|number" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Input event triggered by user interaction. Emitted after any formatting (not including 'trim' or 'number' props) and after the v-model is updated", "arguments": [ { "name": "value", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Current value of input", "type": "string|number" } ] }, { "name": "update", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Emitted to update the v-model", "arguments": [ { "name": "value", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Value of input, after any formatting. Not emitted if the value does not change", "type": "string|number" } ] } ] }, { "name": "BInput", "source": { "module": "bootstrap-vue", "symbol": "BInput" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Create various type inputs such as: text, password, number, url, email, search, range, date and more.\n\n*Alias for BFormInput*", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "value", "value": { "kind": "expression", "type": "number|string" }, "default": "\"\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "The current value of the input. Result will always be a string, except when the `number` prop is used" }, { "name": "ariaInvalid", "value": { "kind": "expression", "type": "boolean|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Sets the 'aria-invalid' attribute with the specified value" }, { "name": "autocomplete", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Sets the 'autocomplete' attribute value on the form control" }, { "name": "debounce", "value": { "kind": "expression", "type": "number|string" }, "default": "0", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "When set to a number of milliseconds greater than zero, will debounce the user input. Has no effect if prop 'lazy' is set" }, { "name": "formatter", "value": { "kind": "expression", "type": "function" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Reference to a function for formatting the input" }, { "name": "lazy", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "When set, updates the v-model on 'change'/'blur' events instead of 'input'. Emulates the Vue '.lazy' v-model modifier" }, { "name": "lazyFormatter", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "When set, the input is formatted on blur instead of each keystroke (if there is a formatter specified)" }, { "name": "number", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "When set attempts to convert the input value to a native number. Emulates the Vue '.number' v-model modifier" }, { "name": "placeholder", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Sets the `placeholder` attribute value on the form control" }, { "name": "plaintext", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "Set the form control as readonly and renders the control to look like plain text (no borders)" }, { "name": "readonly", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "Sets the `readonly` attribute on the form control" }, { "name": "trim", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "When set, trims any leading and trailing white space from the input value. Emulates the Vue '.trim' v-model modifier" }, { "name": "list", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "The ID of the associated datalist element or component" }, { "name": "max", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Value to set in the 'max' attribute on the input. Used by number-like inputs" }, { "name": "min", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Value to set in the 'min' attribute on the input. Used by number-like inputs" }, { "name": "noWheel", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "type": "boolean", "description": "For number-like inputs, disables the mouse wheel from incrementing or decrementing the value" }, { "name": "step", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Value to set in the 'step' attribute on the input. Used by number-like inputs" }, { "name": "type", "value": { "kind": "expression", "type": "string" }, "default": "\"text\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "The type of input to render. See the docs for supported types" } ], "vue-model": { "prop": "value", "event": "update" }, "events": [ { "name": "blur", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Emitted after the input looses focus", "arguments": [ { "name": "event", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Native blur event (before any formatting)", "type": "FocusEvent" } ] }, { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Change event triggered by user interaction. Emitted after any formatting (not including 'trim' or 'number' props) and after the v-model is updated", "arguments": [ { "name": "value", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Current value of input", "type": "string|number" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Input event triggered by user interaction. Emitted after any formatting (not including 'trim' or 'number' props) and after the v-model is updated", "arguments": [ { "name": "value", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Current value of input", "type": "string|number" } ] }, { "name": "update", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Emitted to update the v-model", "arguments": [ { "name": "value", "doc-url": "https:/bootstrap-vue.org/docs/components/form-input/", "description": "Value of input, after any formatting. Not emitted if the value does not change", "type": "string|number" } ] } ] }, { "name": "BFormRadioGroup", "source": { "module": "bootstrap-vue", "symbol": "BFormRadioGroup" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Cross browser consistent radio inputs and radio groups, using Bootstrap's custom radio input to replace the browser default radio input.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "checked", "value": { "kind": "expression", "type": "any" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "The current value of the checked radio in the group" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "disabledField", "value": { "kind": "expression", "type": "string" }, "default": "\"disabled\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Field name in the `options` array that should be used for the disabled state" }, { "name": "htmlField", "value": { "kind": "expression", "type": "string" }, "default": "\"html\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Field name in the `options` array that should be used for the html label instead of text field" }, { "name": "options", "value": { "kind": "expression", "type": "any[]|object" }, "default": "[]", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Array of items to render in the component" }, { "name": "textField", "value": { "kind": "expression", "type": "string" }, "default": "\"text\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Field name in the `options` array that should be used for the text label" }, { "name": "valueField", "value": { "kind": "expression", "type": "string" }, "default": "\"value\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Field name in the `options` array that should be used for the value" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "plain", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "Render the form control in plain mode, rather than custom styled mode" }, { "name": "ariaInvalid", "value": { "kind": "expression", "type": "boolean|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Sets the 'aria-invalid' attribute value on the wrapper element. When not provided, the 'state' prop will control the attribute" }, { "name": "buttonVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Specifies the Bootstrap contextual color theme variant the apply to the button style radios" }, { "name": "buttons", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set, renderes the radios in this group with button styling" }, { "name": "stacked", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set, renders the radio group in stacked mode" }, { "name": "validated", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set, adds the Bootstrap class 'was-validated' to the group wrapper" } ], "vue-model": { "prop": "checked", "event": "input" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Emitted when selected value is changed due to user interaction", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Current selected Value of radio group", "type": "boolean|string|number|object" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Emitted when the selected value is changed", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Current selected Value of radio group", "type": "boolean|string|number|object" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Content (form radios) to place in the form radio group" }, { "name": "first", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Slot to place b-form-radio's so that they appear before radios generated from options prop" } ] }, { "name": "BRadioGroup", "source": { "module": "bootstrap-vue", "symbol": "BRadioGroup" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Cross browser consistent radio inputs and radio groups, using Bootstrap's custom radio input to replace the browser default radio input.\n\n*Alias for BFormRadioGroup*", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "checked", "value": { "kind": "expression", "type": "any" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "The current value of the checked radio in the group" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "disabledField", "value": { "kind": "expression", "type": "string" }, "default": "\"disabled\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Field name in the `options` array that should be used for the disabled state" }, { "name": "htmlField", "value": { "kind": "expression", "type": "string" }, "default": "\"html\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Field name in the `options` array that should be used for the html label instead of text field" }, { "name": "options", "value": { "kind": "expression", "type": "any[]|object" }, "default": "[]", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Array of items to render in the component" }, { "name": "textField", "value": { "kind": "expression", "type": "string" }, "default": "\"text\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Field name in the `options` array that should be used for the text label" }, { "name": "valueField", "value": { "kind": "expression", "type": "string" }, "default": "\"value\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Field name in the `options` array that should be used for the value" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "plain", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "Render the form control in plain mode, rather than custom styled mode" }, { "name": "ariaInvalid", "value": { "kind": "expression", "type": "boolean|string" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Sets the 'aria-invalid' attribute value on the wrapper element. When not provided, the 'state' prop will control the attribute" }, { "name": "buttonVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Specifies the Bootstrap contextual color theme variant the apply to the button style radios" }, { "name": "buttons", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set, renderes the radios in this group with button styling" }, { "name": "stacked", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set, renders the radio group in stacked mode" }, { "name": "validated", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set, adds the Bootstrap class 'was-validated' to the group wrapper" } ], "vue-model": { "prop": "checked", "event": "input" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Emitted when selected value is changed due to user interaction", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Current selected Value of radio group", "type": "boolean|string|number|object" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Emitted when the selected value is changed", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Current selected Value of radio group", "type": "boolean|string|number|object" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Content (form radios) to place in the form radio group" }, { "name": "first", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Slot to place b-form-radio's so that they appear before radios generated from options prop" } ] }, { "name": "BFormRadio", "source": { "module": "bootstrap-vue", "symbol": "BFormRadio" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Cross browser consistent radio inputs and radio groups, using Bootstrap's custom radio input to replace the browser default radio input.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "checked", "value": { "kind": "expression", "type": "any" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "The current value of the radio(s)" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "plain", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "Render the form control in plain mode, rather than custom styled mode" }, { "name": "ariaLabel", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Sets the value of `aria-label` attribute on the rendered element" }, { "name": "ariaLabelledby", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "The ID of the element that provides a label for this component. Used as the value for the `aria-labelledby` attribute" }, { "name": "button", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set, renders the radio with the appearance of a button" }, { "name": "buttonVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Applies on of Bootstrap's theme colors when in 'button' mode" }, { "name": "inline", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set, renders the radio as an inline element rather than as a 100% width block" }, { "name": "value", "value": { "kind": "expression", "type": "any" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Value returned when this radio is checked" } ], "vue-model": { "prop": "checked", "event": "input" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Emitted when selected value is changed due to user interaction", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Current selected Value of radio group", "type": "boolean|string|number|object" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Emitted when the selected value is changed", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Current selected Value of radio group", "type": "boolean|string|number|object" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Content to place in the form radio" } ] }, { "name": "BRadio", "source": { "module": "bootstrap-vue", "symbol": "BRadio" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Cross browser consistent radio inputs and radio groups, using Bootstrap's custom radio input to replace the browser default radio input.\n\n*Alias for BFormRadio*", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "checked", "value": { "kind": "expression", "type": "any" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "The current value of the radio(s)" }, { "name": "autofocus", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set to `true`, attempts to auto-focus the control when it is mounted, or re-activated when in a keep-alive. Does not set the `autofocus` attribute on the control" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "required", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "Adds the `required` attribute to the form control" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "state", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "Controls the validation state appearance of the component. `true` for valid, `false` for invalid, or `null` for no validation state" }, { "name": "plain", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "Render the form control in plain mode, rather than custom styled mode" }, { "name": "ariaLabel", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Sets the value of `aria-label` attribute on the rendered element" }, { "name": "ariaLabelledby", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "The ID of the element that provides a label for this component. Used as the value for the `aria-labelledby` attribute" }, { "name": "button", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set, renders the radio with the appearance of a button" }, { "name": "buttonVariant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Applies on of Bootstrap's theme colors when in 'button' mode" }, { "name": "inline", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "type": "boolean", "description": "When set, renders the radio as an inline element rather than as a 100% width block" }, { "name": "value", "value": { "kind": "expression", "type": "any" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Value returned when this radio is checked" } ], "vue-model": { "prop": "checked", "event": "input" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Emitted when selected value is changed due to user interaction", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Current selected Value of radio group", "type": "boolean|string|number|object" } ] }, { "name": "input", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Emitted when the selected value is changed", "arguments": [ { "name": "checked", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Current selected Value of radio group", "type": "boolean|string|number|object" } ] } ], "slots": [ { "name": "default", "doc-url": "https:/bootstrap-vue.org/docs/components/form-radio/", "description": "Content to place in the form radio" } ] }, { "name": "BFormRating", "source": { "module": "bootstrap-vue", "symbol": "BFormRating" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "BootstrapVue custom star rating form control for ratings entry or aggregated display.", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "value", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Rating value. This is the v-model" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "CSS color to use instead of variant. Accepts either a HEX or RGB/RGBA string" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "iconClear", "value": { "kind": "expression", "type": "string" }, "default": "\"x\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Bootstrap Icon name to use for the clear button. Note icon must be registered in your component or globally" }, { "name": "iconEmpty", "value": { "kind": "expression", "type": "string" }, "default": "\"star\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Bootstrap Icon name to use for the empty icon. Note icon must be registered in your component or globally" }, { "name": "iconFull", "value": { "kind": "expression", "type": "string" }, "default": "\"star-fill\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Bootstrap Icon name to use for the full icon. Note icon must be registered in your component or globally" }, { "name": "iconHalf", "value": { "kind": "expression", "type": "string" }, "default": "\"star-half\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Bootstrap Icon name to use for the half icon. Note icon must be registered in your component or globally" }, { "name": "inline", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When `true` renders as an inline element rather than a blick (100% width) element" }, { "name": "locale", "value": { "kind": "expression", "type": "any[]|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Locale (or locales) to use when showing the value when prop `show-value` is set. Defaults to the browser default locale" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "noBorder", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When `true` disables the default border" }, { "name": "precision", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Specify the number of digits after the decimal to show. Defaults to to no defined precision" }, { "name": "readonly", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When `true` makes the rating readonly. When `true`, fractional ratings values are allowed (half icons will be shown)" }, { "name": "showClear", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When `true` shows the clear value icon button" }, { "name": "showValue", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When `true` shows the current rating value in the control" }, { "name": "showValueMax", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When set to `true` and prop `show-value` is `true`, includes the maximum star rating possible in the formatted value" }, { "name": "stars", "value": { "kind": "expression", "type": "number|string" }, "default": "5", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "The number of stars to show. Minimum value is `3`, default is `5`" }, { "name": "variant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "vue-model": { "prop": "value", "event": "change" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Emitted to update the v-model", "arguments": [ { "name": "value", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Current ratings value" } ] } ], "slots": [ { "name": "icon-clear", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Content for the optional clear button" }, { "name": "icon-empty", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Content for the empty icon", "vue-properties": [ { "name": "variant", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `variant` prop, or `null` if disabled", "type": "string" }, { "name": "disabled", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `disabled` prop", "type": "boolean" }, { "name": "readonly", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `readonly` prop", "type": "boolean" } ] }, { "name": "icon-full", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Content for the full icon", "vue-properties": [ { "name": "variant", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `variant` prop, or `null` if disabled", "type": "string" }, { "name": "disabled", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `disabled` prop", "type": "boolean" }, { "name": "readonly", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `readonly` prop", "type": "boolean" } ] }, { "name": "icon-half", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Content for the half icon", "vue-properties": [ { "name": "variant", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `variant` prop, or `null` if disabled", "type": "string" }, { "name": "disabled", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `disabled` prop", "type": "boolean" }, { "name": "readonly", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `readonly` prop", "type": "boolean" } ] } ] }, { "name": "BRating", "source": { "module": "bootstrap-vue", "symbol": "BRating" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "BootstrapVue custom star rating form control for ratings entry or aggregated display.\n\n*Alias for BFormRating*", "attributes": [ { "name": "id", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Used to set the `id` attribute on the rendered content, and used as the base to generate any additional element IDs as needed" }, { "name": "value", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Rating value. This is the v-model" }, { "name": "size", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Set the size of the component's appearance. 'sm', 'md' (default), or 'lg'" }, { "name": "color", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "CSS color to use instead of variant. Accepts either a HEX or RGB/RGBA string" }, { "name": "disabled", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When set to `true`, disables the component's functionality and places it in a disabled state" }, { "name": "form", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "ID of the form that the form control belongs to. Sets the `form` attribute on the control" }, { "name": "iconClear", "value": { "kind": "expression", "type": "string" }, "default": "\"x\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Bootstrap Icon name to use for the clear button. Note icon must be registered in your component or globally" }, { "name": "iconEmpty", "value": { "kind": "expression", "type": "string" }, "default": "\"star\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Bootstrap Icon name to use for the empty icon. Note icon must be registered in your component or globally" }, { "name": "iconFull", "value": { "kind": "expression", "type": "string" }, "default": "\"star-fill\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Bootstrap Icon name to use for the full icon. Note icon must be registered in your component or globally" }, { "name": "iconHalf", "value": { "kind": "expression", "type": "string" }, "default": "\"star-half\"", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Bootstrap Icon name to use for the half icon. Note icon must be registered in your component or globally" }, { "name": "inline", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When `true` renders as an inline element rather than a blick (100% width) element" }, { "name": "locale", "value": { "kind": "expression", "type": "any[]|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Locale (or locales) to use when showing the value when prop `show-value` is set. Defaults to the browser default locale" }, { "name": "name", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Sets the value of the `name` attribute on the form control" }, { "name": "noBorder", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When `true` disables the default border" }, { "name": "precision", "value": { "kind": "expression", "type": "number|string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Specify the number of digits after the decimal to show. Defaults to to no defined precision" }, { "name": "readonly", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When `true` makes the rating readonly. When `true`, fractional ratings values are allowed (half icons will be shown)" }, { "name": "showClear", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When `true` shows the clear value icon button" }, { "name": "showValue", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When `true` shows the current rating value in the control" }, { "name": "showValueMax", "value": { "kind": "expression", "type": "boolean" }, "default": "false", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "type": "boolean", "description": "When set to `true` and prop `show-value` is `true`, includes the maximum star rating possible in the formatted value" }, { "name": "stars", "value": { "kind": "expression", "type": "number|string" }, "default": "5", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "The number of stars to show. Minimum value is `3`, default is `5`" }, { "name": "variant", "value": { "kind": "expression", "type": "string" }, "default": "null", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Applies one of the Bootstrap theme color variants to the component" } ], "vue-model": { "prop": "value", "event": "change" }, "events": [ { "name": "change", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Emitted to update the v-model", "arguments": [ { "name": "value", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Current ratings value" } ] } ], "slots": [ { "name": "icon-clear", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Content for the optional clear button" }, { "name": "icon-empty", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Content for the empty icon", "vue-properties": [ { "name": "variant", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `variant` prop, or `null` if disabled", "type": "string" }, { "name": "disabled", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `disabled` prop", "type": "boolean" }, { "name": "readonly", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `readonly` prop", "type": "boolean" } ] }, { "name": "icon-full", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Content for the full icon", "vue-properties": [ { "name": "variant", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `variant` prop, or `null` if disabled", "type": "string" }, { "name": "disabled", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `disabled` prop", "type": "boolean" }, { "name": "readonly", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `readonly` prop", "type": "boolean" } ] }, { "name": "icon-half", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Content for the half icon", "vue-properties": [ { "name": "variant", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `variant` prop, or `null` if disabled", "type": "string" }, { "name": "disabled", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `disabled` prop", "type": "boolean" }, { "name": "readonly", "doc-url": "https:/bootstrap-vue.org/docs/components/form-rating/", "description": "Value of the `readonly` prop", "type": "boolean" } ] } ] }, { "name": "BFormSelect", "source": { "module": "bootstrap-vue", "symbol": "BFormSelect" }, "doc-url": "https:/bootstrap-vue.org/docs/components/form-select/", "description": "Custom component using cross-browser custom styles. Optionally generate