Skip to content

Commit 88919a5

Browse files
authored
docs(carousel): document the content-visible-up property (#3658)
1 parent e5eb9fc commit 88919a5

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/components/carousel/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,13 @@ Set the `<b-carousel>` `no-animation` prop to `true` to disable slide animation.
209209
<!-- b-carousel-no-animation.vue -->
210210
```
211211

212+
## Hide slide text content on small screens
213+
214+
On smaller screens you may want to hide the captions and headings. You can do so via the
215+
`content-visible-up` prop of `<b-carousel-slide>`. The prop accepts a breakpoint name (i.e. `sm`,
216+
`md`, `lg`, `xl`, or custom breakpoint names if you have defined them), and will hide the headings
217+
and captions on screens _smaller_ than the breakpoint.
218+
212219
## Touch swipe support
213220

214221
On touch enabled devices, users can switch slides by swiping left or right on the carousel. To

0 commit comments

Comments
 (0)