diff --git a/src/components/carousel/README.md b/src/components/carousel/README.md index 14973f77476..493451bb682 100644 --- a/src/components/carousel/README.md +++ b/src/components/carousel/README.md @@ -136,6 +136,36 @@ Set the prop `indicators` to show the slide indicator buttons. Both indicators and controls can be set at the same time or independently. +## Carousel slide content + +`b-carousel-slide` provides several props and slots for placing content in the slide. + +### Props + +- `caption` Text to use as the main title on the slide (placed inside the inner element which has + the class `carousel-caption`) +- `text` Textual placed under the title (placed inside the inner element which has the class + `carousel-caption`) +- `img-src` URL of image to be placed into the background of the slide +- `caption-html` Alternate prop to the `caption` prop, which supports HTML strings +- `html` Alternate prop to the `text` prop, which supports HTML strings + +
+ Warning: Be cautious of using the caption-html and html
+ props to display user supplied content, as it may make your application vulnerable to
+
+ XSS attacks, if you do not first
+ sanitize the
+ user supplied string.
+