carousel.mdx 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  1. ---
  2. title: Carousel
  3. description: A carousel is used to display multiple pieces of visual content without taking up too much space. Carousels eliminate the need to scroll down the page to see all content and are a popular method of displaying marketing information.
  4. bootstrapLink: components/carousel/
  5. ---
  6. ## Default markup
  7. Use a carousel to make your website design more visually appealing for users. In the default carousel design, respective elements slide automatically and users can go to the next slide by clicking an arrow.
  8. ```html code example centered columns={2} height="35rem"
  9. <div id="carousel-sample" class="carousel slide" data-bs-ride="carousel">
  10. <div class="carousel-indicators">
  11. <button type="button" data-bs-target="#carousel-sample" data-bs-slide-to="0" class="active"></button>
  12. <button type="button" data-bs-target="#carousel-sample" data-bs-slide-to="1"></button>
  13. <button type="button" data-bs-target="#carousel-sample" data-bs-slide-to="2"></button>
  14. <button type="button" data-bs-target="#carousel-sample" data-bs-slide-to="3"></button>
  15. <button type="button" data-bs-target="#carousel-sample" data-bs-slide-to="4"></button>
  16. </div>
  17. <div class="carousel-inner">
  18. <div class="carousel-item active">
  19. <img class="d-block w-100" alt="" src="/samples/photos/city-lights-reflected-in-the-water-at-night.jpg" />
  20. </div>
  21. <div class="carousel-item">
  22. <img class="d-block w-100" alt="" src="/samples/photos/color-palette-guide-sample-colors-catalog-.jpg" />
  23. </div>
  24. <div class="carousel-item">
  25. <img class="d-block w-100" alt="" src="/samples/photos/finances-us-dollars-and-bitcoins-currency-money.jpg" />
  26. </div>
  27. <div class="carousel-item">
  28. <img class="d-block w-100" alt="" src="/samples/photos/tropical-palm-leaves-floral-pattern-background.jpg" />
  29. </div>
  30. <div class="carousel-item">
  31. <img class="d-block w-100" alt="" src="/samples/photos/young-woman-working-in-a-cafe.jpg" />
  32. </div>
  33. </div>
  34. <a class="carousel-control-prev" data-bs-target="#carousel-sample" role="button" data-bs-slide="prev">
  35. <span class="carousel-control-prev-icon" aria-hidden="true"></span>
  36. <span class="visually-hidden">Previous</span>
  37. </a>
  38. <a class="carousel-control-next" data-bs-target="#carousel-sample" role="button" data-bs-slide="next">
  39. <span class="carousel-control-next-icon" aria-hidden="true"></span>
  40. <span class="visually-hidden">Next</span>
  41. </a>
  42. </div>
  43. ```
  44. ## Dots indicators
  45. You can replace the standard indicators with dots. Just add the `carousel-indicators-dot` class to your carousel:
  46. ```html code example centered columns={2} height="35rem"
  47. <div id="carousel-indicators-dot" class="carousel slide carousel-fade" data-bs-ride="carousel">
  48. <div class="carousel-indicators carousel-indicators-dot">
  49. <button type="button" data-bs-target="#carousel-indicators-dot" data-bs-slide-to="0" class="active"></button>
  50. <button type="button" data-bs-target="#carousel-indicators-dot" data-bs-slide-to="1"></button>
  51. <button type="button" data-bs-target="#carousel-indicators-dot" data-bs-slide-to="2"></button>
  52. <button type="button" data-bs-target="#carousel-indicators-dot" data-bs-slide-to="3"></button>
  53. <button type="button" data-bs-target="#carousel-indicators-dot" data-bs-slide-to="4"></button>
  54. </div>
  55. <div class="carousel-inner">
  56. <div class="carousel-item active">
  57. <img class="d-block w-100" alt="" src="/samples/photos/stylish-workspace-with-macbook-pro.jpg" />
  58. </div>
  59. <div class="carousel-item">
  60. <img class="d-block w-100" alt="" src="/samples/photos/coffee-on-a-table-with-other-items.jpg" />
  61. </div>
  62. <div class="carousel-item">
  63. <img class="d-block w-100" alt="" src="/samples/photos/book-on-the-grass.jpg" />
  64. </div>
  65. <div class="carousel-item">
  66. <img class="d-block w-100" alt="" src="/samples/photos/a-woman-works-at-a-desk-with-a-laptop-and-a-cup-of-coffee.jpg" />
  67. </div>
  68. <div class="carousel-item">
  69. <img class="d-block w-100" alt="" src="/samples/photos/people-by-a-banquet-table-full-with-food.jpg" />
  70. </div>
  71. </div>
  72. </div>
  73. ```
  74. ## Thumb indicators
  75. The syntax is similar with thumbnails. Add class `carousel-indicators-thumb` and add `background-image` to element `[data-bs-target]`. Default thumbnails have an aspect ratio of 1:1. To change this use `ratio` utils.
  76. ```html example code centered columns={2} height="35rem"
  77. <div id="carousel-indicators-thumb" class="carousel slide carousel-fade" data-bs-ride="carousel">
  78. <div class="carousel-indicators carousel-indicators-thumb">
  79. <button type="button" data-bs-target="#carousel-indicators-thumb" data-bs-slide-to="0" class="ratio ratio-4x3 active" style="background-image: url(/samples/photos/group-of-people-sightseeing-in-the-city.jpg)"></button>
  80. <button type="button" data-bs-target="#carousel-indicators-thumb" data-bs-slide-to="1" class="ratio ratio-4x3" style="background-image: url(/samples/photos/young-woman-working-in-a-cafe.jpg)"></button>
  81. <button type="button" data-bs-target="#carousel-indicators-thumb" data-bs-slide-to="2" class="ratio ratio-4x3" style="background-image: url(/samples/photos/soft-photo-of-woman-on-the-bed-with-the-book-and-cup-of-coffee-in-hands.jpg)"></button>
  82. <button type="button" data-bs-target="#carousel-indicators-thumb" data-bs-slide-to="3" class="ratio ratio-4x3" style="background-image: url(/samples/photos/stylish-workplace-with-computer-at-home.jpg)"></button>
  83. <button type="button" data-bs-target="#carousel-indicators-thumb" data-bs-slide-to="4" class="ratio ratio-4x3" style="background-image: url(/samples/photos/stylish-workspace-with-macbook-pro.jpg)"></button>
  84. </div>
  85. <div class="carousel-inner">
  86. <div class="carousel-item active">
  87. <img class="d-block w-100" alt="" src="/samples/photos/group-of-people-sightseeing-in-the-city.jpg" />
  88. </div>
  89. <div class="carousel-item">
  90. <img class="d-block w-100" alt="" src="/samples/photos/young-woman-working-in-a-cafe.jpg" />
  91. </div>
  92. <div class="carousel-item">
  93. <img class="d-block w-100" alt="" src="/samples/photos/soft-photo-of-woman-on-the-bed-with-the-book-and-cup-of-coffee-in-hands.jpg" />
  94. </div>
  95. <div class="carousel-item">
  96. <img class="d-block w-100" alt="" src="/samples/photos/stylish-workplace-with-computer-at-home.jpg" />
  97. </div>
  98. <div class="carousel-item">
  99. <img class="d-block w-100" alt="" src="/samples/photos/stylish-workspace-with-macbook-pro.jpg" />
  100. </div>
  101. </div>
  102. </div>
  103. ```
  104. ## Vertical indicators
  105. To make the indicators go to the right side, add the `carousel-indicators-vertical` class. You can combine it with other classes that are responsible for dots or thumbnails.
  106. ```html code example centered columns={2} height="35rem"
  107. <div id="carousel-indicators-dot-vertical" class="carousel slide carousel-fade" data-bs-ride="carousel">
  108. <div class="carousel-indicators carousel-indicators-vertical carousel-indicators-dot">
  109. <button type="button" data-bs-target="#carousel-indicators-dot-vertical" data-bs-slide-to="0" class="active"></button>
  110. <button type="button" data-bs-target="#carousel-indicators-dot-vertical" data-bs-slide-to="1"></button>
  111. <button type="button" data-bs-target="#carousel-indicators-dot-vertical" data-bs-slide-to="2"></button>
  112. <button type="button" data-bs-target="#carousel-indicators-dot-vertical" data-bs-slide-to="3"></button>
  113. <button type="button" data-bs-target="#carousel-indicators-dot-vertical" data-bs-slide-to="4"></button>
  114. </div>
  115. <div class="carousel-inner">
  116. <div class="carousel-item active">
  117. <img class="d-block w-100" alt="" src="/samples/photos/man-looking-out-to-sea.jpg" />
  118. </div>
  119. <div class="carousel-item">
  120. <img class="d-block w-100" alt="" src="/samples/photos/making-magic-with-fairy-lights.jpg" />
  121. </div>
  122. <div class="carousel-item">
  123. <img class="d-block w-100" alt="" src="/samples/photos/finances-us-dollars-and-bitcoins-currency-money-5.jpg" />
  124. </div>
  125. <div class="carousel-item">
  126. <img class="d-block w-100" alt="" src="/samples/photos/cup-of-coffee-on-table-in-cafe-2.jpg" />
  127. </div>
  128. <div class="carousel-item">
  129. <img class="d-block w-100" alt="" src="/samples/photos/young-woman-sitting-on-the-sofa-and-working-on-her-laptop-2.jpg" />
  130. </div>
  131. </div>
  132. </div>
  133. ```
  134. Likewise, you can add thumbnails on the right side:
  135. ```html code example centered columns={2} height="35rem"
  136. <div id="carousel-indicators-thumb-vertical" class="carousel slide carousel-fade" data-bs-ride="carousel">
  137. <div class="carousel-indicators carousel-indicators-vertical carousel-indicators-thumb">
  138. <button type="button" data-bs-target="#carousel-indicators-thumb-vertical" data-bs-slide-to="0" class="ratio ratio-4x3 active" style="background-image: url(/samples/photos/finances-us-dollars-and-bitcoins-currency-money.jpg)"></button>
  139. <button type="button" data-bs-target="#carousel-indicators-thumb-vertical" data-bs-slide-to="1" class="ratio ratio-4x3" style="background-image: url(/samples/photos/businesswoman-working-at-her-laptop.jpg)"></button>
  140. <button type="button" data-bs-target="#carousel-indicators-thumb-vertical" data-bs-slide-to="2" class="ratio ratio-4x3" style="background-image: url(/samples/photos/color-palette-guide-sample-colors-catalog-.jpg)"></button>
  141. <button type="button" data-bs-target="#carousel-indicators-thumb-vertical" data-bs-slide-to="3" class="ratio ratio-4x3" style="background-image: url(/samples/photos/blue-sofa-with-pillows-in-a-designer-living-room-interior.jpg)"></button>
  142. <button type="button" data-bs-target="#carousel-indicators-thumb-vertical" data-bs-slide-to="4" class="ratio ratio-4x3" style="background-image: url(/samples/photos/beautiful-blonde-woman-on-a-wooden-pier-by-the-lake.jpg)"></button>
  143. </div>
  144. <div class="carousel-inner">
  145. <div class="carousel-item active">
  146. <img class="d-block w-100" alt="" src="/samples/photos/finances-us-dollars-and-bitcoins-currency-money.jpg" />
  147. </div>
  148. <div class="carousel-item">
  149. <img class="d-block w-100" alt="" src="/samples/photos/businesswoman-working-at-her-laptop.jpg" />
  150. </div>
  151. <div class="carousel-item">
  152. <img class="d-block w-100" alt="" src="/samples/photos/color-palette-guide-sample-colors-catalog-.jpg" />
  153. </div>
  154. <div class="carousel-item">
  155. <img class="d-block w-100" alt="" src="/samples/photos/blue-sofa-with-pillows-in-a-designer-living-room-interior.jpg" />
  156. </div>
  157. <div class="carousel-item">
  158. <img class="d-block w-100" alt="" src="/samples/photos/beautiful-blonde-woman-on-a-wooden-pier-by-the-lake.jpg" />
  159. </div>
  160. </div>
  161. </div>
  162. ```
  163. ## Carousel with captions
  164. Add captions to your slides easily with the `.carousel-caption` element within any `.carousel-item`. To make the text more readable on the image you can add `carousel-caption-background` which will add a black overlay over the image.
  165. ```html code example centered columns={2} height="35rem"
  166. <div id="carousel-captions" class="carousel slide" data-bs-ride="carousel">
  167. <div class="carousel-inner">
  168. <div class="carousel-item active">
  169. <img class="d-block w-100" alt="" src="/samples/photos/workplace-with-laptop-on-table-at-home-4.jpg" />
  170. <div class="carousel-caption-background d-none d-md-block"></div>
  171. <div class="carousel-caption d-none d-md-block">
  172. <h3>Slide label</h3>
  173. <p>Nulla vitae elit libero, a pharetra augue mollis interdum.</p>
  174. </div>
  175. </div>
  176. <div class="carousel-item">
  177. <img class="d-block w-100" alt="" src="/samples/photos/people-watching-a-presentation-in-a-room.jpg" />
  178. <div class="carousel-caption-background d-none d-md-block"></div>
  179. <div class="carousel-caption d-none d-md-block">
  180. <h3>Slide label</h3>
  181. <p>Nulla vitae elit libero, a pharetra augue mollis interdum.</p>
  182. </div>
  183. </div>
  184. <div class="carousel-item">
  185. <img class="d-block w-100" alt="" src="/samples/photos/people-by-a-banquet-table-full-with-food.jpg" />
  186. <div class="carousel-caption-background d-none d-md-block"></div>
  187. <div class="carousel-caption d-none d-md-block">
  188. <h3>Slide label</h3>
  189. <p>Nulla vitae elit libero, a pharetra augue mollis interdum.</p>
  190. </div>
  191. </div>
  192. <div class="carousel-item">
  193. <img class="d-block w-100" alt="" src="/samples/photos/books-and-purple-flowers-on-a-wooden-stool-by-the-bed.jpg" />
  194. <div class="carousel-caption-background d-none d-md-block"></div>
  195. <div class="carousel-caption d-none d-md-block">
  196. <h3>Slide label</h3>
  197. <p>Nulla vitae elit libero, a pharetra augue mollis interdum.</p>
  198. </div>
  199. </div>
  200. <div class="carousel-item">
  201. <img class="d-block w-100" alt="" src="/samples/photos/cup-of-coffee-and-an-open-book.jpg" />
  202. <div class="carousel-caption-background d-none d-md-block"></div>
  203. <div class="carousel-caption d-none d-md-block">
  204. <h3>Slide label</h3>
  205. <p>Nulla vitae elit libero, a pharetra augue mollis interdum.</p>
  206. </div>
  207. </div>
  208. </div>
  209. <a class="carousel-control-prev" data-bs-target="#carousel-captions" role="button" data-bs-slide="prev">
  210. <span class="carousel-control-prev-icon" aria-hidden="true"></span>
  211. <span class="visually-hidden">Previous</span>
  212. </a>
  213. <a class="carousel-control-next" data-bs-target="#carousel-captions" role="button" data-bs-slide="next">
  214. <span class="carousel-control-next-icon" aria-hidden="true"></span>
  215. <span class="visually-hidden">Next</span>
  216. </a>
  217. </div>
  218. ```