bootstrap-vue
Version:
BootstrapVue, with more than 85 custom components, over 45 plugins, several custom directives, and over 300 icons, provides one of the most comprehensive implementations of Bootstrap v4 components and grid system for Vue.js. With extensive and automated W
178 lines (177 loc) • 6.2 kB
JSON
{
"name": "@bootstrap-vue/carousel",
"version": "1.0.0",
"meta": {
"title": "Carousel",
"description": "The <b-carousel> 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.",
"components": [
{
"component": "BCarousel",
"description": "The <b-carousel> component is a slideshow for cycling through a series of slide content",
"props": [
{
"prop": "fade",
"description": "When set, changes the slide animation to a crossfade instead of a sliding effect"
},
{
"prop": "noAnimation",
"description": "When set, disables animation when transitioning between slides"
},
{
"prop": "indicators",
"description": "Enable the indicator buttons for jumping to specific slides"
},
{
"prop": "controls",
"description": "Enable the previous and next controls"
},
{
"prop": "noWrap",
"version": "2.0.0",
"description": "Do not restart the slide show when then end is reached"
},
{
"prop": "noTouch",
"description": "Disable controlling the slides via touch swipes"
},
{
"prop": "noHoverPause",
"description": "When set, disables the pausing of the slide show when the current slide is hovered"
},
{
"prop": "interval",
"description": "Set the delay time (in milliseconds) between slides"
},
{
"prop": "imgWidth",
"description": "Set the default image 'width' attribute for all b-tab children"
},
{
"prop": "imgHeight",
"description": "Set the default image 'height' attribute for all b-tab children"
},
{
"prop": "value",
"description": "The currently active slide (zero-indexed)"
},
{
"prop": "labelPrev",
"settings": true,
"description": "Sets the 'aria-label' value for the previous slide control"
},
{
"prop": "labelNext",
"settings": true,
"description": "Sets the 'aria-label' value for the next slide control"
},
{
"prop": "labelGotoSlide",
"settings": true,
"description": "Sets the prefix for the 'aria-label' on the slide indicator controls. Will be suffixed with the slide number (1 indexed)"
},
{
"prop": "labelIndicators",
"settings": true,
"description": "Sets the 'aria-label' on the indicator controls wrapper"
},
{
"prop": "background",
"description": "Set the CSS color of the carousel's background"
}
],
"events": [
{
"event": "sliding-start",
"description": "Emitted when transitioning to a new slide has started.",
"args": [
{
"arg": "slide",
"type": "Number",
"description": "Slide number that is being slid to."
}
]
},
{
"event": "sliding-end",
"description": "Emitted when transitioning to a new slide has ended.",
"args": [
{
"arg": "slide",
"type": "Number",
"description": "Slide number that was slid to."
}
]
}
]
},
{
"component": "BCarouselSlide",
"description": "The <b-carousel-slide> component is a slide to be placed in the <b-carousel>",
"props": [
{
"prop": "imgSrc",
"description": "Sets the URL of the image"
},
{
"prop": "imgAlt",
"description": "Sets the value of the 'alt' attribute on the image"
},
{
"prop": "imgWidth",
"description": "Set the default image 'width' attribute for all b-tab children"
},
{
"prop": "imgHeight",
"description": "Set the default image 'height' attribute for all b-tab children"
},
{
"prop": "imgBlank",
"description": "If set, will render a blank image instead of the img-src"
},
{
"prop": "imgBlankColor",
"description": "Set the CSS color to use as the fill of the blank image"
},
{
"prop": "contentTag",
"description": "Specify the HTML tag to render instead of the default tag for the content wrapper"
},
{
"prop": "captionTag",
"description": "Specify the HTML tag to render instead of the default tag for the caption wrapper"
},
{
"prop": "contentVisibleUp",
"description": "Specify the breakpoint that the textual content will start to be shown. Leave at default to always show the textual content"
},
{
"prop": "caption",
"description": "Text content to place in the caption"
},
{
"prop": "captionHtml",
"description": "HTML string content to place in the caption. Use with caution"
},
{
"prop": "text",
"description": "Text content to place in the text of the slide"
},
{
"prop": "textHtml",
"description": "HTML string content to place in the text of the slide. Use with caution"
},
{
"prop": "background",
"description": "CSS color to use as the slide's background color"
}
],
"slots": [
{
"name": "img",
"description": "Slot for img element or image component"
}
]
}
]
}
}