From 5d066caace6d7a90111ff0385c0e029d79df38cf Mon Sep 17 00:00:00 2001 From: Ankit Mishra Date: Fri, 9 Oct 2020 10:21:12 +0530 Subject: [PATCH] Backport #31809 (#31851) carousel: add missing `to` and `nextwhenvisible` description --- site/docs/4.5/components/carousel.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/site/docs/4.5/components/carousel.md b/site/docs/4.5/components/carousel.md index cdb0c64880fc..35bdd198f1dc 100644 --- a/site/docs/4.5/components/carousel.md +++ b/site/docs/4.5/components/carousel.md @@ -321,6 +321,14 @@ Cycles to the next item. **Returns to the caller before the next item has been s Destroys an element's carousel. +#### `.carousel('nextWhenVisible')` + +Don't cycle the carousel to next when the page isn't visible or the carousel or its parent isn't visible. **Returns to the caller before the next item has been shown** (i.e. before the `slid.bs.carousel` event occurs). + +#### `.carousel('to')` + +Cycles the carousel to a particular frame (0 based, similar to an array). **Returns to the caller before the next item has been shown** (i.e. before the `slid.bs.carousel` event occurs). + ### Events Bootstrap's carousel class exposes two events for hooking into carousel functionality. Both events have the following additional properties: