| <!doctype html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> |
| <meta name="description" content="A slideshow component for cycling through elements—images or slides of text—like a carousel."> |
| <meta name="author" content="Mark Otto, Jacob Thornton, and Bootstrap contributors"> |
| <meta name="generator" content="Jekyll v3.8.3"> |
| |
| <title>Carousel · Bootstrap</title> |
| |
| <link rel="canonical" href="https://getbootstrap.com/docs/4.1/components/carousel/"> |
| |
| <!-- Bootstrap core CSS --> |
| |
| <link href="/docs/4.1/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous"> |
| |
| |
| <!-- Documentation extras --> |
| |
| <link href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" rel="stylesheet"> |
| |
| <link href="/docs/4.1/assets/css/docs.min.css" rel="stylesheet"> |
| |
| <!-- Favicons --> |
| <link rel="apple-touch-icon" href="/docs/4.1/assets/img/favicons/apple-touch-icon.png" sizes="180x180"> |
| <link rel="icon" href="/docs/4.1/assets/img/favicons/favicon-32x32.png" sizes="32x32" type="image/png"> |
| <link rel="icon" href="/docs/4.1/assets/img/favicons/favicon-16x16.png" sizes="16x16" type="image/png"> |
| <link rel="manifest" href="/docs/4.1/assets/img/favicons/manifest.json"> |
| <link rel="mask-icon" href="/docs/4.1/assets/img/favicons/safari-pinned-tab.svg" color="#563d7c"> |
| <link rel="icon" href="/docs/4.1/assets/img/favicons/favicon.ico"> |
| <meta name="msapplication-config" content="/docs/4.1/assets/img/favicons/browserconfig.xml"> |
| <meta name="theme-color" content="#563d7c"> |
| |
| |
| <!-- Twitter --> |
| <meta name="twitter:card" content="summary"> |
| <meta name="twitter:site" content="@getbootstrap"> |
| <meta name="twitter:creator" content="@getbootstrap"> |
| <meta name="twitter:title" content="Carousel"> |
| <meta name="twitter:description" content="A slideshow component for cycling through elements—images or slides of text—like a carousel."> |
| <meta name="twitter:image" content="https://getbootstrap.com/docs/4.1/assets/brand/bootstrap-social-logo.png"> |
| |
| <!-- Facebook --> |
| <meta property="og:url" content="https://getbootstrap.com/docs/4.1/components/carousel/"> |
| <meta property="og:title" content="Carousel"> |
| <meta property="og:description" content="A slideshow component for cycling through elements—images or slides of text—like a carousel."> |
| <meta property="og:type" content="website"> |
| <meta property="og:image" content="http://getbootstrap.com/docs/4.1/assets/brand/bootstrap-social.png"> |
| <meta property="og:image:secure_url" content="https://getbootstrap.com/docs/4.1/assets/brand/bootstrap-social.png"> |
| <meta property="og:image:type" content="image/png"> |
| <meta property="og:image:width" content="1200"> |
| <meta property="og:image:height" content="630"> |
| |
| |
| <script defer src="https://cdn.usefathom.com/script.js" data-site="ITUSEYJG"></script> |
| <script> |
| window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date; |
| ga('create', 'UA-146052-10', 'getbootstrap.com'); |
| ga('set', 'anonymizeIp', true); |
| ga('send', 'pageview'); |
| </script> |
| <script async src='https://www.google-analytics.com/analytics.js'></script> |
| |
| </head> |
| <body> |
| <a id="skippy" class="sr-only sr-only-focusable" href="#content"> |
| <div class="container"> |
| <span class="skiplink-text">Skip to main content</span> |
| </div> |
| </a> |
| <a href="https://getbootstrap.com/" class="d-block px-3 py-2 text-center text-bold text-white old-bv">There's a newer version of Bootstrap!</a> |
| |
| <header class="navbar navbar-expand navbar-dark flex-column flex-md-row bd-navbar"> |
| <a class="navbar-brand mr-0 mr-md-2" href="/" aria-label="Bootstrap"><svg class="d-block" width="36" height="36" viewbox="0 0 612 612" xmlns="http://www.w3.org/2000/svg" focusable="false"><title>Bootstrap</title><path fill="currentColor" d="M510 8a94.3 94.3 0 0 1 94 94v408a94.3 94.3 0 0 1-94 94H102a94.3 94.3 0 0 1-94-94V102a94.3 94.3 0 0 1 94-94h408m0-8H102C45.9 0 0 45.9 0 102v408c0 56.1 45.9 102 102 102h408c56.1 0 102-45.9 102-102V102C612 45.9 566.1 0 510 0z"/><path fill="currentColor" d="M196.77 471.5V154.43h124.15c54.27 0 91 31.64 91 79.1 0 33-24.17 63.72-54.71 69.21v1.76c43.07 5.49 70.75 35.82 70.75 78 0 55.81-40 89-107.45 89zm39.55-180.4h63.28c46.8 0 72.29-18.68 72.29-53 0-31.42-21.53-48.78-60-48.78h-75.57zm78.22 145.46c47.68 0 72.73-19.34 72.73-56s-25.93-55.37-76.46-55.37h-74.49v111.4z"/></svg> |
| </a> |
| |
| <div class="navbar-nav-scroll"> |
| <ul class="navbar-nav bd-navbar-nav flex-row"> |
| <li class="nav-item"> |
| <a class="nav-link " href="/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Bootstrap');">Home</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link active" href="/docs/4.1/getting-started/introduction/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Docs');">Documentation</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link " href="/docs/4.1/examples/" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Examples');">Examples</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link" href="https://themes.getbootstrap.com" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Themes');" target="_blank" rel="noopener">Themes</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link" href="https://expo.getbootstrap.com" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Expo');" target="_blank" rel="noopener">Expo</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link" href="https://blog.getbootstrap.com" onclick="ga('send', 'event', 'Navbar', 'Community links', 'Blog');" target="_blank" rel="noopener">Blog</a> |
| </li> |
| </ul> |
| </div> |
| |
| <ul class="navbar-nav flex-row ml-md-auto d-none d-md-flex"> |
| <li class="nav-item dropdown"> |
| <a class="nav-item nav-link dropdown-toggle mr-md-2" href="#" id="bd-versions" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"> |
| v4.1 |
| </a> |
| <div class="dropdown-menu dropdown-menu-right" aria-labelledby="bd-versions"> |
| <a class="dropdown-item active" href="/docs/4.1/">Latest (4.1.x)</a> |
| <a class="dropdown-item" href="https://getbootstrap.com/docs/4.0/">v4.0.0</a> |
| <div class="dropdown-divider"></div> |
| <a class="dropdown-item" href="https://v4-alpha.getbootstrap.com/">v4 Alpha 6</a> |
| <a class="dropdown-item" href="https://getbootstrap.com/docs/3.3/">v3.3.7</a> |
| <a class="dropdown-item" href="https://getbootstrap.com/2.3.2/">v2.3.2</a> |
| </div> |
| </li> |
| |
| <li class="nav-item"> |
| <a class="nav-link p-2" href="https://github.com/twbs/bootstrap" target="_blank" rel="noopener" aria-label="GitHub"><svg class="navbar-nav-svg" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 499.36" focusable="false"><title>GitHub</title><path d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z" fill="currentColor" fill-rule="evenodd"/></svg> |
| </a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link p-2" href="https://twitter.com/getbootstrap" target="_blank" rel="noopener" aria-label="Twitter"><svg class="navbar-nav-svg" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 416.32" focusable="false"><title>Twitter</title><path d="M160.83 416.32c193.2 0 298.92-160.22 298.92-298.92 0-4.51 0-9-.2-13.52A214 214 0 0 0 512 49.38a212.93 212.93 0 0 1-60.44 16.6 105.7 105.7 0 0 0 46.3-58.19 209 209 0 0 1-66.79 25.37 105.09 105.09 0 0 0-181.73 71.91 116.12 116.12 0 0 0 2.66 24c-87.28-4.3-164.73-46.3-216.56-109.82A105.48 105.48 0 0 0 68 159.6a106.27 106.27 0 0 1-47.53-13.11v1.43a105.28 105.28 0 0 0 84.21 103.06 105.67 105.67 0 0 1-47.33 1.84 105.06 105.06 0 0 0 98.14 72.94A210.72 210.72 0 0 1 25 370.84a202.17 202.17 0 0 1-25-1.43 298.85 298.85 0 0 0 160.83 46.92" fill="currentColor"/></svg> |
| </a> |
| </li> |
| </ul> |
| |
| <a class="btn btn-bd-download d-none d-lg-inline-block mb-3 mb-md-0 ml-md-3" href="/docs/4.1/getting-started/download/">Download</a> |
| </header> |
| |
| |
| <div class="container-fluid"> |
| <div class="row flex-xl-nowrap"> |
| <div class="col-12 col-md-3 col-xl-2 bd-sidebar"> |
| <form class="bd-search d-flex align-items-center"> |
| <input type="search" class="form-control" id="search-input" placeholder="Search..." aria-label="Search for..." autocomplete="off" data-siteurl="https://getbootstrap.com" data-docs-version="4.1"> |
| <button class="btn btn-link bd-search-docs-toggle d-md-none p-0 ml-3" type="button" data-toggle="collapse" data-target="#bd-docs-nav" aria-controls="bd-docs-nav" aria-expanded="false" aria-label="Toggle docs navigation"><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 30 30" width="30" height="30" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-miterlimit="10" d="M4 7h22M4 15h22M4 23h22"/></svg> |
| </button> |
| </form> |
| |
| <nav class="collapse bd-links" id="bd-docs-nav"><div class="bd-toc-item"> |
| <a class="bd-toc-link" href="/docs/4.1/getting-started/introduction/"> |
| Getting started |
| </a> |
| |
| <ul class="nav bd-sidenav"><li> |
| <a href="/docs/4.1/getting-started/introduction/"> |
| Introduction |
| </a></li><li> |
| <a href="/docs/4.1/getting-started/download/"> |
| Download |
| </a></li><li> |
| <a href="/docs/4.1/getting-started/contents/"> |
| Contents |
| </a></li><li> |
| <a href="/docs/4.1/getting-started/browsers-devices/"> |
| Browsers & devices |
| </a></li><li> |
| <a href="/docs/4.1/getting-started/javascript/"> |
| JavaScript |
| </a></li><li> |
| <a href="/docs/4.1/getting-started/theming/"> |
| Theming |
| </a></li><li> |
| <a href="/docs/4.1/getting-started/build-tools/"> |
| Build tools |
| </a></li><li> |
| <a href="/docs/4.1/getting-started/webpack/"> |
| Webpack |
| </a></li><li> |
| <a href="/docs/4.1/getting-started/accessibility/"> |
| Accessibility |
| </a></li></ul> |
| </div><div class="bd-toc-item"> |
| <a class="bd-toc-link" href="/docs/4.1/layout/overview/"> |
| Layout |
| </a> |
| |
| <ul class="nav bd-sidenav"><li> |
| <a href="/docs/4.1/layout/overview/"> |
| Overview |
| </a></li><li> |
| <a href="/docs/4.1/layout/grid/"> |
| Grid |
| </a></li><li> |
| <a href="/docs/4.1/layout/media-object/"> |
| Media object |
| </a></li><li> |
| <a href="/docs/4.1/layout/utilities-for-layout/"> |
| Utilities for layout |
| </a></li></ul> |
| </div><div class="bd-toc-item"> |
| <a class="bd-toc-link" href="/docs/4.1/content/reboot/"> |
| Content |
| </a> |
| |
| <ul class="nav bd-sidenav"><li> |
| <a href="/docs/4.1/content/reboot/"> |
| Reboot |
| </a></li><li> |
| <a href="/docs/4.1/content/typography/"> |
| Typography |
| </a></li><li> |
| <a href="/docs/4.1/content/code/"> |
| Code |
| </a></li><li> |
| <a href="/docs/4.1/content/images/"> |
| Images |
| </a></li><li> |
| <a href="/docs/4.1/content/tables/"> |
| Tables |
| </a></li><li> |
| <a href="/docs/4.1/content/figures/"> |
| Figures |
| </a></li></ul> |
| </div><div class="bd-toc-item active"> |
| <a class="bd-toc-link" href="/docs/4.1/components/alerts/"> |
| Components |
| </a> |
| |
| <ul class="nav bd-sidenav"><li> |
| <a href="/docs/4.1/components/alerts/"> |
| Alerts |
| </a></li><li> |
| <a href="/docs/4.1/components/badge/"> |
| Badge |
| </a></li><li> |
| <a href="/docs/4.1/components/breadcrumb/"> |
| Breadcrumb |
| </a></li><li> |
| <a href="/docs/4.1/components/buttons/"> |
| Buttons |
| </a></li><li> |
| <a href="/docs/4.1/components/button-group/"> |
| Button group |
| </a></li><li> |
| <a href="/docs/4.1/components/card/"> |
| Card |
| </a></li><li class="active bd-sidenav-active"> |
| <a href="/docs/4.1/components/carousel/"> |
| Carousel |
| </a></li><li> |
| <a href="/docs/4.1/components/collapse/"> |
| Collapse |
| </a></li><li> |
| <a href="/docs/4.1/components/dropdowns/"> |
| Dropdowns |
| </a></li><li> |
| <a href="/docs/4.1/components/forms/"> |
| Forms |
| </a></li><li> |
| <a href="/docs/4.1/components/input-group/"> |
| Input group |
| </a></li><li> |
| <a href="/docs/4.1/components/jumbotron/"> |
| Jumbotron |
| </a></li><li> |
| <a href="/docs/4.1/components/list-group/"> |
| List group |
| </a></li><li> |
| <a href="/docs/4.1/components/modal/"> |
| Modal |
| </a></li><li> |
| <a href="/docs/4.1/components/navs/"> |
| Navs |
| </a></li><li> |
| <a href="/docs/4.1/components/navbar/"> |
| Navbar |
| </a></li><li> |
| <a href="/docs/4.1/components/pagination/"> |
| Pagination |
| </a></li><li> |
| <a href="/docs/4.1/components/popovers/"> |
| Popovers |
| </a></li><li> |
| <a href="/docs/4.1/components/progress/"> |
| Progress |
| </a></li><li> |
| <a href="/docs/4.1/components/scrollspy/"> |
| Scrollspy |
| </a></li><li> |
| <a href="/docs/4.1/components/tooltips/"> |
| Tooltips |
| </a></li></ul> |
| </div><div class="bd-toc-item"> |
| <a class="bd-toc-link" href="/docs/4.1/utilities/borders/"> |
| Utilities |
| </a> |
| |
| <ul class="nav bd-sidenav"><li> |
| <a href="/docs/4.1/utilities/borders/"> |
| Borders |
| </a></li><li> |
| <a href="/docs/4.1/utilities/clearfix/"> |
| Clearfix |
| </a></li><li> |
| <a href="/docs/4.1/utilities/close-icon/"> |
| Close icon |
| </a></li><li> |
| <a href="/docs/4.1/utilities/colors/"> |
| Colors |
| </a></li><li> |
| <a href="/docs/4.1/utilities/display/"> |
| Display |
| </a></li><li> |
| <a href="/docs/4.1/utilities/embed/"> |
| Embed |
| </a></li><li> |
| <a href="/docs/4.1/utilities/flex/"> |
| Flex |
| </a></li><li> |
| <a href="/docs/4.1/utilities/float/"> |
| Float |
| </a></li><li> |
| <a href="/docs/4.1/utilities/image-replacement/"> |
| Image replacement |
| </a></li><li> |
| <a href="/docs/4.1/utilities/position/"> |
| Position |
| </a></li><li> |
| <a href="/docs/4.1/utilities/screenreaders/"> |
| Screenreaders |
| </a></li><li> |
| <a href="/docs/4.1/utilities/shadows/"> |
| Shadows |
| </a></li><li> |
| <a href="/docs/4.1/utilities/sizing/"> |
| Sizing |
| </a></li><li> |
| <a href="/docs/4.1/utilities/spacing/"> |
| Spacing |
| </a></li><li> |
| <a href="/docs/4.1/utilities/text/"> |
| Text |
| </a></li><li> |
| <a href="/docs/4.1/utilities/vertical-align/"> |
| Vertical align |
| </a></li><li> |
| <a href="/docs/4.1/utilities/visibility/"> |
| Visibility |
| </a></li></ul> |
| </div><div class="bd-toc-item"> |
| <a class="bd-toc-link" href="/docs/4.1/extend/approach/"> |
| Extend |
| </a> |
| |
| <ul class="nav bd-sidenav"><li> |
| <a href="/docs/4.1/extend/approach/"> |
| Approach |
| </a></li><li> |
| <a href="/docs/4.1/extend/icons/"> |
| Icons |
| </a></li></ul> |
| </div><div class="bd-toc-item"> |
| <a class="bd-toc-link" href="/docs/4.1/migration/"> |
| Migration |
| </a> |
| |
| <ul class="nav bd-sidenav"></ul> |
| </div><div class="bd-toc-item"> |
| <a class="bd-toc-link" href="/docs/4.1/about/overview/"> |
| About |
| </a> |
| |
| <ul class="nav bd-sidenav"><li> |
| <a href="/docs/4.1/about/overview/"> |
| Overview |
| </a></li><li> |
| <a href="/docs/4.1/about/brand/"> |
| Brand |
| </a></li><li> |
| <a href="/docs/4.1/about/license/"> |
| License |
| </a></li><li> |
| <a href="/docs/4.1/about/translations/"> |
| Translations |
| </a></li></ul> |
| </div></nav> |
| |
| </div> |
| |
| |
| <div class="d-none d-xl-block col-xl-2 bd-toc"> |
| <ul class="section-nav"> |
| <li class="toc-entry toc-h2"><a href="#how-it-works">How it works</a></li> |
| <li class="toc-entry toc-h2"><a href="#example">Example</a> |
| <ul> |
| <li class="toc-entry toc-h3"><a href="#slides-only">Slides only</a></li> |
| <li class="toc-entry toc-h3"><a href="#with-controls">With controls</a></li> |
| <li class="toc-entry toc-h3"><a href="#with-indicators">With indicators</a></li> |
| <li class="toc-entry toc-h3"><a href="#with-captions">With captions</a></li> |
| <li class="toc-entry toc-h3"><a href="#crossfade">Crossfade</a></li> |
| </ul> |
| </li> |
| <li class="toc-entry toc-h2"><a href="#usage">Usage</a> |
| <ul> |
| <li class="toc-entry toc-h3"><a href="#via-data-attributes">Via data attributes</a></li> |
| <li class="toc-entry toc-h3"><a href="#via-javascript">Via JavaScript</a></li> |
| <li class="toc-entry toc-h3"><a href="#options">Options</a></li> |
| <li class="toc-entry toc-h3"><a href="#methods">Methods</a> |
| <ul> |
| <li class="toc-entry toc-h4"><a href="#asynchronous-methods-and-transitions">Asynchronous methods and transitions</a></li> |
| <li class="toc-entry toc-h4"><a href="#carouseloptions">.carousel(options)</a></li> |
| <li class="toc-entry toc-h4"><a href="#carouselcycle">.carousel('cycle')</a></li> |
| <li class="toc-entry toc-h4"><a href="#carouselpause">.carousel('pause')</a></li> |
| <li class="toc-entry toc-h4"><a href="#carouselnumber">.carousel(number)</a></li> |
| <li class="toc-entry toc-h4"><a href="#carouselprev">.carousel('prev')</a></li> |
| <li class="toc-entry toc-h4"><a href="#carouselnext">.carousel('next')</a></li> |
| <li class="toc-entry toc-h4"><a href="#carouseldispose">.carousel('dispose')</a></li> |
| </ul> |
| </li> |
| <li class="toc-entry toc-h3"><a href="#events">Events</a></li> |
| <li class="toc-entry toc-h3"><a href="#change-transition-duration">Change transition duration</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| |
| |
| <main class="col-12 col-md-9 col-xl-8 py-md-3 pl-md-5 bd-content" role="main"> |
| <h1 class="bd-title" id="content">Carousel</h1> |
| <p class="bd-lead">A slideshow component for cycling through elements—images or slides of text—like a carousel.</p> |
| <script async src="https://cdn.carbonads.com/carbon.js?serve=CKYIKKJL&placement=getbootstrapcom" id="_carbonads_js"></script> |
| |
| <h2 id="how-it-works">How it works</h2> |
| |
| <p>The carousel is a slideshow for cycling through a series of content, built with CSS 3D transforms and a bit of JavaScript. It works with a series of images, text, or custom markup. It also includes support for previous/next controls and indicators.</p> |
| |
| <p>In browsers where the <a href="https://www.w3.org/TR/page-visibility/">Page Visibility API</a> is supported, the carousel will avoid sliding when the webpage is not visible to the user (such as when the browser tab is inactive, the browser window is minimized, etc.).</p> |
| |
| <p>Please be aware that nested carousels are not supported, and carousels are generally not compliant with accessibility standards.</p> |
| |
| <p>Lastly, if you’re building our JavaScript from source, it <a href="/docs/4.1/getting-started/javascript/#util">requires <code class="highlighter-rouge">util.js</code></a>.</p> |
| |
| <h2 id="example">Example</h2> |
| |
| <p>Carousels don’t automatically normalize slide dimensions. As such, you may need to use additional utilities or custom styles to appropriately size content. While carousels support previous/next controls and indicators, they’re not explicitly required. Add and customize as you see fit.</p> |
| |
| <p><strong>The <code class="highlighter-rouge">.active</code> class needs to be added to one of the slides</strong> otherwise the carousel will not be visible. Also be sure to set a unique id on the <code class="highlighter-rouge">.carousel</code> for optional controls, especially if you’re using multiple carousels on a single page. Control and indicator elements must have a <code class="highlighter-rouge">data-target</code> attribute (or <code class="highlighter-rouge">href</code> for links) that matches the id of the <code class="highlighter-rouge">.carousel</code> element.</p> |
| |
| <h3 id="slides-only">Slides only</h3> |
| |
| <p>Here’s a carousel with slides only. Note the presence of the <code class="highlighter-rouge">.d-block</code> and <code class="highlighter-rouge">.w-100</code> on carousel images to prevent browser default image alignment.</p> |
| |
| <div class="bd-example"> |
| <div id="carouselExampleSlidesOnly" class="carousel slide" data-ride="carousel"> |
| <div class="carousel-inner"> |
| <div class="carousel-item active"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=777&fg=555&text=First slide" alt="First slide" /> |
| </div> |
| <div class="carousel-item"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=666&fg=444&text=Second slide" alt="Second slide" /> |
| </div> |
| <div class="carousel-item"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=555&fg=333&text=Third slide" alt="Third slide" /> |
| </div> |
| </div> |
| </div> |
| </div> |
| <figure class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">id=</span><span class="s">"carouselExampleSlidesOnly"</span> <span class="na">class=</span><span class="s">"carousel slide"</span> <span class="na">data-ride=</span><span class="s">"carousel"</span><span class="nt">></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-inner"</span><span class="nt">></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-item active"</span><span class="nt">></span> |
| <span class="nt"><img</span> <span class="na">class=</span><span class="s">"d-block w-100"</span> <span class="na">src=</span><span class="s">".../800x400?auto=yes&bg=777&fg=555&text=First slide"</span> <span class="na">alt=</span><span class="s">"First slide"</span><span class="nt">></span> |
| <span class="nt"></div></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-item"</span><span class="nt">></span> |
| <span class="nt"><img</span> <span class="na">class=</span><span class="s">"d-block w-100"</span> <span class="na">src=</span><span class="s">".../800x400?auto=yes&bg=666&fg=444&text=Second slide"</span> <span class="na">alt=</span><span class="s">"Second slide"</span><span class="nt">></span> |
| <span class="nt"></div></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-item"</span><span class="nt">></span> |
| <span class="nt"><img</span> <span class="na">class=</span><span class="s">"d-block w-100"</span> <span class="na">src=</span><span class="s">".../800x400?auto=yes&bg=555&fg=333&text=Third slide"</span> <span class="na">alt=</span><span class="s">"Third slide"</span><span class="nt">></span> |
| <span class="nt"></div></span> |
| <span class="nt"></div></span> |
| <span class="nt"></div></span></code></pre></figure> |
| |
| <h3 id="with-controls">With controls</h3> |
| |
| <p>Adding in the previous and next controls:</p> |
| |
| <div class="bd-example"> |
| <div id="carouselExampleControls" class="carousel slide" data-ride="carousel"> |
| <div class="carousel-inner"> |
| <div class="carousel-item active"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=777&fg=555&text=First slide" alt="First slide" /> |
| </div> |
| <div class="carousel-item"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=666&fg=444&text=Second slide" alt="Second slide" /> |
| </div> |
| <div class="carousel-item"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=555&fg=333&text=Third slide" alt="Third slide" /> |
| </div> |
| </div> |
| <a class="carousel-control-prev" href="#carouselExampleControls" role="button" data-slide="prev"> |
| <span class="carousel-control-prev-icon" aria-hidden="true"></span> |
| <span class="sr-only">Previous</span> |
| </a> |
| <a class="carousel-control-next" href="#carouselExampleControls" role="button" data-slide="next"> |
| <span class="carousel-control-next-icon" aria-hidden="true"></span> |
| <span class="sr-only">Next</span> |
| </a> |
| </div> |
| </div> |
| <figure class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">id=</span><span class="s">"carouselExampleControls"</span> <span class="na">class=</span><span class="s">"carousel slide"</span> <span class="na">data-ride=</span><span class="s">"carousel"</span><span class="nt">></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-inner"</span><span class="nt">></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-item active"</span><span class="nt">></span> |
| <span class="nt"><img</span> <span class="na">class=</span><span class="s">"d-block w-100"</span> <span class="na">src=</span><span class="s">".../800x400?auto=yes&bg=777&fg=555&text=First slide"</span> <span class="na">alt=</span><span class="s">"First slide"</span><span class="nt">></span> |
| <span class="nt"></div></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-item"</span><span class="nt">></span> |
| <span class="nt"><img</span> <span class="na">class=</span><span class="s">"d-block w-100"</span> <span class="na">src=</span><span class="s">".../800x400?auto=yes&bg=666&fg=444&text=Second slide"</span> <span class="na">alt=</span><span class="s">"Second slide"</span><span class="nt">></span> |
| <span class="nt"></div></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-item"</span><span class="nt">></span> |
| <span class="nt"><img</span> <span class="na">class=</span><span class="s">"d-block w-100"</span> <span class="na">src=</span><span class="s">".../800x400?auto=yes&bg=555&fg=333&text=Third slide"</span> <span class="na">alt=</span><span class="s">"Third slide"</span><span class="nt">></span> |
| <span class="nt"></div></span> |
| <span class="nt"></div></span> |
| <span class="nt"><a</span> <span class="na">class=</span><span class="s">"carousel-control-prev"</span> <span class="na">href=</span><span class="s">"#carouselExampleControls"</span> <span class="na">role=</span><span class="s">"button"</span> <span class="na">data-slide=</span><span class="s">"prev"</span><span class="nt">></span> |
| <span class="nt"><span</span> <span class="na">class=</span><span class="s">"carousel-control-prev-icon"</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span></span> |
| <span class="nt"><span</span> <span class="na">class=</span><span class="s">"sr-only"</span><span class="nt">></span>Previous<span class="nt"></span></span> |
| <span class="nt"></a></span> |
| <span class="nt"><a</span> <span class="na">class=</span><span class="s">"carousel-control-next"</span> <span class="na">href=</span><span class="s">"#carouselExampleControls"</span> <span class="na">role=</span><span class="s">"button"</span> <span class="na">data-slide=</span><span class="s">"next"</span><span class="nt">></span> |
| <span class="nt"><span</span> <span class="na">class=</span><span class="s">"carousel-control-next-icon"</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span></span> |
| <span class="nt"><span</span> <span class="na">class=</span><span class="s">"sr-only"</span><span class="nt">></span>Next<span class="nt"></span></span> |
| <span class="nt"></a></span> |
| <span class="nt"></div></span></code></pre></figure> |
| |
| <h3 id="with-indicators">With indicators</h3> |
| |
| <p>You can also add the indicators to the carousel, alongside the controls, too.</p> |
| |
| <div class="bd-example"> |
| <div id="carouselExampleIndicators" class="carousel slide" data-ride="carousel"> |
| <ol class="carousel-indicators"> |
| <li data-target="#carouselExampleIndicators" data-slide-to="0" class="active"></li> |
| <li data-target="#carouselExampleIndicators" data-slide-to="1"></li> |
| <li data-target="#carouselExampleIndicators" data-slide-to="2"></li> |
| </ol> |
| <div class="carousel-inner"> |
| <div class="carousel-item active"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=777&fg=555&text=First slide" alt="First slide" /> |
| </div> |
| <div class="carousel-item"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=666&fg=444&text=Second slide" alt="Second slide" /> |
| </div> |
| <div class="carousel-item"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=555&fg=333&text=Third slide" alt="Third slide" /> |
| </div> |
| </div> |
| <a class="carousel-control-prev" href="#carouselExampleIndicators" role="button" data-slide="prev"> |
| <span class="carousel-control-prev-icon" aria-hidden="true"></span> |
| <span class="sr-only">Previous</span> |
| </a> |
| <a class="carousel-control-next" href="#carouselExampleIndicators" role="button" data-slide="next"> |
| <span class="carousel-control-next-icon" aria-hidden="true"></span> |
| <span class="sr-only">Next</span> |
| </a> |
| </div> |
| </div> |
| <figure class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">id=</span><span class="s">"carouselExampleIndicators"</span> <span class="na">class=</span><span class="s">"carousel slide"</span> <span class="na">data-ride=</span><span class="s">"carousel"</span><span class="nt">></span> |
| <span class="nt"><ol</span> <span class="na">class=</span><span class="s">"carousel-indicators"</span><span class="nt">></span> |
| <span class="nt"><li</span> <span class="na">data-target=</span><span class="s">"#carouselExampleIndicators"</span> <span class="na">data-slide-to=</span><span class="s">"0"</span> <span class="na">class=</span><span class="s">"active"</span><span class="nt">></li></span> |
| <span class="nt"><li</span> <span class="na">data-target=</span><span class="s">"#carouselExampleIndicators"</span> <span class="na">data-slide-to=</span><span class="s">"1"</span><span class="nt">></li></span> |
| <span class="nt"><li</span> <span class="na">data-target=</span><span class="s">"#carouselExampleIndicators"</span> <span class="na">data-slide-to=</span><span class="s">"2"</span><span class="nt">></li></span> |
| <span class="nt"></ol></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-inner"</span><span class="nt">></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-item active"</span><span class="nt">></span> |
| <span class="nt"><img</span> <span class="na">class=</span><span class="s">"d-block w-100"</span> <span class="na">src=</span><span class="s">".../800x400?auto=yes&bg=777&fg=555&text=First slide"</span> <span class="na">alt=</span><span class="s">"First slide"</span><span class="nt">></span> |
| <span class="nt"></div></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-item"</span><span class="nt">></span> |
| <span class="nt"><img</span> <span class="na">class=</span><span class="s">"d-block w-100"</span> <span class="na">src=</span><span class="s">".../800x400?auto=yes&bg=666&fg=444&text=Second slide"</span> <span class="na">alt=</span><span class="s">"Second slide"</span><span class="nt">></span> |
| <span class="nt"></div></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-item"</span><span class="nt">></span> |
| <span class="nt"><img</span> <span class="na">class=</span><span class="s">"d-block w-100"</span> <span class="na">src=</span><span class="s">".../800x400?auto=yes&bg=555&fg=333&text=Third slide"</span> <span class="na">alt=</span><span class="s">"Third slide"</span><span class="nt">></span> |
| <span class="nt"></div></span> |
| <span class="nt"></div></span> |
| <span class="nt"><a</span> <span class="na">class=</span><span class="s">"carousel-control-prev"</span> <span class="na">href=</span><span class="s">"#carouselExampleIndicators"</span> <span class="na">role=</span><span class="s">"button"</span> <span class="na">data-slide=</span><span class="s">"prev"</span><span class="nt">></span> |
| <span class="nt"><span</span> <span class="na">class=</span><span class="s">"carousel-control-prev-icon"</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span></span> |
| <span class="nt"><span</span> <span class="na">class=</span><span class="s">"sr-only"</span><span class="nt">></span>Previous<span class="nt"></span></span> |
| <span class="nt"></a></span> |
| <span class="nt"><a</span> <span class="na">class=</span><span class="s">"carousel-control-next"</span> <span class="na">href=</span><span class="s">"#carouselExampleIndicators"</span> <span class="na">role=</span><span class="s">"button"</span> <span class="na">data-slide=</span><span class="s">"next"</span><span class="nt">></span> |
| <span class="nt"><span</span> <span class="na">class=</span><span class="s">"carousel-control-next-icon"</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span></span> |
| <span class="nt"><span</span> <span class="na">class=</span><span class="s">"sr-only"</span><span class="nt">></span>Next<span class="nt"></span></span> |
| <span class="nt"></a></span> |
| <span class="nt"></div></span></code></pre></figure> |
| |
| <h3 id="with-captions">With captions</h3> |
| |
| <p>Add captions to your slides easily with the <code class="highlighter-rouge">.carousel-caption</code> element within any <code class="highlighter-rouge">.carousel-item</code>. They can be easily hidden on smaller viewports, as shown below, with optional <a href="/docs/4.1/utilities/display/">display utilities</a>. We hide them initially with <code class="highlighter-rouge">.d-none</code> and bring them back on medium-sized devices with <code class="highlighter-rouge">.d-md-block</code>.</p> |
| |
| <div class="bd-example"> |
| <div id="carouselExampleCaptions" class="carousel slide" data-ride="carousel"> |
| <ol class="carousel-indicators"> |
| <li data-target="#carouselExampleCaptions" data-slide-to="0" class="active"></li> |
| <li data-target="#carouselExampleCaptions" data-slide-to="1"></li> |
| <li data-target="#carouselExampleCaptions" data-slide-to="2"></li> |
| </ol> |
| <div class="carousel-inner"> |
| <div class="carousel-item active"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=777&fg=555&text=First slide" alt="First slide" /> |
| <div class="carousel-caption d-none d-md-block"> |
| <h5>First slide label</h5> |
| <p>Nulla vitae elit libero, a pharetra augue mollis interdum.</p> |
| </div> |
| </div> |
| <div class="carousel-item"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=666&fg=444&text=Second slide" alt="Second slide" /> |
| <div class="carousel-caption d-none d-md-block"> |
| <h5>Second slide label</h5> |
| <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p> |
| </div> |
| </div> |
| <div class="carousel-item"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=555&fg=333&text=Third slide" alt="Third slide" /> |
| <div class="carousel-caption d-none d-md-block"> |
| <h5>Third slide label</h5> |
| <p>Praesent commodo cursus magna, vel scelerisque nisl consectetur.</p> |
| </div> |
| </div> |
| </div> |
| <a class="carousel-control-prev" href="#carouselExampleCaptions" role="button" data-slide="prev"> |
| <span class="carousel-control-prev-icon" aria-hidden="true"></span> |
| <span class="sr-only">Previous</span> |
| </a> |
| <a class="carousel-control-next" href="#carouselExampleCaptions" role="button" data-slide="next"> |
| <span class="carousel-control-next-icon" aria-hidden="true"></span> |
| <span class="sr-only">Next</span> |
| </a> |
| </div> |
| </div> |
| |
| <figure class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-item"</span><span class="nt">></span> |
| <span class="nt"><img</span> <span class="na">src=</span><span class="s">"..."</span> <span class="na">alt=</span><span class="s">"..."</span><span class="nt">></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-caption d-none d-md-block"</span><span class="nt">></span> |
| <span class="nt"><h5></span>...<span class="nt"></h5></span> |
| <span class="nt"><p></span>...<span class="nt"></p></span> |
| <span class="nt"></div></span> |
| <span class="nt"></div></span></code></pre></figure> |
| |
| <h3 id="crossfade">Crossfade</h3> |
| |
| <p>Add <code class="highlighter-rouge">.carousel-fade</code> to your carousel to animate slides with a fade transition instead of a slide.</p> |
| |
| <div class="bd-example"> |
| <div id="carouselExampleFade" class="carousel slide carousel-fade" data-ride="carousel"> |
| <div class="carousel-inner"> |
| <div class="carousel-item active"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=777&fg=555&text=First slide" alt="First slide" /> |
| </div> |
| <div class="carousel-item"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=666&fg=444&text=Second slide" alt="Second slide" /> |
| </div> |
| <div class="carousel-item"> |
| <img class="d-block w-100" data-src="holder.js/800x400?auto=yes&bg=555&fg=333&text=Third slide" alt="Third slide" /> |
| </div> |
| </div> |
| <a class="carousel-control-prev" href="#carouselExampleFade" role="button" data-slide="prev"> |
| <span class="carousel-control-prev-icon" aria-hidden="true"></span> |
| <span class="sr-only">Previous</span> |
| </a> |
| <a class="carousel-control-next" href="#carouselExampleFade" role="button" data-slide="next"> |
| <span class="carousel-control-next-icon" aria-hidden="true"></span> |
| <span class="sr-only">Next</span> |
| </a> |
| </div> |
| </div> |
| <figure class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><div</span> <span class="na">id=</span><span class="s">"carouselExampleFade"</span> <span class="na">class=</span><span class="s">"carousel slide carousel-fade"</span> <span class="na">data-ride=</span><span class="s">"carousel"</span><span class="nt">></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-inner"</span><span class="nt">></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-item active"</span><span class="nt">></span> |
| <span class="nt"><img</span> <span class="na">class=</span><span class="s">"d-block w-100"</span> <span class="na">src=</span><span class="s">".../800x400?auto=yes&bg=777&fg=555&text=First slide"</span> <span class="na">alt=</span><span class="s">"First slide"</span><span class="nt">></span> |
| <span class="nt"></div></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-item"</span><span class="nt">></span> |
| <span class="nt"><img</span> <span class="na">class=</span><span class="s">"d-block w-100"</span> <span class="na">src=</span><span class="s">".../800x400?auto=yes&bg=666&fg=444&text=Second slide"</span> <span class="na">alt=</span><span class="s">"Second slide"</span><span class="nt">></span> |
| <span class="nt"></div></span> |
| <span class="nt"><div</span> <span class="na">class=</span><span class="s">"carousel-item"</span><span class="nt">></span> |
| <span class="nt"><img</span> <span class="na">class=</span><span class="s">"d-block w-100"</span> <span class="na">src=</span><span class="s">".../800x400?auto=yes&bg=555&fg=333&text=Third slide"</span> <span class="na">alt=</span><span class="s">"Third slide"</span><span class="nt">></span> |
| <span class="nt"></div></span> |
| <span class="nt"></div></span> |
| <span class="nt"><a</span> <span class="na">class=</span><span class="s">"carousel-control-prev"</span> <span class="na">href=</span><span class="s">"#carouselExampleFade"</span> <span class="na">role=</span><span class="s">"button"</span> <span class="na">data-slide=</span><span class="s">"prev"</span><span class="nt">></span> |
| <span class="nt"><span</span> <span class="na">class=</span><span class="s">"carousel-control-prev-icon"</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span></span> |
| <span class="nt"><span</span> <span class="na">class=</span><span class="s">"sr-only"</span><span class="nt">></span>Previous<span class="nt"></span></span> |
| <span class="nt"></a></span> |
| <span class="nt"><a</span> <span class="na">class=</span><span class="s">"carousel-control-next"</span> <span class="na">href=</span><span class="s">"#carouselExampleFade"</span> <span class="na">role=</span><span class="s">"button"</span> <span class="na">data-slide=</span><span class="s">"next"</span><span class="nt">></span> |
| <span class="nt"><span</span> <span class="na">class=</span><span class="s">"carousel-control-next-icon"</span> <span class="na">aria-hidden=</span><span class="s">"true"</span><span class="nt">></span></span> |
| <span class="nt"><span</span> <span class="na">class=</span><span class="s">"sr-only"</span><span class="nt">></span>Next<span class="nt"></span></span> |
| <span class="nt"></a></span> |
| <span class="nt"></div></span></code></pre></figure> |
| |
| <h2 id="usage">Usage</h2> |
| |
| <h3 id="via-data-attributes">Via data attributes</h3> |
| |
| <p>Use data attributes to easily control the position of the carousel. <code class="highlighter-rouge">data-slide</code> accepts the keywords <code class="highlighter-rouge">prev</code> or <code class="highlighter-rouge">next</code>, which alters the slide position relative to its current position. Alternatively, use <code class="highlighter-rouge">data-slide-to</code> to pass a raw slide index to the carousel <code class="highlighter-rouge">data-slide-to="2"</code>, which shifts the slide position to a particular index beginning with <code class="highlighter-rouge">0</code>.</p> |
| |
| <p>The <code class="highlighter-rouge">data-ride="carousel"</code> attribute is used to mark a carousel as animating starting at page load. <strong>It cannot be used in combination with (redundant and unnecessary) explicit JavaScript initialization of the same carousel.</strong></p> |
| |
| <h3 id="via-javascript">Via JavaScript</h3> |
| |
| <p>Call carousel manually with:</p> |
| |
| <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'.carousel'</span><span class="p">).</span><span class="nx">carousel</span><span class="p">()</span></code></pre></figure> |
| |
| <h3 id="options">Options</h3> |
| |
| <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code class="highlighter-rouge">data-</code>, as in <code class="highlighter-rouge">data-interval=""</code>.</p> |
| |
| <table class="table table-bordered table-striped"> |
| <thead> |
| <tr> |
| <th style="width: 100px;">Name</th> |
| <th style="width: 50px;">Type</th> |
| <th style="width: 50px;">Default</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>interval</td> |
| <td>number</td> |
| <td>5000</td> |
| <td>The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.</td> |
| </tr> |
| <tr> |
| <td>keyboard</td> |
| <td>boolean</td> |
| <td>true</td> |
| <td>Whether the carousel should react to keyboard events.</td> |
| </tr> |
| <tr> |
| <td>pause</td> |
| <td>string | boolean</td> |
| <td>"hover"</td> |
| <td><p>If set to <code>"hover"</code>, pauses the cycling of the carousel on <code>mouseenter</code> and resumes the cycling of the carousel on <code>mouseleave</code>. If set to <code>false</code>, hovering over the carousel won't pause it.</p> |
| <p>On touch-enabled devices, when set to <code>"hover"</code>, cycling will pause on <code>touchend</code> (once the user finished interacting with the carousel) for two intervals, before automatically resuming. Note that this is in addition to the above mouse behavior.</p></td> |
| </tr> |
| <tr> |
| <td>ride</td> |
| <td>string</td> |
| <td>false</td> |
| <td>Autoplays the carousel after the user manually cycles the first item. If "carousel", autoplays the carousel on load.</td> |
| </tr> |
| <tr> |
| <td>wrap</td> |
| <td>boolean</td> |
| <td>true</td> |
| <td>Whether the carousel should cycle continuously or have hard stops.</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <h3 id="methods">Methods</h3> |
| |
| <div class="bd-callout bd-callout-danger"> |
| <h4 id="asynchronous-methods-and-transitions">Asynchronous methods and transitions</h4> |
| |
| <p>All API methods are <strong>asynchronous</strong> and start a <strong>transition</strong>. They return to the caller as soon as the transition is started but <strong>before it ends</strong>. In addition, a method call on a <strong>transitioning component will be ignored</strong>.</p> |
| |
| <p><a href="/docs/4.1/getting-started/javascript/">See our JavaScript documentation for more information.</a></p> |
| </div> |
| |
| <h4 id="carouseloptions"><code class="highlighter-rouge">.carousel(options)</code></h4> |
| |
| <p>Initializes the carousel with an optional options <code class="highlighter-rouge">object</code> and starts cycling through items.</p> |
| |
| <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'.carousel'</span><span class="p">).</span><span class="nx">carousel</span><span class="p">({</span> |
| <span class="na">interval</span><span class="p">:</span> <span class="mi">2000</span> |
| <span class="p">})</span></code></pre></figure> |
| |
| <h4 id="carouselcycle"><code class="highlighter-rouge">.carousel('cycle')</code></h4> |
| |
| <p>Cycles through the carousel items from left to right.</p> |
| |
| <h4 id="carouselpause"><code class="highlighter-rouge">.carousel('pause')</code></h4> |
| |
| <p>Stops the carousel from cycling through items.</p> |
| |
| <h4 id="carouselnumber"><code class="highlighter-rouge">.carousel(number)</code></h4> |
| |
| <p>Cycles the carousel to a particular frame (0 based, similar to an array). <strong>Returns to the caller before the target item has been shown</strong> (i.e. before the <code class="highlighter-rouge">slid.bs.carousel</code> event occurs).</p> |
| |
| <h4 id="carouselprev"><code class="highlighter-rouge">.carousel('prev')</code></h4> |
| |
| <p>Cycles to the previous item. <strong>Returns to the caller before the previous item has been shown</strong> (i.e. before the <code class="highlighter-rouge">slid.bs.carousel</code> event occurs).</p> |
| |
| <h4 id="carouselnext"><code class="highlighter-rouge">.carousel('next')</code></h4> |
| |
| <p>Cycles to the next item. <strong>Returns to the caller before the next item has been shown</strong> (i.e. before the <code class="highlighter-rouge">slid.bs.carousel</code> event occurs).</p> |
| |
| <h4 id="carouseldispose"><code class="highlighter-rouge">.carousel('dispose')</code></h4> |
| |
| <p>Destroys an element’s carousel.</p> |
| |
| <h3 id="events">Events</h3> |
| |
| <p>Bootstrap’s carousel class exposes two events for hooking into carousel functionality. Both events have the following additional properties:</p> |
| |
| <ul> |
| <li><code class="highlighter-rouge">direction</code>: The direction in which the carousel is sliding (either <code class="highlighter-rouge">"left"</code> or <code class="highlighter-rouge">"right"</code>).</li> |
| <li><code class="highlighter-rouge">relatedTarget</code>: The DOM element that is being slid into place as the active item.</li> |
| <li><code class="highlighter-rouge">from</code>: The index of the current item</li> |
| <li><code class="highlighter-rouge">to</code>: The index of the next item</li> |
| </ul> |
| |
| <p>All carousel events are fired at the carousel itself (i.e. at the <code class="highlighter-rouge"><div class="carousel"></code>).</p> |
| |
| <table class="table table-bordered table-striped"> |
| <thead> |
| <tr> |
| <th style="width: 150px;">Event Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>slide.bs.carousel</td> |
| <td>This event fires immediately when the <code>slide</code> instance method is invoked.</td> |
| </tr> |
| <tr> |
| <td>slid.bs.carousel</td> |
| <td>This event is fired when the carousel has completed its slide transition.</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <figure class="highlight"><pre><code class="language-js" data-lang="js"><span class="nx">$</span><span class="p">(</span><span class="s1">'#myCarousel'</span><span class="p">).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'slide.bs.carousel'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span> |
| <span class="c1">// do something…</span> |
| <span class="p">})</span></code></pre></figure> |
| |
| <h3 id="change-transition-duration">Change transition duration</h3> |
| |
| <p>The transition duration of <code class="highlighter-rouge">.carousel-item</code> can be changed with the <code class="highlighter-rouge">$carousel-transition</code> Sass variable before compiling or custom styles if you’re using the compiled CSS. If multiple transitions are applied, make sure the transform transition is defined first (eg. <code class="highlighter-rouge">transition: transform 2s ease, opacity .5s ease-out</code>).</p> |
| |
| </main> |
| </div> |
| </div> |
| |
| <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script> |
| <script>window.jQuery || document.write('<script src="/assets/js/vendor/jquery-slim.min.js"><\/script>')</script> |
| |
| <script src="/docs/4.1/assets/js/vendor/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script><script src="/docs/4.1/dist/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script><script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script><script src="/docs/4.1/assets/js/docs.min.js"></script> |
| </body> |
| </html> |
