Documentation and examples for Bootstrap’s logo and brand usage guidelines.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Have a need for Bootstrap’s brand resources? Great! We have only a few guidelines we follow, and in turn ask you to follow as well.
+
Logo
+
When referencing Bootstrap, use our logo mark. Do not modify our logos in any way. Do not use Bootstrap’s branding for your own open or closed source projects. Do not use the Twitter name or logo in association with Bootstrap.
+
+
+
+
Our logo mark is also available in black and white. All rules for our primary logo apply to these as well.
+
+
+
+
+
+
+
+
+
Name
+
Bootstrap should always be referred to as just Bootstrap. No Twitter before it and no capital s.
Commonly asked questions about Bootstrap’s open source license.
+
+
+
+
+
+
+
+
+
+
Bootstrap is released under the MIT license and is copyright 2020 Twitter. Boiled down to smaller chunks, it can be described with the following conditions.
+
It requires you to:
+
+
Keep the license and copyright notice included in Bootstrap’s CSS and JavaScript files when you use them in your works
+
+
It permits you to:
+
+
Freely download and use Bootstrap, in whole or in part, for personal, private, company internal, or commercial purposes
+
Use Bootstrap in packages or distributions that you create
+
Modify the source code
+
Grant a sublicense to modify and distribute Bootstrap to third parties not included in the license
+
+
It forbids you to:
+
+
Hold the authors and license owners liable for damages as Bootstrap is provided without warranty
+
Hold the creators or copyright holders of Bootstrap liable
+
Redistribute any piece of Bootstrap without proper attribution
+
Use any marks owned by Twitter in any way that might state or imply that Twitter endorses your distribution
+
Use any marks owned by Twitter in any way that might state or imply that you created the Twitter software in question
+
+
It does not require you to:
+
+
Include the source of Bootstrap itself, or of any modifications you may have made to it, in any redistribution you may assemble that includes it
+
Submit changes that you make to Bootstrap back to the Bootstrap project (though such feedback is encouraged)
Learn more about the team maintaining Bootstrap, how and why the project started, and how to get involved.
+
+
+
+
+
+
+
+
+
+
Team
+
Bootstrap is maintained by a small team of developers on GitHub. We’re actively looking to grow this team and would love to hear from you if you’re excited about CSS at scale, writing and maintaining vanilla JavaScript plugins, and improving build tooling processes for frontend code.
+
History
+
Originally created by a designer and a developer at Twitter, Bootstrap has become one of the most popular front-end frameworks and open source projects in the world.
+
Bootstrap was created at Twitter in mid-2010 by @mdo and @fat. Prior to being an open-sourced framework, Bootstrap was known as Twitter Blueprint. A few months into development, Twitter held its first Hack Week and the project exploded as developers of all skill levels jumped in without any external guidance. It served as the style guide for internal tools development at the company for over a year before its public release, and continues to do so today.
+
Originally released on , we’ve since had over twenty releases, including two major rewrites with v2 and v3. With Bootstrap 2, we added responsive functionality to the entire framework as an optional stylesheet. Building on that with Bootstrap 3, we rewrote the library once more to make it responsive by default with a mobile first approach.
+
With Bootstrap 4, we once again rewrote the project to account for two key architectural changes: a migration to Sass and the move to CSS’s flexbox. Our intention is to help in a small way to move the web development community forward by pushing for newer CSS properties, fewer dependencies, and new technologies across more modern browsers.
+
Our latest release, Bootstrap 5 (currently in development), focuses on improving v4’s codebase with as few major breaking changes as possible. We improved existing features and components, removed support for older browsers, dropped jQuery for regular JavaScript, and embraced more future-friendly technologies like CSS custom properties as part of our tooling.
+
Get involved
+
Get involved with Bootstrap development by opening an issue or submitting a pull request. Read our contributing guidelines for information on how we develop.
An overview of the founding team and core contributors to Bootstrap.
+
+
+
+
+
+
+
+
+
+
Bootstrap is maintained by the founding team and a small group of invaluable core contributors, with the massive support and involvement of our community.
Get involved with Bootstrap development by opening an issue or submitting a pull request. Read our contributing guidelines for information on how we develop.
Links to community-translated Bootstrap documentation sites.
+
+
+
+
+
+
+
+
+
+
Community members have translated Bootstrap’s documentation into various languages. None are officially supported and they may not always be up to date.
Click the accordions below to expand/collapse the accordion content.
+
+
+
+
+
+
+
+
+ This is the first item's accordion body. It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the .accordion-body, though the transition does limit overflow.
+
+
+
+
+
+
+
+
+
+ This is the second item's accordion body. It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the .accordion-body, though the transition does limit overflow.
+
+
+
+
+
+
+
+
+
+ This is the third item's accordion body. It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the .accordion-body, though the transition does limit overflow.
+
+
+
+
+
<divclass="accordion"id="accordionExample">
+ <divclass="accordion-item">
+ <h2class="accordion-header"id="headingOne">
+ <buttonclass="accordion-button"type="button"data-bs-toggle="collapse"data-bs-target="#collapseOne"aria-expanded="true"aria-controls="collapseOne">
+ Accordion Item #1
+ </button>
+ </h2>
+ <divid="collapseOne"class="accordion-collapse collapse show"aria-labelledby="headingOne"data-bs-parent="#accordionExample">
+ <divclass="accordion-body">
+ <strong>This is the first item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the <code>.accordion-body</code>, though the transition does limit overflow.
+ </div>
+ </div>
+ </div>
+ <divclass="accordion-item">
+ <h2class="accordion-header"id="headingTwo">
+ <buttonclass="accordion-button collapsed"type="button"data-bs-toggle="collapse"data-bs-target="#collapseTwo"aria-expanded="false"aria-controls="collapseTwo">
+ Accordion Item #2
+ </button>
+ </h2>
+ <divid="collapseTwo"class="accordion-collapse collapse"aria-labelledby="headingTwo"data-bs-parent="#accordionExample">
+ <divclass="accordion-body">
+ <strong>This is the second item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the <code>.accordion-body</code>, though the transition does limit overflow.
+ </div>
+ </div>
+ </div>
+ <divclass="accordion-item">
+ <h2class="accordion-header"id="headingThree">
+ <buttonclass="accordion-button collapsed"type="button"data-bs-toggle="collapse"data-bs-target="#collapseThree"aria-expanded="false"aria-controls="collapseThree">
+ Accordion Item #3
+ </button>
+ </h2>
+ <divid="collapseThree"class="accordion-collapse collapse"aria-labelledby="headingThree"data-bs-parent="#accordionExample">
+ <divclass="accordion-body">
+ <strong>This is the third item's accordion body.</strong> It is hidden by default, until the collapse plugin adds the appropriate classes that we use to style each element. These classes control the overall appearance, as well as the showing and hiding via CSS transitions. You can modify any of this with custom CSS or overriding our default variables. It's also worth noting that just about any HTML can go within the <code>.accordion-body</code>, though the transition does limit overflow.
+ </div>
+ </div>
+ </div>
+</div>
+
Flush
+
Add .accordion-flush to remove the default background-color, some borders, and some rounded corners to render accordions edge-to-edge with their parent container.
+
+
+
+
+
+
+
+
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
+
+
+
+
+
+
+
+
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
+
+
+
+
+
+
+
+
Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
+
+
+
+
<divclass="accordion accordion-flush"id="accordionFlushExample">
+ <divclass="accordion-item">
+ <h2class="accordion-header"id="flush-headingOne">
+ <buttonclass="accordion-button collapsed"type="button"data-bs-toggle="collapse"data-bs-target="#flush-collapseOne"aria-expanded="false"aria-controls="flush-collapseOne">
+ Accordion Item #1
+ </button>
+ </h2>
+ <divid="flush-collapseOne"class="accordion-collapse collapse"aria-labelledby="flush-headingOne"data-bs-parent="#accordionFlushExample">
+ <divclass="accordion-body">Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.</div>
+ </div>
+ </div>
+ <divclass="accordion-item">
+ <h2class="accordion-header"id="flush-headingTwo">
+ <buttonclass="accordion-button collapsed"type="button"data-bs-toggle="collapse"data-bs-target="#flush-collapseTwo"aria-expanded="false"aria-controls="flush-collapseTwo">
+ Accordion Item #2
+ </button>
+ </h2>
+ <divid="flush-collapseTwo"class="accordion-collapse collapse"aria-labelledby="flush-headingTwo"data-bs-parent="#accordionFlushExample">
+ <divclass="accordion-body">Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.</div>
+ </div>
+ </div>
+ <divclass="accordion-item">
+ <h2class="accordion-header"id="flush-headingThree">
+ <buttonclass="accordion-button collapsed"type="button"data-bs-toggle="collapse"data-bs-target="#flush-collapseThree"aria-expanded="false"aria-controls="flush-collapseThree">
+ Accordion Item #3
+ </button>
+ </h2>
+ <divid="flush-collapseThree"class="accordion-collapse collapse"aria-labelledby="flush-headingThree"data-bs-parent="#accordionFlushExample">
+ <divclass="accordion-body">Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.</div>
+ </div>
+ </div>
+</div>
Provide contextual feedback messages for typical user actions with the handful of available and flexible alert messages.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Examples
+
Alerts are available for any length of text, as well as an optional close button. For proper styling, use one of the eight required contextual classes (e.g., .alert-success). For inline dismissal, use the alerts JavaScript plugin.
+
+
+
+ A simple primary alert—check it out!
+
+
+ A simple secondary alert—check it out!
+
+
+ A simple success alert—check it out!
+
+
+ A simple danger alert—check it out!
+
+
+ A simple warning alert—check it out!
+
+
+ A simple info alert—check it out!
+
+
+ A simple light alert—check it out!
+
+
+ A simple dark alert—check it out!
+
+
<divclass="alert alert-primary"role="alert">
+ A simple primary alert—check it out!
+</div>
+<divclass="alert alert-secondary"role="alert">
+ A simple secondary alert—check it out!
+</div>
+<divclass="alert alert-success"role="alert">
+ A simple success alert—check it out!
+</div>
+<divclass="alert alert-danger"role="alert">
+ A simple danger alert—check it out!
+</div>
+<divclass="alert alert-warning"role="alert">
+ A simple warning alert—check it out!
+</div>
+<divclass="alert alert-info"role="alert">
+ A simple info alert—check it out!
+</div>
+<divclass="alert alert-light"role="alert">
+ A simple light alert—check it out!
+</div>
+<divclass="alert alert-dark"role="alert">
+ A simple dark alert—check it out!
+</div>
+
+
Conveying meaning to assistive technologies
+
Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the .visually-hidden class.
+
+
+
Link color
+
Use the .alert-link utility class to quickly provide matching colored links within any alert.
+
+
+
+ A simple primary alert with an example link. Give it a click if you like.
+
+
+ A simple secondary alert with an example link. Give it a click if you like.
+
+
+ A simple success alert with an example link. Give it a click if you like.
+
+
+ A simple danger alert with an example link. Give it a click if you like.
+
+
+ A simple warning alert with an example link. Give it a click if you like.
+
+
+ A simple info alert with an example link. Give it a click if you like.
+
+
+ A simple light alert with an example link. Give it a click if you like.
+
+
+ A simple dark alert with an example link. Give it a click if you like.
+
+
<divclass="alert alert-primary"role="alert">
+ A simple primary alert with <ahref="#"class="alert-link">an example link</a>. Give it a click if you like.
+</div>
+<divclass="alert alert-secondary"role="alert">
+ A simple secondary alert with <ahref="#"class="alert-link">an example link</a>. Give it a click if you like.
+</div>
+<divclass="alert alert-success"role="alert">
+ A simple success alert with <ahref="#"class="alert-link">an example link</a>. Give it a click if you like.
+</div>
+<divclass="alert alert-danger"role="alert">
+ A simple danger alert with <ahref="#"class="alert-link">an example link</a>. Give it a click if you like.
+</div>
+<divclass="alert alert-warning"role="alert">
+ A simple warning alert with <ahref="#"class="alert-link">an example link</a>. Give it a click if you like.
+</div>
+<divclass="alert alert-info"role="alert">
+ A simple info alert with <ahref="#"class="alert-link">an example link</a>. Give it a click if you like.
+</div>
+<divclass="alert alert-light"role="alert">
+ A simple light alert with <ahref="#"class="alert-link">an example link</a>. Give it a click if you like.
+</div>
+<divclass="alert alert-dark"role="alert">
+ A simple dark alert with <ahref="#"class="alert-link">an example link</a>. Give it a click if you like.
+</div>
+
Additional content
+
Alerts can also contain additional HTML elements like headings, paragraphs and dividers.
+
+
+
Well done!
+
Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within an alert works with this kind of content.
+
+
Whenever you need to, be sure to use margin utilities to keep things nice and tidy.
+
+
<divclass="alert alert-success"role="alert">
+ <h4class="alert-heading">Well done!</h4>
+ <p>Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within an alert works with this kind of content.</p>
+ <hr>
+ <pclass="mb-0">Whenever you need to, be sure to use margin utilities to keep things nice and tidy.</p>
+</div>
+
Dismissing
+
Using the alert JavaScript plugin, it’s possible to dismiss any alert inline. Here’s how:
+
+
Be sure you’ve loaded the alert plugin, or the compiled Bootstrap JavaScript.
+
Add a close button and the .alert-dismissible class, which adds extra padding to the right of the alert and positions the close button.
+
On the close button, add the data-bs-dismiss="alert" attribute, which triggers the JavaScript functionality. Be sure to use the <button> element with it for proper behavior across all devices.
+
To animate alerts when dismissing them, be sure to add the .fade and .show classes.
+
+
You can see this in action with a live demo:
+
+
+ Holy guacamole! You should check in on some of those fields below.
+
+
+
<divclass="alert alert-warning alert-dismissible fade show"role="alert">
+ <strong>Holy guacamole!</strong> You should check in on some of those fields below.
+ <buttontype="button"class="btn-close"data-bs-dismiss="alert"aria-label="Close"></button>
+</div>
+
+When an alert is dismissed, the element is completely removed from the page structure. If a keyboard user dismisses the alert using the close button, their focus will suddenly be lost and, depending on the browser, reset to the start of the page/document. For this reason, we recommend including additional JavaScript that listens for the closed.bs.alert event and programmatically sets focus() to the most appropriate location in the page. If you’re planning to move focus to a non-interactive element that normally does not receive focus, make sure to add tabindex="-1" to the element.
+
This makes an alert listen for click events on descendant elements which have the data-bs-dismiss="alert" attribute. (Not necessary when using the data-api’s auto-initialization.)
+
+
+
+
Method
+
Description
+
+
+
+
+
+ close
+
+
+ Closes an alert by removing it from the DOM. If the .fade and .show classes are present on the element, the alert will fade out before it is removed.
+
+
+
+
+ dispose
+
+
+ Destroys an element's alert. (Removes stored data on the DOM element)
+
+
+
+
+ getInstance
+
+
+ Static method which allows you to get the alert instance associated to a DOM element, you can use it like this: bootstrap.Alert.getInstance(alert)
+
Bootstrap’s alert plugin exposes a few events for hooking into alert functionality.
+
+
+
+
Event
+
Description
+
+
+
+
+
close.bs.alert
+
+ Fires immediately when the close instance method is called.
+
+
+
+
closed.bs.alert
+
+ Fired when the alert has been closed and CSS transitions have completed.
+
+
+
+
+
varmyAlert=document.getElementById('myAlert')
+myAlert.addEventListener('closed.bs.alert',function(){
+ // do something, for instance, explicitly move focus to the most appropriate element,
+// so it doesn't get lost/reset to the start of the page
+// document.getElementById('...').focus()
+})
+
Documentation and examples for badges, our small count and labeling component.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Example
+
Badges scale to match the size of the immediate parent element by using relative font sizing and em units. As of v5, badges no longer have focus or hover styles for links.
Note that depending on how they are used, badges may be confusing for users of screen readers and similar assistive technologies. While the styling of badges provides a visual cue as to their purpose, these users will simply be presented with the content of the badge. Depending on the specific situation, these badges may seem like random additional words or numbers at the end of a sentence, link, or button.
+
Unless the context is clear (as with the “Notifications” example, where it is understood that the “4” is the number of notifications), consider including additional context with a visually hidden piece of additional text.
Use our background utility classes to quickly change the appearance of a badge. Please note that when using Bootstrap’s default .bg-light, you’ll likely need a text color utility like .text-dark for proper styling. This is because background utilities do not set anything but background-color.
Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the .visually-hidden class.
+
+
+
Pill badges
+
Use the .rounded-pill utility class to make badges more rounded with a larger border-radius.
Indicate the current page’s location within a navigational hierarchy that automatically adds separators via CSS.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Example
+
Use an ordered or unordered list with linked list items to create a minimally styled breadcrumb. Use our utilities to add additional styles as desired.
Dividers are automatically added in CSS through ::before and content. They can be changed by modifying a local CSS custom property --bs-breadcrumb-divider, or through the $breadcrumb-divider Sass variable — and $breadcrumb-divider-flipped for its RTL counterpart, if needed. We default to our Sass variable, which is set as a fallback to the custom property. This way, you get a global divider that you can override without recompiling CSS at any time.
You can also remove the divider setting --bs-breadcrumb-divider: ''; (empty strings in CSS custom properties counts as a value), or setting the Sass variable to $breadcrumb-divider: none;.
Since breadcrumbs provide a navigation, it’s a good idea to add a meaningful label such as aria-label="breadcrumb" to describe the type of navigation provided in the <nav> element, as well as applying an aria-current="page" to the last item of the set to indicate that it represents the current page.
In order for assistive technologies (such as screen readers) to convey that a series of buttons is grouped, an appropriate role attribute needs to be provided. For button groups, this would be role="group", while toolbars should have a role="toolbar".
+
In addition, groups and toolbars should be given an explicit label, as most assistive technologies will otherwise not announce them, despite the presence of the correct role attribute. In the examples provided here, we use aria-label, but alternatives such as aria-labelledby can also be used.
+
+
+
+
These classes can also be added to groups of links, as an alternative to the .nav navigation components.
Feel free to mix input groups with button groups in your toolbars. Similar to the example above, you’ll likely need some utilities though to space things properly.
Instead of applying button sizing classes to every button in a group, just add .btn-group-* to each .btn-group, including each one when nesting multiple groups.
Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the .visually-hidden class.
+
+
+
Disable text wrapping
+
If you don’t want the button text to wrap, you can add the .text-nowrap class to the button. In Sass, you can set $btn-white-space: nowrap to disable text wrapping for each button.
+
Button tags
+
The .btn classes are designed to be used with the <button> element. However, you can also use these classes on <a> or <input> elements (though some browsers may apply a slightly different rendering).
+
When using button classes on <a> elements that are used to trigger in-page functionality (like collapsing content), rather than linking to new pages or sections within the current page, these links should be given a role="button" to appropriately convey their purpose to assistive technologies such as screen readers.
In need of a button, but not the hefty background colors they bring? Replace the default modifier classes with the .btn-outline-* ones to remove all background images and colors on any button.
+Some of the button styles use a relatively light foreground color, and should only be used on a dark background in order to have sufficient contrast.
+
+
+
Sizes
+
Fancy larger or smaller buttons? Add .btn-lg or .btn-sm for additional sizes.
Make buttons look inactive by adding the disabled boolean attribute to any <button> element. Disabled buttons have pointer-events: none applied to, preventing hover and active states from triggering.
The .disabled class uses pointer-events: none to try to disable the link functionality of <a>s, but that CSS property is not yet standardized. In addition, even in browsers that do support pointer-events: none, keyboard navigation remains unaffected, meaning that sighted keyboard users and users of assistive technologies will still be able to activate these links. So to be safe, in addition to aria-disabled="true", also include a tabindex="-1" attribute on these links to prevent them from receiving keyboard focus, and use custom JavaScript to disable their functionality altogether.
+
+
+
Block buttons
+
Create responsive stacks of full-width, “block buttons” like those in Bootstrap 4 with a mix of our display and gap utilities. By using utilities instead of button specific classes, we have much greater control over spacing, alignment, and responsive behaviors.
Here we create a responsive variation, starting with vertically stacked buttons until the md breakpoint, where .d-md-block replaces the .d-grid class, thus nullifying the gap-2 utility. Resize your browser to see them change.
You can adjust the width of your block buttons with grid column width classes. For example, for a half-width “block button”, use .col-6. Center it horizontally with .mx-auto, too.
Additional utilities can be used to adjust the alignment of buttons when horizontal. Here we’ve taken our previous responsive example and added some flex utilities and a margin utility on the button to right align the buttons when they’re no longer stacked.
The button plugin allows you to create simple on/off toggle buttons.
+
+Visually, these toggle buttons are identical to the checkbox toggle buttons. However, they are conveyed differently by assistive technologies: the checkbox toggles will be announced by screen readers as “checked”/“not checked” (since, despite their appearance, they are fundamentally still checkboxes), whereas these toggle buttons will be announced as “button”/“button pressed”. The choice between these two approaches will depend on the type of toggle you are creating, and whether or not the toggle will make sense to users when announced as a checkbox or as an actual button.
+
+
+
Toggle states
+
Add data-bs-toggle="button" to toggle a button’s active state. If you’re pre-toggling a button, you must manually add the .active class andaria-pressed="true" to ensure that it is conveyed appropriately to assistive technologies.
Bootstrap’s cards provide a flexible and extensible content container with multiple variants and options.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
About
+
A card is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options. If you’re familiar with Bootstrap 3, cards replace our old panels, wells, and thumbnails. Similar functionality to those components is available as modifier classes for cards.
+
Example
+
Cards are built with as little markup and styles as possible, but still manage to deliver a ton of control and customization. Built with flexbox, they offer easy alignment and mix well with other Bootstrap components. They have no margin by default, so use spacing utilities as needed.
+
Below is an example of a basic card with mixed content and a fixed width. Cards have no fixed width to start, so they’ll naturally fill the full width of its parent element. This is easily customized with our various sizing options.
+
+
+
+
+
+
Card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
<divclass="card"style="width: 18rem;">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ <ahref="#"class="btn btn-primary">Go somewhere</a>
+ </div>
+</div>
+
Content types
+
Cards support a wide variety of content, including images, text, list groups, links, and more. Below are examples of what’s supported.
+
Body
+
The building block of a card is the .card-body. Use it whenever you need a padded section within a card.
+
+
+
+ This is some text within a card body.
+
+
+
<divclass="card">
+ <divclass="card-body">
+ This is some text within a card body.
+ </div>
+</div>
+
Titles, text, and links
+
Card titles are used by adding .card-title to a <h*> tag. In the same way, links are added and placed next to each other by adding .card-link to an <a> tag.
+
Subtitles are used by adding a .card-subtitle to a <h*> tag. If the .card-title and the .card-subtitle items are placed in a .card-body item, the card title and subtitle are aligned nicely.
+
+
+
+
Card title
+
Card subtitle
+
Some quick example text to build on the card title and make up the bulk of the card's content.
<divclass="card"style="width: 18rem;">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <h6class="card-subtitle mb-2 text-muted">Card subtitle</h6>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ <ahref="#"class="card-link">Card link</a>
+ <ahref="#"class="card-link">Another link</a>
+ </div>
+</div>
+
Images
+
.card-img-top places an image to the top of the card. With .card-text, text can be added to the card. Text within .card-text can also be styled with the standard HTML tags.
+
+
+
+
+
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
<divclass="card"style="width: 18rem;">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+
List groups
+
Create lists of content in a card with a flush list group.
Mix and match multiple content types to create the card you need, or throw everything in there. Shown below are image styles, blocks, text styles, and a list group—all wrapped in a fixed-width card.
+
+
+
+
+
+
Card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
<divclass="card"style="width: 18rem;">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+ <ulclass="list-group list-group-flush">
+ <liclass="list-group-item">Cras justo odio</li>
+ <liclass="list-group-item">Dapibus ac facilisis in</li>
+ <liclass="list-group-item">Vestibulum at eros</li>
+ </ul>
+ <divclass="card-body">
+ <ahref="#"class="card-link">Card link</a>
+ <ahref="#"class="card-link">Another link</a>
+ </div>
+</div>
+
Header and footer
+
Add an optional header and/or footer within a card.
+
+
+
+ Featured
+
+
+
Special title treatment
+
With supporting text below as a natural lead-in to additional content.
<divclass="card text-center">
+ <divclass="card-header">
+ Featured
+ </div>
+ <divclass="card-body">
+ <h5class="card-title">Special title treatment</h5>
+ <pclass="card-text">With supporting text below as a natural lead-in to additional content.</p>
+ <ahref="#"class="btn btn-primary">Go somewhere</a>
+ </div>
+ <divclass="card-footer text-muted">
+ 2 days ago
+ </div>
+</div>
+
Sizing
+
Cards assume no specific width to start, so they’ll be 100% wide unless otherwise stated. You can change this as needed with custom CSS, grid classes, grid Sass mixins, or utilities.
+
Using grid markup
+
Using the grid, wrap cards in columns and rows as needed.
+
+
+
+
+
+
Special title treatment
+
With supporting text below as a natural lead-in to additional content.
Cards include a few options for working with images. Choose from appending “image caps” at either end of a card, overlaying images with card content, or simply embedding the image in a card.
+
Image caps
+
Similar to headers and footers, cards can include top and bottom “image caps”—images at the top or bottom of a card.
+
+
+
+
+
+
Card title
+
This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
Last updated 3 mins ago
+
+
+
+
+
Card title
+
This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
Last updated 3 mins ago
+
+
+
+
+
<divclass="card mb-3">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ <pclass="card-text"><smallclass="text-muted">Last updated 3 mins ago</small></p>
+ </div>
+</div>
+<divclass="card">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ <pclass="card-text"><smallclass="text-muted">Last updated 3 mins ago</small></p>
+ </div>
+ <imgsrc="..."class="card-img-bottom"alt="...">
+</div>
+
Image overlays
+
Turn an image into a card background and overlay your card’s text. Depending on the image, you may or may not need additional styles or utilities.
+
+
+
+
+
+
Card title
+
This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
Last updated 3 mins ago
+
+
+
<divclass="card bg-dark text-white">
+ <imgsrc="..."class="card-img"alt="...">
+ <divclass="card-img-overlay">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ <pclass="card-text">Last updated 3 mins ago</p>
+ </div>
+</div>
+
+Note that content should not be larger than the height of the image. If content is larger than the image the content will be displayed outside the image.
+
+
+
Horizontal
+
Using a combination of grid and utility classes, cards can be made horizontal in a mobile-friendly and responsive way. In the example below, we remove the grid gutters with .g-0 and use .col-md-* classes to make the card horizontal at the md breakpoint. Further adjustments may be needed depending on your card content.
+
+
+
+
+
+
+
+
+
+
Card title
+
This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
Last updated 3 mins ago
+
+
+
+
+
<divclass="card mb-3"style="max-width: 540px;">
+ <divclass="row g-0">
+ <divclass="col-md-4">
+ <imgsrc="..."alt="...">
+ </div>
+ <divclass="col-md-8">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ <pclass="card-text"><smallclass="text-muted">Last updated 3 mins ago</small></p>
+ </div>
+ </div>
+ </div>
+</div>
+
Card styles
+
Cards include various options for customizing their backgrounds, borders, and color.
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Secondary card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Success card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Danger card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Warning card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Info card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Light card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Dark card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
<divclass="card text-white bg-primary mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body">
+ <h5class="card-title">Primary card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card text-white bg-secondary mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body">
+ <h5class="card-title">Secondary card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card text-white bg-success mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body">
+ <h5class="card-title">Success card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card text-white bg-danger mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body">
+ <h5class="card-title">Danger card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card text-dark bg-warning mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body">
+ <h5class="card-title">Warning card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card text-dark bg-info mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body">
+ <h5class="card-title">Info card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card text-dark bg-light mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body">
+ <h5class="card-title">Light card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card text-white bg-dark mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body">
+ <h5class="card-title">Dark card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+
+
Conveying meaning to assistive technologies
+
Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the .visually-hidden class.
+
+
+
Border
+
Use border utilities to change just the border-color of a card. Note that you can put .text-{color} classes on the parent .card or a subset of the card’s contents as shown below.
+
+
+
+
Header
+
+
Primary card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Secondary card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Success card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Danger card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Warning card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Info card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Light card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
Header
+
+
Dark card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
<divclass="card border-primary mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body text-primary">
+ <h5class="card-title">Primary card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card border-secondary mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body text-secondary">
+ <h5class="card-title">Secondary card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card border-success mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body text-success">
+ <h5class="card-title">Success card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card border-danger mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body text-danger">
+ <h5class="card-title">Danger card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card border-warning mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body">
+ <h5class="card-title">Warning card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card border-info mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body">
+ <h5class="card-title">Info card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card border-light mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body">
+ <h5class="card-title">Light card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+<divclass="card border-dark mb-3"style="max-width: 18rem;">
+ <divclass="card-header">Header</div>
+ <divclass="card-body text-dark">
+ <h5class="card-title">Dark card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+</div>
+
Mixins utilities
+
You can also change the borders on the card header and footer as needed, and even remove their background-color with .bg-transparent.
+
+
+
Header
+
+
Success card title
+
Some quick example text to build on the card title and make up the bulk of the card's content.
+
+
+
+
<divclass="card border-success mb-3"style="max-width: 18rem;">
+ <divclass="card-header bg-transparent border-success">Header</div>
+ <divclass="card-body text-success">
+ <h5class="card-title">Success card title</h5>
+ <pclass="card-text">Some quick example text to build on the card title and make up the bulk of the card's content.</p>
+ </div>
+ <divclass="card-footer bg-transparent border-success">Footer</div>
+</div>
+
Card layout
+
In addition to styling the content within cards, Bootstrap includes a few options for laying out series of cards. For the time being, these layout options are not yet responsive.
+
Card groups
+
Use card groups to render cards as a single, attached element with equal width and height columns. Card groups start off stacked and use display: flex; to become attached with uniform dimensions starting at the sm breakpoint.
+
+
+
+
+
+
+
Card title
+
This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
Last updated 3 mins ago
+
+
+
+
+
+
+
Card title
+
This card has supporting text below as a natural lead-in to additional content.
+
Last updated 3 mins ago
+
+
+
+
+
+
+
Card title
+
This is a wider card with supporting text below as a natural lead-in to additional content. This card has even longer content than the first to show that equal height action.
+
Last updated 3 mins ago
+
+
+
+
<divclass="card-group">
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ <pclass="card-text"><smallclass="text-muted">Last updated 3 mins ago</small></p>
+ </div>
+ </div>
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This card has supporting text below as a natural lead-in to additional content.</p>
+ <pclass="card-text"><smallclass="text-muted">Last updated 3 mins ago</small></p>
+ </div>
+ </div>
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a wider card with supporting text below as a natural lead-in to additional content. This card has even longer content than the first to show that equal height action.</p>
+ <pclass="card-text"><smallclass="text-muted">Last updated 3 mins ago</small></p>
+ </div>
+ </div>
+</div>
+
When using card groups with footers, their content will automatically line up.
+
+
+
+
+
+
+
Card title
+
This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
+
+
+
+
+
+
+
Card title
+
This card has supporting text below as a natural lead-in to additional content.
+
+
+
+
+
+
+
+
Card title
+
This is a wider card with supporting text below as a natural lead-in to additional content. This card has even longer content than the first to show that equal height action.
+
+
+
+
+
<divclass="card-group">
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ </div>
+ <divclass="card-footer">
+ <smallclass="text-muted">Last updated 3 mins ago</small>
+ </div>
+ </div>
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This card has supporting text below as a natural lead-in to additional content.</p>
+ </div>
+ <divclass="card-footer">
+ <smallclass="text-muted">Last updated 3 mins ago</small>
+ </div>
+ </div>
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a wider card with supporting text below as a natural lead-in to additional content. This card has even longer content than the first to show that equal height action.</p>
+ </div>
+ <divclass="card-footer">
+ <smallclass="text-muted">Last updated 3 mins ago</small>
+ </div>
+ </div>
+</div>
+
Grid cards
+
Use the Bootstrap grid system and its .row-cols classes to control how many grid columns (wrapped around your cards) you show per row. For example, here’s .row-cols-1 laying out the cards on one column, and .row-cols-md-2 splitting four cards to equal width across multiple rows, from the medium breakpoint up.
+
+
+
+
+
+
+
+
Card title
+
This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
+
+
+
+
+
+
+
+
Card title
+
This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
+
+
+
+
+
+
+
+
Card title
+
This is a longer card with supporting text below as a natural lead-in to additional content.
+
+
+
+
+
+
+
+
+
Card title
+
This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
+
+
+
+
<divclass="row row-cols-1 row-cols-md-2 g-4">
+ <divclass="col">
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ </div>
+ </div>
+ </div>
+ <divclass="col">
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ </div>
+ </div>
+ </div>
+ <divclass="col">
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a longer card with supporting text below as a natural lead-in to additional content.</p>
+ </div>
+ </div>
+ </div>
+ <divclass="col">
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ </div>
+ </div>
+ </div>
+</div>
+
Change it to .row-cols-3 and you’ll see the fourth card wrap.
+
+
+
+
+
+
+
+
Card title
+
This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
+
+
+
+
+
+
+
+
Card title
+
This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
+
+
+
+
+
+
+
+
Card title
+
This is a longer card with supporting text below as a natural lead-in to additional content.
+
+
+
+
+
+
+
+
+
Card title
+
This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
+
+
+
+
<divclass="row row-cols-1 row-cols-md-3 g-4">
+ <divclass="col">
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ </div>
+ </div>
+ </div>
+ <divclass="col">
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ </div>
+ </div>
+ </div>
+ <divclass="col">
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a longer card with supporting text below as a natural lead-in to additional content.</p>
+ </div>
+ </div>
+ </div>
+ <divclass="col">
+ <divclass="card">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ </div>
+ </div>
+ </div>
+</div>
+
When you need equal height, add .h-100 to the cards. If you want equal heights by default, you can set $card-height: 100% in Sass.
+
+
+
+
+
+
+
+
Card title
+
This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
+
+
+
+
+
+
+
+
Card title
+
This is a short card.
+
+
+
+
+
+
+
+
+
Card title
+
This is a longer card with supporting text below as a natural lead-in to additional content.
+
+
+
+
+
+
+
+
+
Card title
+
This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
+
+
+
+
<divclass="row row-cols-1 row-cols-md-3 g-4">
+ <divclass="col">
+ <divclass="card h-100">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ </div>
+ </div>
+ </div>
+ <divclass="col">
+ <divclass="card h-100">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a short card.</p>
+ </div>
+ </div>
+ </div>
+ <divclass="col">
+ <divclass="card h-100">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a longer card with supporting text below as a natural lead-in to additional content.</p>
+ </div>
+ </div>
+ </div>
+ <divclass="col">
+ <divclass="card h-100">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a longer card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ </div>
+ </div>
+ </div>
+</div>
+
Just like with card groups, card footers will automatically line up.
+
+
+
+
+
+
+
+
Card title
+
This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.
+
+
+
+
+
+
+
+
+
+
Card title
+
This card has supporting text below as a natural lead-in to additional content.
+
+
+
+
+
+
+
+
+
+
Card title
+
This is a wider card with supporting text below as a natural lead-in to additional content. This card has even longer content than the first to show that equal height action.
+
+
+
+
+
+
<divclass="row row-cols-1 row-cols-md-3 g-4">
+ <divclass="col">
+ <divclass="card h-100">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.</p>
+ </div>
+ <divclass="card-footer">
+ <smallclass="text-muted">Last updated 3 mins ago</small>
+ </div>
+ </div>
+ </div>
+ <divclass="col">
+ <divclass="card h-100">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This card has supporting text below as a natural lead-in to additional content.</p>
+ </div>
+ <divclass="card-footer">
+ <smallclass="text-muted">Last updated 3 mins ago</small>
+ </div>
+ </div>
+ </div>
+ <divclass="col">
+ <divclass="card h-100">
+ <imgsrc="..."class="card-img-top"alt="...">
+ <divclass="card-body">
+ <h5class="card-title">Card title</h5>
+ <pclass="card-text">This is a wider card with supporting text below as a natural lead-in to additional content. This card has even longer content than the first to show that equal height action.</p>
+ </div>
+ <divclass="card-footer">
+ <smallclass="text-muted">Last updated 3 mins ago</small>
+ </div>
+ </div>
+ </div>
+</div>
+
Masonry
+
In v4 we used a CSS-only technique to mimic the behavior of Masonry-like columns, but this technique came with lots of unpleasant side effects. If you want to have this type of layout in v5, you can just make use of Masonry plugin. Masonry is not included in Bootstrap, but we’ve made a demo example to help you get started.
A slideshow component for cycling through elements—images or slides of text—like a carousel.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
How it works
+
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.
+
In browsers where the Page Visibility API 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.).
Please be aware that nested carousels are not supported, and carousels are generally not compliant with accessibility standards.
+
Example
+
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.
+
The .active class needs to be added to one of the slides otherwise the carousel will not be visible. Also be sure to set a unique id on the .carousel for optional controls, especially if you’re using multiple carousels on a single page. Control and indicator elements must have a data-bs-target attribute (or href for links) that matches the id of the .carousel element.
+
Slides only
+
Here’s a carousel with slides only. Note the presence of the .d-block and .w-100 on carousel images to prevent browser default image alignment.
Add captions to your slides easily with the .carousel-caption element within any .carousel-item. They can be easily hidden on smaller viewports, as shown below, with optional display utilities. We hide them initially with .d-none and bring them back on medium-sized devices with .d-md-block.
+
+
+
+
+
+
+
+
+
+
+
+
+
First slide label
+
Nulla vitae elit libero, a pharetra augue mollis interdum.
+
+
+
+
+
+
+
Second slide label
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+
+
+
+
+
+
+
Third slide label
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur.
Add .carousel-dark to the .carousel for darker controls, indicators, and captions. Controls have been inverted from their default white fill with the filter CSS property. Captions and controls have additional Sass variables that customize the color and background-color.
+
+
+
+
+
+
+
+
+
+
+
+
+
First slide label
+
Nulla vitae elit libero, a pharetra augue mollis interdum.
+
+
+
+
+
+
+
Second slide label
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+
+
+
+
+
+
+
Third slide label
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur.
Use data attributes to easily control the position of the carousel. data-bs-slide accepts the keywords prev or next, which alters the slide position relative to its current position. Alternatively, use data-bs-slide-to to pass a raw slide index to the carousel data-bs-slide-to="2", which shifts the slide position to a particular index beginning with 0.
+
The data-bs-ride="carousel" attribute is used to mark a carousel as animating starting at page load. If you don’t use data-bs-ride="carousel" to initialize your carousel, you have to initialize it yourself. It cannot be used in combination with (redundant and unnecessary) explicit JavaScript initialization of the same carousel.
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-bs-, as in data-bs-interval="".
+
+
+
+
Name
+
Type
+
Default
+
Description
+
+
+
+
+
interval
+
number
+
5000
+
The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.
+
+
+
keyboard
+
boolean
+
true
+
Whether the carousel should react to keyboard events.
+
+
+
pause
+
string | boolean
+
"hover"
+
If set to "hover", pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave. If set to false, hovering over the carousel won't pause it.
+
On touch-enabled devices, when set to "hover", cycling will pause on touchend (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.
+
+
+
slide
+
string | boolean
+
false
+
Autoplays the carousel after the user manually cycles the first item. If "carousel", autoplays the carousel on load.
+
+
+
wrap
+
boolean
+
true
+
Whether the carousel should cycle continuously or have hard stops.
+
+
+
touch
+
boolean
+
true
+
Whether the carousel should support left/right swipe interactions on touchscreen devices.
+
+
+
+
Methods
+
+
Asynchronous methods and transitions
+
All API methods are asynchronous and start a transition. They return to the caller as soon as the transition is started but before it ends. In addition, a method call on a transitioning component will be ignored.
Cycles through the carousel items from left to right.
+
+
+
pause
+
Stops the carousel from cycling through items.
+
+
+
prev
+
Cycles to the previous item. Returns to the caller before the previous item has been shown (e.g., before the slid.bs.carousel event occurs).
+
+
+
next
+
Cycles to the next item. Returns to the caller before the next item has been shown (e.g., before the slid.bs.carousel event occurs).
+
+
+
nextWhenVisible
+
Don't cycle carousel to next when the page isn't visible or the carousel or its parent isn't visible. Returns to the caller before the target item has been shown
+
+
+
to
+
Cycles the carousel to a particular frame (0 based, similar to an array). Returns to the caller before the target item has been shown (e.g., before the slid.bs.carousel event occurs).
+
+
+
dispose
+
Destroys an element's carousel. (Removes stored data on the DOM element)
+
+
+
getInstance
+
Static method which allows you to get the carousel instance associated with a DOM element.
+
+
+
+
Events
+
Bootstrap’s carousel class exposes two events for hooking into carousel functionality. Both events have the following additional properties:
+
+
direction: The direction in which the carousel is sliding (either "left" or "right").
+
relatedTarget: The DOM element that is being slid into place as the active item.
+
from: The index of the current item
+
to: The index of the next item
+
+
All carousel events are fired at the carousel itself (i.e. at the <div class="carousel">).
+
+
+
+
Event type
+
Description
+
+
+
+
+
slide.bs.carousel
+
Fires immediately when the slide instance method is invoked.
+
+
+
slid.bs.carousel
+
Fired when the carousel has completed its slide transition.
+
+
+
+
varmyCarousel=document.getElementById('myCarousel')
+
+myCarousel.addEventListener('slide.bs.carousel',function(){
+ // do something...
+})
+
Change transition duration
+
The transition duration of .carousel-item can be changed with the $carousel-transition 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. transition: transform 2s ease, opacity .5s ease-out).
A generic close button for dismissing content like modals and alerts.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Example
+
Provide an option to dismiss or close a component with .btn-close. Default styling is limited, but highly customizable. Modify the Sass variables to replace the default background-image. Be sure to include text for screen readers, as we’ve done with aria-label.
Disabled close buttons change their opacity. We’ve also applied pointer-events: none and user-select: none to preventing hover and active states from triggering.
Toggle the visibility of content across your project with a few classes and our JavaScript plugins.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
How it works
+
The collapse JavaScript plugin is used to show and hide content. Buttons or anchors are used as triggers that are mapped to specific elements you toggle. Collapsing an element will animate the height from its current value to 0. Given how CSS handles animations, you cannot use padding on a .collapse element. Instead, use the class as an independent wrapping element.
+ Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident.
+
+
+
<p>
+ <aclass="btn btn-primary"data-bs-toggle="collapse"href="#collapseExample"role="button"aria-expanded="false"aria-controls="collapseExample">
+ Link with href
+ </a>
+ <buttonclass="btn btn-primary"type="button"data-bs-toggle="collapse"data-bs-target="#collapseExample"aria-expanded="false"aria-controls="collapseExample">
+ Button with data-bs-target
+ </button>
+</p>
+<divclass="collapse"id="collapseExample">
+ <divclass="card card-body">
+ Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident.
+ </div>
+</div>
+
Multiple targets
+
A <button> or <a> can show and hide multiple elements by referencing them with a selector in its href or data-bs-target attribute.
+Multiple <button> or <a> can show and hide an element if they each reference it with their href or data-bs-target attribute
+ Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident.
+
+
+
+
+
+
+ Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident.
+
+
+
+
+
<p>
+ <aclass="btn btn-primary"data-bs-toggle="collapse"href="#multiCollapseExample1"role="button"aria-expanded="false"aria-controls="multiCollapseExample1">Toggle first element</a>
+ <buttonclass="btn btn-primary"type="button"data-bs-toggle="collapse"data-bs-target="#multiCollapseExample2"aria-expanded="false"aria-controls="multiCollapseExample2">Toggle second element</button>
+ <buttonclass="btn btn-primary"type="button"data-bs-toggle="collapse"data-bs-target=".multi-collapse"aria-expanded="false"aria-controls="multiCollapseExample1 multiCollapseExample2">Toggle both elements</button>
+</p>
+<divclass="row">
+ <divclass="col">
+ <divclass="collapse multi-collapse"id="multiCollapseExample1">
+ <divclass="card card-body">
+ Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident.
+ </div>
+ </div>
+ </div>
+ <divclass="col">
+ <divclass="collapse multi-collapse"id="multiCollapseExample2">
+ <divclass="card card-body">
+ Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident.
+ </div>
+ </div>
+ </div>
+</div>
+
Accessibility
+
Be sure to add aria-expanded to the control element. This attribute explicitly conveys the current state of the collapsible element tied to the control to screen readers and similar assistive technologies. If the collapsible element is closed by default, the attribute on the control element should have a value of aria-expanded="false". If you’ve set the collapsible element to be open by default using the show class, set aria-expanded="true" on the control instead. The plugin will automatically toggle this attribute on the control based on whether or not the collapsible element has been opened or closed (via JavaScript, or because the user triggered another control element also tied to the same collapsible element). If the control element’s HTML element is not a button (e.g., an <a> or <div>), the attribute role="button" should be added to the element.
+
If your control element is targeting a single collapsible element – i.e. the data-bs-target attribute is pointing to an id selector – you should add the aria-controls attribute to the control element, containing the id of the collapsible element. Modern screen readers and similar assistive technologies make use of this attribute to provide users with additional shortcuts to navigate directly to the collapsible element itself.
+
Note that Bootstrap’s current implementation does not cover the various optional keyboard interactions described in the WAI-ARIA Authoring Practices 1.1 accordion pattern - you will need to include these yourself with custom JavaScript.
+
Usage
+
The collapse plugin utilizes a few classes to handle the heavy lifting:
+
+
.collapse hides the content
+
.collapse.show shows the content
+
.collapsing is added when the transition starts, and removed when it finishes
+
+
These classes can be found in _transitions.scss.
+
Via data attributes
+
Just add data-bs-toggle="collapse" and a data-bs-target to the element to automatically assign control of one or more collapsible elements. The data-bs-target attribute accepts a CSS selector to apply the collapse to. Be sure to add the class collapse to the collapsible element. If you’d like it to default open, add the additional class show.
+
To add accordion-like group management to a collapsible area, add the data attribute data-bs-parent="#selector". Refer to the demo to see this in action.
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-bs-, as in data-bs-parent="".
+
+
+
+
Name
+
Type
+
Default
+
Description
+
+
+
+
+
parent
+
selector | jQuery object | DOM element
+
false
+
If parent is provided, then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this is dependent on the card class). The attribute has to be set on the target collapsible area.
+
+
+
toggle
+
boolean
+
true
+
Toggles the collapsible element on invocation
+
+
+
+
Methods
+
+
Asynchronous methods and transitions
+
All API methods are asynchronous and start a transition. They return to the caller as soon as the transition is started but before it ends. In addition, a method call on a transitioning component will be ignored.
Toggles a collapsible element to shown or hidden. Returns to the caller before the collapsible element has actually been shown or hidden (i.e. before the shown.bs.collapse or hidden.bs.collapse event occurs).
+
+
+
show
+
Shows a collapsible element. Returns to the caller before the collapsible element has actually been shown (e.g., before the shown.bs.collapse event occurs).
+
+
+
hide
+
Hides a collapsible element. Returns to the caller before the collapsible element has actually been hidden (e.g., before the hidden.bs.collapse event occurs).
+
+
+
dispose
+
Destroys an element's collapse. (Removes stored data on the DOM element)
+
+
+
getInstance
+
Static method which allows you to get the collapse instance associated with a DOM element.
+
+
+
+
Events
+
Bootstrap’s collapse class exposes a few events for hooking into collapse functionality.
+
+
+
+
Event type
+
Description
+
+
+
+
+
show.bs.collapse
+
This event fires immediately when the show instance method is called.
+
+
+
shown.bs.collapse
+
This event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).
+
+
+
hide.bs.collapse
+
This event is fired immediately when the hide method has been called.
+
+
+
hidden.bs.collapse
+
This event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete).
+
+
+
+
varmyCollapsible=document.getElementById('myCollapsible')
+myCollapsible.addEventListener('hidden.bs.collapse',function(){
+ // do something...
+})
+
Toggle contextual overlays for displaying lists of links and more with the Bootstrap dropdown plugin.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Overview
+
Dropdowns are toggleable, contextual overlays for displaying lists of links and more. They’re made interactive with the included Bootstrap dropdown JavaScript plugin. They’re toggled by clicking, not by hovering; this is an intentional design decision.
+
Dropdowns are built on a third party library, Popper, which provides dynamic positioning and viewport detection. Be sure to include popper.min.js before Bootstrap’s JavaScript or use bootstrap.bundle.min.js / bootstrap.bundle.js which contains Popper. Popper isn’t used to position dropdowns in navbars though as dynamic positioning isn’t required.
+
Accessibility
+
The WAI ARIA standard defines an actual role="menu" widget, but this is specific to application-like menus which trigger actions or functions. ARIA menus can only contain menu items, checkbox menu items, radio button menu items, radio button groups, and sub-menus.
+
Bootstrap’s dropdowns, on the other hand, are designed to be generic and applicable to a variety of situations and markup structures. For instance, it is possible to create dropdowns that contain additional inputs and form controls, such as search fields or login forms. For this reason, Bootstrap does not expect (nor automatically add) any of the role and aria- attributes required for true ARIA menus. Authors will have to include these more specific attributes themselves.
+
However, Bootstrap does add built-in support for most standard keyboard menu interactions, such as the ability to move through individual .dropdown-item elements using the cursor keys and close the menu with the ESC key.
+
Examples
+
Wrap the dropdown’s toggle (your button or link) and the dropdown menu within .dropdown, or another element that declares position: relative;. Dropdowns can be triggered from <a> or <button> elements to better fit your potential needs. The examples shown here use semantic <ul> elements where appropriate, but custom markup is supported.
+
Single button
+
Any single .btn can be turned into a dropdown toggle with some markup changes. Here’s how you can put them to work with either <button> elements:
Similarly, create split button dropdowns with virtually the same markup as single button dropdowns, but with the addition of .dropdown-toggle-split for proper spacing around the dropdown caret.
+
We use this extra class to reduce the horizontal padding on either side of the caret by 25% and remove the margin-left that’s added for regular button dropdowns. Those extra changes keep the caret centered in the split button and provide a more appropriately sized hit area next to the main button.
Opt into darker dropdowns to match a dark navbar or custom style by adding .dropdown-menu-dark onto an existing .dropdown-menu. No changes are required to the dropdown items.
Historically dropdown menu contents had to be links, but that’s no longer the case with v4. Now you can optionally use <button> elements in your dropdowns instead of just <a>s.
Add .active to items in the dropdown to style them as active. To convey the active state to assistive technologies, use the aria-current attribute — using the page value for the current page, or true for the current item in a set.
By default, a dropdown menu is automatically positioned 100% from the top and along the left side of its parent. Add .dropdown-menu-end to a .dropdown-menu to right align the dropdown menu. Directions are mirrored when using Bootstrap in RTL, meaning .dropdown-menu-end will appear on the left side.
+
+Heads up! Dropdowns are positioned thanks to Popper (except when they are contained in a navbar).
+
If you want to use responsive alignment, disable dynamic positioning by adding the data-bs-display="static" attribute and use the responsive variation classes.
+
To align right the dropdown menu with the given breakpoint or larger, add .dropdown-menu{-sm|-md|-lg|-xl|-xxl}-end.
+
+
+
+
+
+
+
+
+
+
<divclass="btn-group">
+ <buttontype="button"class="btn btn-secondary dropdown-toggle"data-bs-toggle="dropdown"data-bs-display="static"aria-expanded="false">
+ Left-aligned but right aligned when large screen
+ </button>
+ <ulclass="dropdown-menu dropdown-menu-lg-end">
+ <li><buttonclass="dropdown-item"type="button">Action</button></li>
+ <li><buttonclass="dropdown-item"type="button">Another action</button></li>
+ <li><buttonclass="dropdown-item"type="button">Something else here</button></li>
+ </ul>
+</div>
+
To align left the dropdown menu with the given breakpoint or larger, add .dropdown-menu-end and .dropdown-menu{-sm|-md|-lg|-xl|-xxl}-start.
+
+
+
+
+
+
+
+
+
+
<divclass="btn-group">
+ <buttontype="button"class="btn btn-secondary dropdown-toggle"data-bs-toggle="dropdown"data-bs-display="static"aria-expanded="false">
+ Right-aligned but left aligned when large screen
+ </button>
+ <ulclass="dropdown-menu dropdown-menu-end dropdown-menu-lg-start">
+ <li><buttonclass="dropdown-item"type="button">Action</button></li>
+ <li><buttonclass="dropdown-item"type="button">Another action</button></li>
+ <li><buttonclass="dropdown-item"type="button">Something else here</button></li>
+ </ul>
+</div>
+
Note that you don’t need to add a data-bs-display="static" attribute to dropdown buttons in navbars, since Popper isn’t used in navbars.
+
Menu content
+
Headers
+
Add a header to label sections of actions in any dropdown menu.
Place any freeform text within a dropdown menu with text and use spacing utilities. Note that you’ll likely need additional sizing styles to constrain the menu width.
+
+
+
+ Some example text that's free-flowing within the dropdown menu.
+
+
+ And this is more example text.
+
+
+
<divclass="dropdown-menu p-4 text-muted"style="max-width: 200px;">
+ <p>
+ Some example text that's free-flowing within the dropdown menu.
+ </p>
+ <pclass="mb-0">
+ And this is more example text.
+ </p>
+</div>
+
Forms
+
Put a form within a dropdown menu, or make it into a dropdown menu, and use margin or padding utilities to give it the negative space you require.
Via data attributes or JavaScript, the dropdown plugin toggles hidden content (dropdown menus) by toggling the .show class on the parent .dropdown-menu. The data-bs-toggle="dropdown" attribute is relied on for closing dropdown menus at an application level, so it’s a good idea to always use it.
+
+On touch-enabled devices, opening a dropdown adds empty mouseover handlers to the immediate children of the <body> element. This admittedly ugly hack is necessary to work around a quirk in iOS' event delegation, which would otherwise prevent a tap anywhere outside of the dropdown from triggering the code that closes the dropdown. Once the dropdown is closed, these additional empty mouseover handlers are removed.
+
+
+
Via data attributes
+
Add data-bs-toggle="dropdown" to a link or button to toggle a dropdown.
Regardless of whether you call your dropdown via JavaScript or instead use the data-api, data-bs-toggle="dropdown" is always required to be present on the dropdown’s trigger element.
+
+
+
Options
+
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-bs-, as in data-bs-offset="".
+
+
+
+
Name
+
Type
+
Default
+
Description
+
+
+
+
+
flip
+
boolean
+
true
+
Allow Dropdown to flip in case of an overlapping on the reference element. For more information refer to Popper's flip docs.
+
+
+
boundary
+
string | element
+
'scrollParent'
+
Overflow constraint boundary of the dropdown menu. By default it's 'clippingParents' and can accept an HTMLElement reference (JavaScript only). For more information refer to Popper's preventOverflow docs.
+
+
+
reference
+
string | element
+
'toggle'
+
Reference element of the dropdown menu. Accepts the values of 'toggle', 'parent', or an HTMLElement reference. For more information refer to Popper's constructor docs.
+
+
+
display
+
string
+
'dynamic'
+
By default, we use Popper for dynamic positioning. Disable this with static.
Note when boundary is set to any value other than 'scrollParent', the style position: static is applied to the .dropdown container.
+
Methods
+
+
+
+
Method
+
Description
+
+
+
+
+
toggle
+
+ Toggles the dropdown menu of a given navbar or tabbed navigation.
+
+
+
+
show
+
+ Shows the dropdown menu of a given navbar or tabbed navigation.
+
+
+
+
hide
+
+ Hides the dropdown menu of a given navbar or tabbed navigation.
+
+
+
+
update
+
+ Updates the position of an element's dropdown.
+
+
+
+
dispose
+
+ Destroys an element's dropdown. (Removes stored data on the DOM element)
+
+
+
+
getInstance
+
+ Static method which allows you to get the dropdown instance associated with a DOM element.
+
+
+
+
+
Events
+
All dropdown events are fired at the .dropdown-menu’s parent element and have a relatedTarget property, whose value is the toggling anchor element.
+hide.bs.dropdown and hidden.bs.dropdown events have a clickEvent property (only when the original Event type is click) that contains an Event Object for the click event.
+
+
+
+
Method
+
Description
+
+
+
+
+
+ show.bs.dropdown
+
+
+ Fires immediately when the show instance method is called.
+
+
+
+
+ shown.bs.dropdown
+
+
+ Fired when the dropdown has been made visible to the user and CSS transitions have completed.
+
+
+
+
+ hide.bs.dropdown
+
+
+ Fires immediately when the hide instance method has been called.
+
+
+
+
+ hidden.bs.dropdown
+
+
+ Fired when the dropdown has finished being hidden from the user and CSS transitions have completed.
+
+
+
+
+
varmyDropdown=document.getElementById('myDropdown')
+myDropdown.addEventListener('show.bs.dropdown',function(){
+ // do something...
+})
+
List groups are a flexible and powerful component for displaying a series of content. Modify and extend them to support just about any content within.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Basic example
+
The most basic list group is an unordered list with list items and the proper classes. Build upon it with the options that follow, or with your own CSS as needed.
+
+
+
Cras justo odio
+
Dapibus ac facilisis in
+
Morbi leo risus
+
Porta ac consectetur ac
+
Vestibulum at eros
+
+
<ulclass="list-group">
+ <liclass="list-group-item">Cras justo odio</li>
+ <liclass="list-group-item">Dapibus ac facilisis in</li>
+ <liclass="list-group-item">Morbi leo risus</li>
+ <liclass="list-group-item">Porta ac consectetur ac</li>
+ <liclass="list-group-item">Vestibulum at eros</li>
+</ul>
+
Active items
+
Add .active to a .list-group-item to indicate the current active selection.
+
+
+
Cras justo odio
+
Dapibus ac facilisis in
+
Morbi leo risus
+
Porta ac consectetur ac
+
Vestibulum at eros
+
+
<ulclass="list-group">
+ <liclass="list-group-item active"aria-current="true">Cras justo odio</li>
+ <liclass="list-group-item">Dapibus ac facilisis in</li>
+ <liclass="list-group-item">Morbi leo risus</li>
+ <liclass="list-group-item">Porta ac consectetur ac</li>
+ <liclass="list-group-item">Vestibulum at eros</li>
+</ul>
+
Disabled items
+
Add .disabled to a .list-group-item to make it appear disabled. Note that some elements with .disabled will also require custom JavaScript to fully disable their click events (e.g., links).
+
+
+
Cras justo odio
+
Dapibus ac facilisis in
+
Morbi leo risus
+
Porta ac consectetur ac
+
Vestibulum at eros
+
+
<ulclass="list-group">
+ <liclass="list-group-item disabled"aria-disabled="true">Cras justo odio</li>
+ <liclass="list-group-item">Dapibus ac facilisis in</li>
+ <liclass="list-group-item">Morbi leo risus</li>
+ <liclass="list-group-item">Porta ac consectetur ac</li>
+ <liclass="list-group-item">Vestibulum at eros</li>
+</ul>
+
Links and buttons
+
Use <a>s or <button>s to create actionable list group items with hover, disabled, and active states by adding .list-group-item-action. We separate these pseudo-classes to ensure list groups made of non-interactive elements (like <li>s or <div>s) don’t provide a click or tap affordance.
+
Be sure to not use the standard .btn classes here.
<divclass="list-group">
+ <ahref="#"class="list-group-item list-group-item-action active"aria-current="true">
+ Cras justo odio
+ </a>
+ <ahref="#"class="list-group-item list-group-item-action">Dapibus ac facilisis in</a>
+ <ahref="#"class="list-group-item list-group-item-action">Morbi leo risus</a>
+ <ahref="#"class="list-group-item list-group-item-action">Porta ac consectetur ac</a>
+ <ahref="#"class="list-group-item list-group-item-action disabled"tabindex="-1"aria-disabled="true">Vestibulum at eros</a>
+</div>
+
With <button>s, you can also make use of the disabled attribute instead of the .disabled class. Sadly, <a>s don’t support the disabled attribute.
+
+
+
+
+
+
+
+
+
<divclass="list-group">
+ <buttontype="button"class="list-group-item list-group-item-action active"aria-current="true">
+ Cras justo odio
+ </button>
+ <buttontype="button"class="list-group-item list-group-item-action">Dapibus ac facilisis in</button>
+ <buttontype="button"class="list-group-item list-group-item-action">Morbi leo risus</button>
+ <buttontype="button"class="list-group-item list-group-item-action">Porta ac consectetur ac</button>
+ <buttontype="button"class="list-group-item list-group-item-action"disabled>Vestibulum at eros</button>
+</div>
+
Flush
+
Add .list-group-flush to remove some borders and rounded corners to render list group items edge-to-edge in a parent container (e.g., cards).
+
+
+
Cras justo odio
+
Dapibus ac facilisis in
+
Morbi leo risus
+
Porta ac consectetur ac
+
Vestibulum at eros
+
+
<ulclass="list-group list-group-flush">
+ <liclass="list-group-item">Cras justo odio</li>
+ <liclass="list-group-item">Dapibus ac facilisis in</li>
+ <liclass="list-group-item">Morbi leo risus</li>
+ <liclass="list-group-item">Porta ac consectetur ac</li>
+ <liclass="list-group-item">Vestibulum at eros</li>
+</ul>
+
Horizontal
+
Add .list-group-horizontal to change the layout of list group items from vertical to horizontal across all breakpoints. Alternatively, choose a responsive variant .list-group-horizontal-{sm|md|lg|xl|xxl} to make a list group horizontal starting at that breakpoint’s min-width. Currently horizontal list groups cannot be combined with flush list groups.
+
ProTip: Want equal-width list group items when horizontal? Add .flex-fill to each list group item.
+
+
+
+
Cras justo odio
+
Dapibus ac facilisis in
+
Morbi leo risus
+
+
+
Cras justo odio
+
Dapibus ac facilisis in
+
Morbi leo risus
+
+
+
Cras justo odio
+
Dapibus ac facilisis in
+
Morbi leo risus
+
+
+
Cras justo odio
+
Dapibus ac facilisis in
+
Morbi leo risus
+
+
+
Cras justo odio
+
Dapibus ac facilisis in
+
Morbi leo risus
+
+
+
Cras justo odio
+
Dapibus ac facilisis in
+
Morbi leo risus
+
+
<ulclass="list-group list-group-horizontal">
+ <liclass="list-group-item">Cras justo odio</li>
+ <liclass="list-group-item">Dapibus ac facilisis in</li>
+ <liclass="list-group-item">Morbi leo risus</li>
+</ul>
+<ulclass="list-group list-group-horizontal-sm">
+ <liclass="list-group-item">Cras justo odio</li>
+ <liclass="list-group-item">Dapibus ac facilisis in</li>
+ <liclass="list-group-item">Morbi leo risus</li>
+</ul>
+<ulclass="list-group list-group-horizontal-md">
+ <liclass="list-group-item">Cras justo odio</li>
+ <liclass="list-group-item">Dapibus ac facilisis in</li>
+ <liclass="list-group-item">Morbi leo risus</li>
+</ul>
+<ulclass="list-group list-group-horizontal-lg">
+ <liclass="list-group-item">Cras justo odio</li>
+ <liclass="list-group-item">Dapibus ac facilisis in</li>
+ <liclass="list-group-item">Morbi leo risus</li>
+</ul>
+<ulclass="list-group list-group-horizontal-xl">
+ <liclass="list-group-item">Cras justo odio</li>
+ <liclass="list-group-item">Dapibus ac facilisis in</li>
+ <liclass="list-group-item">Morbi leo risus</li>
+</ul>
+<ulclass="list-group list-group-horizontal-xxl">
+ <liclass="list-group-item">Cras justo odio</li>
+ <liclass="list-group-item">Dapibus ac facilisis in</li>
+ <liclass="list-group-item">Morbi leo risus</li>
+</ul>
+
Contextual classes
+
Use contextual classes to style list items with a stateful background and color.
+
+
+
Dapibus ac facilisis in
+
+
A simple primary list group item
+
A simple secondary list group item
+
A simple success list group item
+
A simple danger list group item
+
A simple warning list group item
+
A simple info list group item
+
A simple light list group item
+
A simple dark list group item
+
+
<ulclass="list-group">
+ <liclass="list-group-item">Dapibus ac facilisis in</li>
+
+ <liclass="list-group-item list-group-item-primary">A simple primary list group item</li>
+ <liclass="list-group-item list-group-item-secondary">A simple secondary list group item</li>
+ <liclass="list-group-item list-group-item-success">A simple success list group item</li>
+ <liclass="list-group-item list-group-item-danger">A simple danger list group item</li>
+ <liclass="list-group-item list-group-item-warning">A simple warning list group item</li>
+ <liclass="list-group-item list-group-item-info">A simple info list group item</li>
+ <liclass="list-group-item list-group-item-light">A simple light list group item</li>
+ <liclass="list-group-item list-group-item-dark">A simple dark list group item</li>
+</ul>
+
Contextual classes also work with .list-group-item-action. Note the addition of the hover styles here not present in the previous example. Also supported is the .active state; apply it to indicate an active selection on a contextual list group item.
<divclass="list-group">
+ <ahref="#"class="list-group-item list-group-item-action">Dapibus ac facilisis in</a>
+
+ <ahref="#"class="list-group-item list-group-item-action list-group-item-primary">A simple primary list group item</a>
+ <ahref="#"class="list-group-item list-group-item-action list-group-item-secondary">A simple secondary list group item</a>
+ <ahref="#"class="list-group-item list-group-item-action list-group-item-success">A simple success list group item</a>
+ <ahref="#"class="list-group-item list-group-item-action list-group-item-danger">A simple danger list group item</a>
+ <ahref="#"class="list-group-item list-group-item-action list-group-item-warning">A simple warning list group item</a>
+ <ahref="#"class="list-group-item list-group-item-action list-group-item-info">A simple info list group item</a>
+ <ahref="#"class="list-group-item list-group-item-action list-group-item-light">A simple light list group item</a>
+ <ahref="#"class="list-group-item list-group-item-action list-group-item-dark">A simple dark list group item</a>
+</div>
+
+
Conveying meaning to assistive technologies
+
Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the .visually-hidden class.
+
+
+
With badges
+
Add badges to any list group item to show unread counts, activity, and more with the help of some utilities.
<divclass="list-group">
+ <ahref="#"class="list-group-item list-group-item-action active"aria-current="true">
+ <divclass="d-flex w-100 justify-content-between">
+ <h5class="mb-1">List group item heading</h5>
+ <small>3 days ago</small>
+ </div>
+ <pclass="mb-1">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.</p>
+ <small>Donec id elit non mi porta.</small>
+ </a>
+ <ahref="#"class="list-group-item list-group-item-action">
+ <divclass="d-flex w-100 justify-content-between">
+ <h5class="mb-1">List group item heading</h5>
+ <smallclass="text-muted">3 days ago</small>
+ </div>
+ <pclass="mb-1">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.</p>
+ <smallclass="text-muted">Donec id elit non mi porta.</small>
+ </a>
+ <ahref="#"class="list-group-item list-group-item-action">
+ <divclass="d-flex w-100 justify-content-between">
+ <h5class="mb-1">List group item heading</h5>
+ <smallclass="text-muted">3 days ago</small>
+ </div>
+ <pclass="mb-1">Donec id elit non mi porta gravida at eget metus. Maecenas sed diam eget risus varius blandit.</p>
+ <smallclass="text-muted">Donec id elit non mi porta.</small>
+ </a>
+</div>
+
Checkboxes and radios
+
Place Bootstrap’s checkboxes and radios within list group items and customize as needed. You can use them without <label>s, but please remember to include an aria-label attribute and value for accessibility.
+
+
+
+
+ Cras justo odio
+
+
+
+ Dapibus ac facilisis in
+
+
+
+ Morbi leo risus
+
+
+
+ Porta ac consectetur ac
+
+
+
+ Vestibulum at eros
+
+
+
<ulclass="list-group">
+ <liclass="list-group-item">
+ <inputclass="form-check-input me-1"type="checkbox"value=""aria-label="...">
+ Cras justo odio
+ </li>
+ <liclass="list-group-item">
+ <inputclass="form-check-input me-1"type="checkbox"value=""aria-label="...">
+ Dapibus ac facilisis in
+ </li>
+ <liclass="list-group-item">
+ <inputclass="form-check-input me-1"type="checkbox"value=""aria-label="...">
+ Morbi leo risus
+ </li>
+ <liclass="list-group-item">
+ <inputclass="form-check-input me-1"type="checkbox"value=""aria-label="...">
+ Porta ac consectetur ac
+ </li>
+ <liclass="list-group-item">
+ <inputclass="form-check-input me-1"type="checkbox"value=""aria-label="...">
+ Vestibulum at eros
+ </li>
+</ul>
+
And if you want <label>s as the .list-group-item for large hit areas, you can do that, too.
+
+
+
+
+
+
+
+
+
<divclass="list-group">
+ <labelclass="list-group-item">
+ <inputclass="form-check-input me-1"type="checkbox"value="">
+ Cras justo odio
+ </label>
+ <labelclass="list-group-item">
+ <inputclass="form-check-input me-1"type="checkbox"value="">
+ Dapibus ac facilisis in
+ </label>
+ <labelclass="list-group-item">
+ <inputclass="form-check-input me-1"type="checkbox"value="">
+ Morbi leo risus
+ </label>
+ <labelclass="list-group-item">
+ <inputclass="form-check-input me-1"type="checkbox"value="">
+ Porta ac consectetur ac
+ </label>
+ <labelclass="list-group-item">
+ <inputclass="form-check-input me-1"type="checkbox"value="">
+ Vestibulum at eros
+ </label>
+</div>
+
JavaScript behavior
+
Use the tab JavaScript plugin—include it individually or through the compiled bootstrap.js file—to extend our list group to create tabbable panes of local content.
Velit aute mollit ipsum ad dolor consectetur nulla officia culpa adipisicing exercitation fugiat tempor. Voluptate deserunt sit sunt nisi aliqua fugiat proident ea ut. Mollit voluptate reprehenderit occaecat nisi ad non minim tempor sunt voluptate consectetur exercitation id ut nulla. Ea et fugiat aliquip nostrud sunt incididunt consectetur culpa aliquip eiusmod dolor. Anim ad Lorem aliqua in cupidatat nisi enim eu nostrud do aliquip veniam minim.
+
+
+
Cupidatat quis ad sint excepteur laborum in esse qui. Et excepteur consectetur ex nisi eu do cillum ad laborum. Mollit et eu officia dolore sunt Lorem culpa qui commodo velit ex amet id ex. Officia anim incididunt laboris deserunt anim aute dolor incididunt veniam aute dolore do exercitation. Dolor nisi culpa ex ad irure in elit eu dolore. Ad laboris ipsum reprehenderit irure non commodo enim culpa commodo veniam incididunt veniam ad.
+
+
+
Ut ut do pariatur aliquip aliqua aliquip exercitation do nostrud commodo reprehenderit aute ipsum voluptate. Irure Lorem et laboris nostrud amet cupidatat cupidatat anim do ut velit mollit consequat enim tempor. Consectetur est minim nostrud nostrud consectetur irure labore voluptate irure. Ipsum id Lorem sit sint voluptate est pariatur eu ad cupidatat et deserunt culpa sit eiusmod deserunt. Consectetur et fugiat anim do eiusmod aliquip nulla laborum elit adipisicing pariatur cillum.
+
+
+
Irure enim occaecat labore sit qui aliquip reprehenderit amet velit. Deserunt ullamco ex elit nostrud ut dolore nisi officia magna sit occaecat laboris sunt dolor. Nisi eu minim cillum occaecat aute est cupidatat aliqua labore aute occaecat ea aliquip sunt amet. Aute mollit dolor ut exercitation irure commodo non amet consectetur quis amet culpa. Quis ullamco nisi amet qui aute irure eu. Magna labore dolor quis ex labore id nostrud deserunt dolor eiusmod eu pariatur culpa mollit in irure.
You can activate a list group navigation without writing any JavaScript by simply specifying data-bs-toggle="list" or on an element. Use these data attributes on .list-group-item.
Selects the given list item and shows its associated pane. Any other list item that was previously selected becomes unselected and its associated pane is hidden. Returns to the caller before the tab pane has actually been shown (for example, before the shown.bs.tab event occurs).
Static method which allows you to get the tab instance associated with a DOM element
+
vartriggerEl=document.querySelector('#trigger')
+vartab=bootstrap.Tab.getInstance(triggerEl)// Returns a Bootstrap tab instance
+
Events
+
When showing a new tab, the events fire in the following order:
+
+
hide.bs.tab (on the current active tab)
+
show.bs.tab (on the to-be-shown tab)
+
hidden.bs.tab (on the previous active tab, the same one as for the hide.bs.tab event)
+
shown.bs.tab (on the newly-active just-shown tab, the same one as for the show.bs.tab event)
+
+
If no tab was already active, the hide.bs.tab and hidden.bs.tab events will not be fired.
+
+
+
+
Event type
+
Description
+
+
+
+
+
show.bs.tab
+
This event fires on tab show, but before the new tab has been shown. Use event.target and event.relatedTarget to target the active tab and the previous active tab (if available) respectively.
+
+
+
shown.bs.tab
+
This event fires on tab show after a tab has been shown. Use event.target and event.relatedTarget to target the active tab and the previous active tab (if available) respectively.
+
+
+
hide.bs.tab
+
This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use event.target and event.relatedTarget to target the current active tab and the new soon-to-be-active tab, respectively.
+
+
+
hidden.bs.tab
+
This event fires after a new tab is shown (and thus the previous active tab is hidden). Use event.target and event.relatedTarget to target the previous active tab and the new active tab, respectively.
Use Bootstrap’s JavaScript modal plugin to add dialogs to your site for lightboxes, user notifications, or completely custom content.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
How it works
+
Before getting started with Bootstrap’s modal component, be sure to read the following as our menu options have recently changed.
+
+
Modals are built with HTML, CSS, and JavaScript. They’re positioned over everything else in the document and remove scroll from the <body> so that modal content scrolls instead.
+
Clicking on the modal “backdrop” will automatically close the modal.
+
Bootstrap only supports one modal window at a time. Nested modals aren’t supported as we believe them to be poor user experiences.
+
Modals use position: fixed, which can sometimes be a bit particular about its rendering. Whenever possible, place your modal HTML in a top-level position to avoid potential interference from other elements. You’ll likely run into issues when nesting a .modal within another fixed element.
+
Once again, due to position: fixed, there are some caveats with using modals on mobile devices. See our browser support docs for details.
+
Due to how HTML5 defines its semantics, the autofocus HTML attribute has no effect in Bootstrap modals. To achieve the same effect, use some custom JavaScript:
Below is a static modal example (meaning its position and display have been overridden). Included are the modal header, modal body (required for padding), and modal footer (optional). We ask that you include modal headers with dismiss actions whenever possible, or provide another explicit dismiss action.
When modals become too long for the user’s viewport or device, they scroll independent of the page itself. Try the demo below to see what we mean.
+
+
+
+
+
Modal title
+
+
+
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
+
+
+
+
+
+
+
+
You can also create a scrollable modal that allows scroll the modal body by adding .modal-dialog-scrollable to .modal-dialog.
+
+
+
+
+
Modal title
+
+
+
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
Add .modal-dialog-centered to .modal-dialog to vertically center the modal.
+
+
+
+
+
Modal title
+
+
+
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
+
+
+
+
+
+
+
+
+
Modal title
+
+
+
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
Tooltips and popovers can be placed within modals as needed. When modals are closed, any tooltips and popovers within are also automatically dismissed.
<divclass="modal-body">
+ <h5>Popover in a modal</h5>
+ <p>This <ahref="#"role="button"class="btn btn-secondary popover-test"title="Popover title"data-bs-content="Popover body content is set in this attribute.">button</a> triggers a popover on click.</p>
+ <hr>
+ <h5>Tooltips in a modal</h5>
+ <p><ahref="#"class="tooltip-test"title="Tooltip">This link</a> and <ahref="#"class="tooltip-test"title="Tooltip">that link</a> have tooltips on hover.</p>
+</div>
+
Using the grid
+
Utilize the Bootstrap grid system within a modal by nesting .container-fluid within the .modal-body. Then, use the normal grid system classes as you would anywhere else.
Have a bunch of buttons that all trigger the same modal with slightly different contents? Use event.relatedTarget and HTML data-bs-* attributes to vary the contents of the modal depending on which button was clicked.
+
Below is a live demo followed by example HTML and JavaScript. For more information, read the modal events docs for details on relatedTarget.
varexampleModal=document.getElementById('exampleModal')
+exampleModal.addEventListener('show.bs.modal',function(event){
+ // Button that triggered the modal
+varbutton=event.relatedTarget
+ // Extract info from data-bs-* attributes
+varrecipient=button.getAttribute('data-bs-whatever')
+ // If necessary, you could initiate an AJAX request here
+// and then do the updating in a callback.
+//
+// Update the modal's content.
+varmodalTitle=exampleModal.querySelector('.modal-title')
+ varmodalBodyInput=exampleModal.querySelector('.modal-body input')
+
+ modalTitle.textContent='New message to '+recipient
+ modalBodyInput.value=recipient
+})
+
Change animation
+
The $modal-fade-transform variable determines the transform state of .modal-dialog before the modal fade-in animation, the $modal-show-transform variable determines the transform of .modal-dialog at the end of the modal fade-in animation.
+
If you want for example a zoom-in animation, you can set $modal-fade-transform: scale(.8).
+
Remove animation
+
For modals that simply appear rather than fade in to view, remove the .fade class from your modal markup.
If the height of a modal changes while it is open, you should call myModal.handleUpdate() to readjust the modal’s position in case a scrollbar appears.
+
Accessibility
+
Be sure to add aria-labelledby="...", referencing the modal title, to .modal. Additionally, you may give a description of your modal dialog with aria-describedby on .modal. Note that you don’t need to add role="dialog" since we already add it via JavaScript.
+
Embedding YouTube videos
+
Embedding YouTube videos in modals requires additional JavaScript not in Bootstrap to automatically stop playback and more. See this helpful Stack Overflow post for more information.
+
Optional sizes
+
Modals have three optional sizes, available via modifier classes to be placed on a .modal-dialog. These sizes kick in at certain breakpoints to avoid horizontal scrollbars on narrower viewports.
+
+
+
+
Size
+
Class
+
Modal max-width
+
+
+
+
+
Small
+
.modal-sm
+
300px
+
+
+
Default
+
None
+
500px
+
+
+
Large
+
.modal-lg
+
800px
+
+
+
Extra large
+
.modal-xl
+
1140px
+
+
+
+
Our default modal without modifier class constitutes the “medium” size modal.
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+
Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.
+
+
+
+
+
+
+
+
+
+
Full screen below sm
+
+
+
+ ...
+
+
+
+
+
+
+
+
+
+
Full screen below md
+
+
+
+ ...
+
+
+
+
+
+
+
+
+
+
Full screen below lg
+
+
+
+ ...
+
+
+
+
+
+
+
+
+
+
Full screen below xl
+
+
+
+ ...
+
+
+
+
+
+
+
+
+
+
Full screen below xxl
+
+
+
+ ...
+
+
+
+
+
+
Usage
+
The modal plugin toggles your hidden content on demand, via data attributes or JavaScript. It also adds .modal-open to the <body> to override default scrolling behavior and generates a .modal-backdrop to provide a click area for dismissing shown modals when clicking outside the modal.
+
Via data attributes
+
Activate a modal without writing JavaScript. Set data-bs-toggle="modal" on a controller element, like a button, along with a data-bs-target="#foo" or href="#foo" to target a specific modal to toggle.
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-bs-, as in data-bs-backdrop="".
+
+
+
+
Name
+
Type
+
Default
+
Description
+
+
+
+
+
backdrop
+
boolean or the string 'static'
+
true
+
Includes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn't close the modal on click.
+
+
+
keyboard
+
boolean
+
true
+
Closes the modal when escape key is pressed
+
+
+
focus
+
boolean
+
true
+
Puts the focus on the modal when initialized.
+
+
+
+
Methods
+
+
Asynchronous methods and transitions
+
All API methods are asynchronous and start a transition. They return to the caller as soon as the transition is started but before it ends. In addition, a method call on a transitioning component will be ignored.
Manually toggles a modal. Returns to the caller before the modal has actually been shown or hidden (i.e. before the shown.bs.modal or hidden.bs.modal event occurs).
+
myModal.toggle()
+
show
+
Manually opens a modal. Returns to the caller before the modal has actually been shown (i.e. before the shown.bs.modal event occurs).
+
myModal.show()
+
hide
+
Manually hides a modal. Returns to the caller before the modal has actually been hidden (i.e. before the hidden.bs.modal event occurs).
+
myModal.hide()
+
handleUpdate
+
Manually readjust the modal’s position if the height of a modal changes while it is open (i.e. in case a scrollbar appears).
+
myModal.handleUpdate()
+
dispose
+
Destroys an element’s modal. (Removes stored data on the DOM element)
+
myModal.dispose()
+
getInstance
+
Static method which allows you to get the modal instance associated with a DOM element
+
varmyModalEl=document.getElementById('myModal')
+varmodal=bootstrap.Modal.getInstance(myModalEl)// Returns a Bootstrap modal instance
+
Events
+
Bootstrap’s modal class exposes a few events for hooking into modal functionality. All modal events are fired at the modal itself (i.e. at the <div class="modal">).
+
+
+
+
Event type
+
Description
+
+
+
+
+
show.bs.modal
+
This event fires immediately when the show instance method is called. If caused by a click, the clicked element is available as the relatedTarget property of the event.
+
+
+
shown.bs.modal
+
This event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the relatedTarget property of the event.
+
+
+
hide.bs.modal
+
This event is fired immediately when the hide instance method has been called.
+
+
+
hidden.bs.modal
+
This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).
+
+
+
hidePrevented.bs.modal
+
This event is fired when the modal is shown, its backdrop is static and a click outside the modal or an escape key press is performed with the keyboard option or data-bs-keyboard set to false.
+
+
+
+
varmyModalEl=document.getElementById('myModal')
+myModalEl.addEventListener('hidden.bs.modal',function(event){
+ // do something...
+})
+
Documentation and examples for Bootstrap’s powerful, responsive navigation header, the navbar. Includes support for branding, navigation, and more, including support for our collapse plugin.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
How it works
+
Here’s what you need to know before getting started with the navbar:
+
+
Navbars require a wrapping .navbar with .navbar-expand{-sm|-md|-lg|-xl|-xxl} for responsive collapsing and color scheme classes.
+
Navbars and their contents are fluid by default. Change the container to limit their horizontal width in different ways.
+
Use our spacing and flex utility classes for controlling spacing and alignment within navbars.
+
Navbars are responsive by default, but you can easily modify them to change that. Responsive behavior depends on our Collapse JavaScript plugin.
+
Ensure accessibility by using a <nav> element or, if using a more generic element such as a <div>, add a role="navigation" to every navbar to explicitly identify it as a landmark region for users of assistive technologies.
+
Indicate the current item by using aria-current="page" for the current page or aria-current="true" for the current item in a set.
Navbar navigation links build on our .nav options with their own modifier class and require the use of toggler classes for proper responsive styling. Navigation in navbars will also grow to occupy as much horizontal space as possible to keep your navbar contents securely aligned.
+
Active states—with .active—to indicate the current page can be applied directly to .nav-links or their immediate parent .nav-items.
+
Please note that you should also add the aria-current attribute on the .nav-link itself.
You can also use dropdowns in your navbar. Dropdown menus require a wrapping element for positioning, so be sure to use separate and nested elements for .nav-item and .nav-link as shown below.
Immediate child elements of .navbar use flex layout and will default to justify-content: space-between. Use additional flex utilities as needed to adjust this behavior.
Various buttons are supported as part of these navbar forms, too. This is also a great reminder that vertical alignment utilities can be used to align different sized elements.
Navbars may contain bits of text with the help of .navbar-text. This class adjusts vertical alignment and horizontal spacing for strings of text.
+
+
+
<navclass="navbar navbar-light bg-light">
+ <divclass="container-fluid">
+ <spanclass="navbar-text">
+ Navbar text with an inline element
+ </span>
+ </div>
+</nav>
+
Mix and match with other components and utilities as needed.
Theming the navbar has never been easier thanks to the combination of theming classes and background-color utilities. Choose from .navbar-light for use with light background colors, or .navbar-dark for dark background colors. Then, customize with .bg-* utilities.
Although it’s not required, you can wrap a navbar in a .container to center it on a page–though note that an inner container is still required. Or you can add a container inside the .navbar to only center the contents of a fixed or static top navbar.
Use our position utilities to place navbars in non-static positions. Choose from fixed to the top, fixed to the bottom, or stickied to the top (scrolls with the page until it reaches the top, then stays there). Fixed navbars use position: fixed, meaning they’re pulled from the normal flow of the DOM and may require custom CSS (e.g., padding-top on the <body>) to prevent overlap with other elements.
Navbars can use .navbar-toggler, .navbar-collapse, and .navbar-expand{-sm|-md|-lg|-xl|-xxl} classes to determine when their content collapses behind a button. In combination with other utilities, you can easily choose when to show or hide particular elements.
+
For navbars that never collapse, add the .navbar-expand class on the navbar. For navbars that always collapse, don’t add any .navbar-expand class.
+
Toggler
+
Navbar togglers are left-aligned by default, but should they follow a sibling element like a .navbar-brand, they’ll automatically be aligned to the far right. Reversing your markup will reverse the placement of the toggler. Below are examples of different toggle styles.
+
With no .navbar-brand shown at the smallest breakpoint:
Sometimes you want to use the collapse plugin to trigger a container element for content that structurally sits outside of the .navbar . Because our plugin works on the id and data-bs-target matching, that’s easily done!
When you do this, we recommend including additional JavaScript to move the focus programmatically to the container when it is opened. Otherwise, keyboard users and users of assistive technologies will likely have a hard time finding the newly revealed content - particularly if the container that was opened comes before the toggler in the document’s structure. We also recommend making sure that the toggler has the aria-controls attribute, pointing to the id of the content container. In theory, this allows assistive technology users to jump directly from the toggler to the container it controls–but support for this is currently quite patchy.
Documentation and examples for how to use Bootstrap’s included navigation components.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Base nav
+
Navigation available in Bootstrap share general markup and styles, from the base .nav class to the active and disabled states. Swap modifier classes to switch between each style.
+
The base .nav component is built with flexbox and provide a strong foundation for building all types of navigation components. It includes some style overrides (for working with lists), some link padding for larger hit areas, and basic disabled styling.
+
+
The base .nav component does not include any .active state. The following examples include the class, mainly to demonstrate that this particular class does not trigger any special styling.
+
To convey the active state to assistive technologies, use the aria-current attribute — using the page value for current page, or true for the current item in a set.
Classes are used throughout, so your markup can be super flexible. Use <ul>s like above, <ol> if the order of your items is important, or roll your own with a <nav> element. Because the .nav uses display: flex, the nav links behave the same as nav items would, but without the extra markup.
Change the style of .navs component with modifiers and utilities. Mix and match as needed, or build your own.
+
Horizontal alignment
+
Change the horizontal alignment of your nav with flexbox utilities. By default, navs are left-aligned, but you can easily change them to center or right aligned.
Stack your navigation by changing the flex item direction with the .flex-column utility. Need to stack them on some viewports but not others? Use the responsive versions (e.g., .flex-sm-column).
Takes the basic nav from above and adds the .nav-tabs class to generate a tabbed interface. Use them to create tabbable regions with our tab JavaScript plugin.
Force your .nav’s contents to extend the full available width one of two modifier classes. To proportionately fill all available space with your .nav-items, use .nav-fill. Notice that all horizontal space is occupied, but not every nav item has the same width.
For equal-width elements, use .nav-justified. All horizontal space will be occupied by nav links, but unlike the .nav-fill above, every nav item will be the same width.
If you need responsive nav variations, consider using a series of flexbox utilities. While more verbose, these utilities offer greater customization across responsive breakpoints. In the example below, our nav will be stacked on the lowest breakpoint, then adapt to a horizontal layout that fills the available width starting from the small breakpoint.
If you’re using navs to provide a navigation bar, be sure to add a role="navigation" to the most logical parent container of the <ul>, or wrap a <nav> element around the whole navigation. Do not add the role to the <ul> itself, as this would prevent it from being announced as an actual list by assistive technologies.
+
Note that navigation bars, even if visually styled as tabs with the .nav-tabs class, should not be given role="tablist", role="tab" or role="tabpanel" attributes. These are only appropriate for dynamic tabbed interfaces, as described in the WAI ARIA Authoring Practices. See JavaScript behavior for dynamic tabbed interfaces in this section for an example. The aria-current attribute is not necessary on dynamic tabbed interfaces since our JavaScript handles the selected state by adding aria-selected="true" on the active tab.
Use the tab JavaScript plugin—include it individually or through the compiled bootstrap.js file—to extend our navigational tabs and pills to create tabbable panes of local content, even via dropdown menus.
+
Dynamic tabbed interfaces, as described in the WAI ARIA Authoring Practices, require role="tablist", role="tab", role="tabpanel", and additional aria- attributes in order to convey their structure, functionality and current state to users of assistive technologies (such as screen readers).
+
Note that dynamic tabbed interfaces should not contain dropdown menus, as this causes both usability and accessibility issues. From a usability perspective, the fact that the currently displayed tab’s trigger element is not immediately visible (as it’s inside the closed dropdown menu) can cause confusion. From an accessibility point of view, there is currently no sensible way to map this sort of construct to a standard WAI ARIA pattern, meaning that it cannot be easily made understandable to users of assistive technologies.
Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.
+
+
+
Food truck fixie locavore, accusamus mcsweeney's marfa nulla single-origin coffee squid. Exercitation +1 labore velit, blog sartorial PBR leggings next level wes anderson artisan four loko farm-to-table craft beer twee. Qui photo booth letterpress, commodo enim craft beer mlkshk aliquip jean shorts ullamco ad vinyl cillum PBR. Homo nostrud organic, assumenda labore aesthetic magna delectus mollit. Keytar helvetica VHS salvia yr, vero magna velit sapiente labore stumptown. Vegan fanny pack odio cillum wes anderson 8-bit, sustainable jean shorts beard ut DIY ethical culpa terry richardson biodiesel. Art party scenester stumptown, tumblr butcher vero sint qui sapiente accusamus tattooed echo park.
+
+
+
Etsy mixtape wayfarers, ethical wes anderson tofu before they sold out mcsweeney's organic lomo retro fanny pack lo-fi farm-to-table readymade. Messenger bag gentrify pitchfork tattooed craft beer, iphone skateboard locavore carles etsy salvia banksy hoodie helvetica. DIY synth PBR banksy irony. Leggings gentrify squid 8-bit cred pitchfork. Williamsburg banh mi whatever gluten-free, carles pitchfork biodiesel fixie etsy retro mlkshk vice blog. Scenester cred you probably haven't heard of them, vinyl craft beer blog stumptown. Pitchfork sustainable tofu synth chambray yr.
To help fit your needs, this works with <ul>-based markup, as shown above, or with any arbitrary “roll your own” markup. Note that if you’re using <nav>, you shouldn’t add role="tablist" directly to it, as this would override the element’s native role as a navigation landmark. Instead, switch to an alternative element (in the example below, a simple <div>) and wrap the <nav> around it.
+
+
+
+
+
Et et consectetur ipsum labore excepteur est proident excepteur ad velit occaecat qui minim occaecat veniam. Fugiat veniam incididunt anim aliqua enim pariatur veniam sunt est aute sit dolor anim. Velit non irure adipisicing aliqua ullamco irure incididunt irure non esse consectetur nostrud minim non minim occaecat. Amet duis do nisi duis veniam non est eiusmod tempor incididunt tempor dolor ipsum in qui sit. Exercitation mollit sit culpa nisi culpa non adipisicing reprehenderit do dolore. Duis reprehenderit occaecat anim ullamco ad duis occaecat ex.
+
+
+
Nulla est ullamco ut irure incididunt nulla Lorem Lorem minim irure officia enim reprehenderit. Magna duis labore cillum sint adipisicing exercitation ipsum. Nostrud ut anim non exercitation velit laboris fugiat cupidatat. Commodo esse dolore fugiat sint velit ullamco magna consequat voluptate minim amet aliquip ipsum aute laboris nisi. Labore labore veniam irure irure ipsum pariatur mollit magna in cupidatat dolore magna irure esse tempor ad mollit. Dolore commodo nulla minim amet ipsum officia consectetur amet ullamco voluptate nisi commodo ea sit eu.
+
+
+
Sint sit mollit irure quis est nostrud cillum consequat Lorem esse do quis dolor esse fugiat sunt do. Eu ex commodo veniam Lorem aliquip laborum occaecat qui Lorem esse mollit dolore anim cupidatat. Deserunt officia id Lorem nostrud aute id commodo elit eiusmod enim irure amet eiusmod qui reprehenderit nostrud tempor. Fugiat ipsum excepteur in aliqua non et quis aliquip ad irure in labore cillum elit enim. Consequat aliquip incididunt ipsum et minim laborum laborum laborum et cillum labore. Deserunt adipisicing cillum id nulla minim nostrud labore eiusmod et amet. Laboris consequat consequat commodo non ut non aliquip reprehenderit nulla anim occaecat. Sunt sit ullamco reprehenderit irure ea ullamco Lorem aute nostrud magna.
Consequat occaecat ullamco amet non eiusmod nostrud dolore irure incididunt est duis anim sunt officia. Fugiat velit proident aliquip nisi incididunt nostrud exercitation proident est nisi. Irure magna elit commodo anim ex veniam culpa eiusmod id nostrud sit cupidatat in veniam ad. Eiusmod consequat eu adipisicing minim anim aliquip cupidatat culpa excepteur quis. Occaecat sit eu exercitation irure Lorem incididunt nostrud.
+
+
+
Ad pariatur nostrud pariatur exercitation ipsum ipsum culpa mollit commodo mollit ex. Aute sunt incididunt amet commodo est sint nisi deserunt pariatur do. Aliquip ex eiusmod voluptate exercitation cillum id incididunt elit sunt. Qui minim sit magna Lorem id et dolore velit Lorem amet exercitation duis deserunt. Anim id labore elit adipisicing ut in id occaecat pariatur ut ullamco ea tempor duis.
+
+
+
Est quis nulla laborum officia ad nisi ex nostrud culpa Lorem excepteur aliquip dolor aliqua irure ex. Nulla ut duis ipsum nisi elit fugiat commodo sunt reprehenderit laborum veniam eu veniam. Eiusmod minim exercitation fugiat irure ex labore incididunt do fugiat commodo aliquip sit id deserunt reprehenderit aliquip nostrud. Amet ex cupidatat excepteur aute veniam incididunt mollit cupidatat esse irure officia elit do ipsum ullamco Lorem. Ullamco ut ad minim do mollit labore ipsum laboris ipsum commodo sunt tempor enim incididunt. Commodo quis sunt dolore aliquip aute tempor irure magna enim minim reprehenderit. Ullamco consectetur culpa veniam sint cillum aliqua incididunt velit ullamco sunt ullamco quis quis commodo voluptate. Mollit nulla nostrud adipisicing aliqua cupidatat aliqua pariatur mollit voluptate voluptate consequat non.
Cillum ad ut irure tempor velit nostrud occaecat ullamco aliqua anim Lorem sint. Veniam sint duis incididunt do esse magna mollit excepteur laborum qui. Id id reprehenderit sit est eu aliqua occaecat quis et velit excepteur laborum mollit dolore eiusmod. Ipsum dolor in occaecat commodo et voluptate minim reprehenderit mollit pariatur. Deserunt non laborum enim et cillum eu deserunt excepteur ea incididunt minim occaecat.
+
+
+
Culpa dolor voluptate do laboris laboris irure reprehenderit id incididunt duis pariatur mollit aute magna pariatur consectetur. Eu veniam duis non ut dolor deserunt commodo et minim in quis laboris ipsum velit id veniam. Quis ut consectetur adipisicing officia excepteur non sit. Ut et elit aliquip labore Lorem enim eu. Ullamco mollit occaecat dolore ipsum id officia mollit qui esse anim eiusmod do sint minim consectetur qui.
+
+
+
Fugiat id quis dolor culpa eiusmod anim velit excepteur proident dolor aute qui magna. Ad proident laboris ullamco esse anim Lorem Lorem veniam quis Lorem irure occaecat velit nostrud magna nulla. Velit et et proident Lorem do ea tempor officia dolor. Reprehenderit Lorem aliquip labore est magna commodo est ea veniam consectetur.
+
+
+
Eu dolore ea ullamco dolore Lorem id cupidatat excepteur reprehenderit consectetur elit id dolor proident in cupidatat officia. Voluptate excepteur commodo labore nisi cillum duis aliqua do. Aliqua amet qui mollit consectetur nulla mollit velit aliqua veniam nisi id do Lorem deserunt amet. Culpa ullamco sit adipisicing labore officia magna elit nisi in aute tempor commodo eiusmod.
You can activate a tab or pill navigation without writing any JavaScript by simply specifying data-bs-toggle="tab" or data-bs-toggle="pill" on an element. Use these data attributes on .nav-tabs or .nav-pills.
All API methods are asynchronous and start a transition. They return to the caller as soon as the transition is started but before it ends. In addition, a method call on a transitioning component will be ignored.
Selects the given tab and shows its associated pane. Any other tab that was previously selected becomes unselected and its associated pane is hidden. Returns to the caller before the tab pane has actually been shown (i.e. before the shown.bs.tab event occurs).
Static method which allows you to get the tab instance associated with a DOM element
+
vartriggerEl=document.querySelector('#trigger')
+vartab=bootstrap.Tab.getInstance(triggerEl)// Returns a Bootstrap tab instance
+
Events
+
When showing a new tab, the events fire in the following order:
+
+
hide.bs.tab (on the current active tab)
+
show.bs.tab (on the to-be-shown tab)
+
hidden.bs.tab (on the previous active tab, the same one as for the hide.bs.tab event)
+
shown.bs.tab (on the newly-active just-shown tab, the same one as for the show.bs.tab event)
+
+
If no tab was already active, then the hide.bs.tab and hidden.bs.tab events will not be fired.
+
+
+
+
Event type
+
Description
+
+
+
+
+
show.bs.tab
+
This event fires on tab show, but before the new tab has been shown. Use event.target and event.relatedTarget to target the active tab and the previous active tab (if available) respectively.
+
+
+
shown.bs.tab
+
This event fires on tab show after a tab has been shown. Use event.target and event.relatedTarget to target the active tab and the previous active tab (if available) respectively.
+
+
+
hide.bs.tab
+
This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use event.target and event.relatedTarget to target the current active tab and the new soon-to-be-active tab, respectively.
+
+
+
hidden.bs.tab
+
This event fires after a new tab is shown (and thus the previous active tab is hidden). Use event.target and event.relatedTarget to target the previous active tab and the new active tab, respectively.
Documentation and examples for showing pagination to indicate a series of related content exists across multiple pages.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Overview
+
We use a large block of connected links for our pagination, making links hard to miss and easily scalable—all while providing large hit areas. Pagination is built with list HTML elements so screen readers can announce the number of available links. Use a wrapping <nav> element to identify it as a navigation section to screen readers and other assistive technologies.
+
In addition, as pages likely have more than one such navigation section, it’s advisable to provide a descriptive aria-label for the <nav> to reflect its purpose. For example, if the pagination component is used to navigate between a set of search results, an appropriate label could be aria-label="Search results pages".
Pagination links are customizable for different circumstances. Use .disabled for links that appear un-clickable and .active to indicate the current page.
+
While the .disabled class uses pointer-events: none to try to disable the link functionality of <a>s, that CSS property is not yet standardized and doesn’t account for keyboard navigation. As such, you should always add tabindex="-1" on disabled links and use custom JavaScript to fully disable their functionality.
You can optionally swap out active or disabled anchors for <span>, or omit the anchor in the case of the prev/next arrows, to remove click functionality and prevent keyboard focus while retaining intended styles.
Documentation and examples for adding Bootstrap popovers, like those found in iOS, to any element on your site.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Overview
+
Things to know when using the popover plugin:
+
+
Popovers rely on the 3rd party library Popper for positioning. You must include popper.min.js before bootstrap.js or use bootstrap.bundle.min.js / bootstrap.bundle.js which contains Popper in order for popovers to work!
Popovers are opt-in for performance reasons, so you must initialize them yourself.
+
Zero-length title and content values will never show a popover.
+
Specify container: 'body' to avoid rendering problems in more complex components (like our input groups, button groups, etc).
+
Triggering popovers on hidden elements will not work.
+
Popovers for .disabled or disabled elements must be triggered on a wrapper element.
+
When triggered from anchors that wrap across multiple lines, popovers will be centered between the anchors' overall width. Use .text-nowrap on your <a>s to avoid this behavior.
+
Popovers must be hidden before their corresponding elements have been removed from the DOM.
+
Popovers can be triggered thanks to an element inside a shadow DOM.
When you have some styles on a parent element that interfere with a popover, you’ll want to specify a custom container so that the popover’s HTML appears within that element instead.
<buttontype="button"class="btn btn-lg btn-danger"data-bs-toggle="popover"title="Popover title"data-bs-content="And here's some amazing content. It's very engaging. Right?">Click to toggle popover</button>
+
Four directions
+
Four options are available: top, right, bottom, and left aligned. Directions are mirrored when using Bootstrap in RTL.
+
+
+
+
+
+
+
+
+
<buttontype="button"class="btn btn-secondary"data-bs-container="body"data-bs-toggle="popover"data-bs-placement="top"data-bs-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
+ Popover on top
+</button>
+
+<buttontype="button"class="btn btn-secondary"data-bs-container="body"data-bs-toggle="popover"data-bs-placement="right"data-bs-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
+ Popover on right
+</button>
+
+<buttontype="button"class="btn btn-secondary"data-bs-container="body"data-bs-toggle="popover"data-bs-placement="bottom"data-bs-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
+ Popover on bottom
+</button>
+
+<buttontype="button"class="btn btn-secondary"data-bs-container="body"data-bs-toggle="popover"data-bs-placement="left"data-bs-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
+ Popover on left
+</button>
+
Dismiss on next click
+
Use the focus trigger to dismiss popovers on the user’s next click of a different element than the toggle element.
+
+
Specific markup required for dismiss-on-next-click
+
For proper cross-browser and cross-platform behavior, you must use the <a> tag, not the <button> tag, and you also must include a tabindex attribute.
+
Elements with the disabled attribute aren’t interactive, meaning users cannot hover or click them to trigger a popover (or tooltip). As a workaround, you’ll want to trigger the popover from a wrapper <div> or <span> and override the pointer-events on the disabled element.
+
For disabled popover triggers, you may also prefer data-bs-trigger="hover" so that the popover appears as immediate visual feedback to your users as they may not expect to click on a disabled element.
Making popovers work for keyboard and assistive technology users
+
To allow keyboard users to activate your popovers, you should only add them to HTML elements that are traditionally keyboard-focusable and interactive (such as links or form controls). Although arbitrary HTML elements (such as <span>s) can be made focusable by adding the tabindex="0" attribute, this will add potentially annoying and confusing tab stops on non-interactive elements for keyboard users, and most assistive technologies currently do not announce the popover’s content in this situation. Additionally, do not rely solely on hover as the trigger for your popovers, as this will make them impossible to trigger for keyboard users.
+
While you can insert rich, structured HTML in popovers with the html option, we strongly recommend that you avoid adding an excessive amount of content. The way popovers currently work is that, once displayed, their content is tied to the trigger element with the aria-describedby attribute. As a result, the entirety of the popover’s content will be announced to assistive technology users as one long, uninterrupted stream.
+
Additionally, while it is possible to also include interactive controls (such as form elements or links) in your popover (by adding these elements to the allowList of allowed attributes and tags), be aware that currently the popover does not manage keyboard focus order. When a keyboard user opens a popover, focus remains on the triggering element, and as the popover usually does not immediately follow the trigger in the document’s structure, there is no guarantee that moving forward/pressing TAB will move a keyboard user into the popover itself. In short, simply adding interactive controls to a popover is likely to make these controls unreachable/unusable for keyboard users and users of assistive technologies, or at the very least make for an illogical overall focus order. In these cases, consider using a modal dialog instead.
+
+
+
+
Options
+
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-bs-, as in data-bs-animation="".
+
+Note that for security reasons the sanitize, sanitizeFn, and allowList options cannot be supplied using data attributes.
+
+
+
+
+
+
Name
+
Type
+
Default
+
Description
+
+
+
+
+
animation
+
boolean
+
true
+
Apply a CSS fade transition to the popover
+
+
+
container
+
string | element | false
+
false
+
+
Appends the popover to a specific element. Example: container: 'body'. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize.
+
+
+
+
content
+
string | element | function
+
''
+
+
Default content value if data-bs-content attribute isn't present.
+
If a function is given, it will be called with its this reference set to the element that the popover is attached to.
+
+
+
+
delay
+
number | object
+
0
+
+
Delay showing and hiding the popover (ms) - does not apply to manual trigger type
+
If a number is supplied, delay is applied to both hide/show
+
Object structure is: delay: { "show": 500, "hide": 100 }
+
+
+
+
html
+
boolean
+
false
+
Insert HTML into the popover. If false, innerText property will be used to insert content into the DOM. Use text if you're worried about XSS attacks.
+
+
+
placement
+
string | function
+
'right'
+
+
How to position the popover - auto | top | bottom | left | right. When auto is specified, it will dynamically reorient the popover.
+
When a function is used to determine the placement, it is called with the popover DOM node as its first argument and the triggering element DOM node as its second. The this context is set to the popover instance.
+
+
+
+
selector
+
string | false
+
false
+
If a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See this and an informative example.
The popover's title will be injected into the .popover-header.
+
The popover's content will be injected into the .popover-body.
+
.popover-arrow will become the popover's arrow.
+
The outermost wrapper element should have the .popover class.
+
+
+
+
title
+
string | element | function
+
''
+
+
Default title value if title attribute isn't present.
+
If a function is given, it will be called with its this reference set to the element that the popover is attached to.
+
+
+
+
trigger
+
string
+
'click'
+
How popover is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space. manual cannot be combined with any other trigger.
+
+
+
offset
+
number | string
+
0
+
Offset of the popover relative to its target. For more information refer to Popper's offset docs.
+
+
+
fallbackPlacement
+
string | array
+
'flip'
+
Allow to specify which position Popper will use on fallback. For more information refer to
+ Popper's behavior docs
+
+
+
boundary
+
string | element
+
'scrollParent'
+
Overflow constraint boundary of the popover. Accepts the values of 'viewport', 'window', 'scrollParent', or an HTMLElement reference (JavaScript only). For more information refer to Popper's preventOverflow docs.
+
+
+
customClass
+
string | function
+
''
+
+
Add classes to the popover when it is shown. Note that these classes will be added in addition to any classes specified in the template. To add multiple classes, separate them with spaces: 'class-1 class-2'.
+
You can also pass a function that should return a single string containing additional class names.
+
+
+
+
sanitize
+
boolean
+
true
+
Enable or disable the sanitization. If activated 'template', 'content' and 'title' options will be sanitized.
Options for individual popovers can alternatively be specified through the use of data attributes, as explained above.
+
+
+
Methods
+
+
Asynchronous methods and transitions
+
All API methods are asynchronous and start a transition. They return to the caller as soon as the transition is started but before it ends. In addition, a method call on a transitioning component will be ignored.
Reveals an element’s popover. Returns to the caller before the popover has actually been shown (i.e. before the shown.bs.popover event occurs). This is considered a “manual” triggering of the popover. Popovers whose title and content are both zero-length are never displayed.
+
myPopover.show()
+
hide
+
Hides an element’s popover. Returns to the caller before the popover has actually been hidden (i.e. before the hidden.bs.popover event occurs). This is considered a “manual” triggering of the popover.
+
myPopover.hide()
+
toggle
+
Toggles an element’s popover. Returns to the caller before the popover has actually been shown or hidden (i.e. before the shown.bs.popover or hidden.bs.popover event occurs). This is considered a “manual” triggering of the popover.
+
myPopover.toggle()
+
dispose
+
Hides and destroys an element’s popover (Removes stored data on the DOM element). Popovers that use delegation (which are created using the selector option) cannot be individually destroyed on descendant trigger elements.
+
myPopover.dispose()
+
enable
+
Gives an element’s popover the ability to be shown. Popovers are enabled by default.
+
myPopover.enable()
+
disable
+
Removes the ability for an element’s popover to be shown. The popover will only be able to be shown if it is re-enabled.
+
myPopover.disable()
+
toggleEnabled
+
Toggles the ability for an element’s popover to be shown or hidden.
+
myPopover.toggleEnabled()
+
update
+
Updates the position of an element’s popover.
+
myPopover.update()
+
getInstance
+
Static method which allows you to get the popover instance associated with a DOM element
+
varexampleTriggerEl=document.getElementById('example')
+varpopover=bootstrap.Popover.getInstance(exampleTriggerEl)// Returns a Bootstrap popover instance
+
Events
+
+
+
+
Event type
+
Description
+
+
+
+
+
show.bs.popover
+
This event fires immediately when the show instance method is called.
+
+
+
shown.bs.popover
+
This event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete).
+
+
+
hide.bs.popover
+
This event is fired immediately when the hide instance method has been called.
+
+
+
hidden.bs.popover
+
This event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete).
+
+
+
inserted.bs.popover
+
This event is fired after the show.bs.popover event when the popover template has been added to the DOM.
+
+
+
+
varmyPopoverTrigger=document.getElementById('myPopover')
+myPopoverTrigger.addEventListener('hidden.bs.popover',function(){
+ // do something...
+})
+
Documentation and examples for using Bootstrap custom progress bars featuring support for stacked bars, animated backgrounds, and text labels.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
How it works
+
Progress components are built with two HTML elements, some CSS to set the width, and a few attributes. We don’t use the HTML5 <progress> element, ensuring you can stack progress bars, animate them, and place text labels over them.
+
+
We use the .progress as a wrapper to indicate the max value of the progress bar.
+
We use the inner .progress-bar to indicate the progress so far.
+
The .progress-bar requires an inline style, utility class, or custom CSS to set their width.
+
The .progress-bar also requires some role and aria attributes to make it accessible.
+
+
Put that all together, and you have the following examples.
Automatically update Bootstrap navigation or list group components based on scroll position to indicate which link is currently active in the viewport.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
How it works
+
Scrollspy has a few requirements to function properly:
Scrollspy requires position: relative; on the element you’re spying on, usually the <body>.
+
Anchors (<a>) are required and must point to an element with that id.
+
+
When successfully implemented, your nav or list group will update accordingly, moving the .active class from one item to the next based on their associated targets.
+
+
Scrollable containers and keyboard access
+
If you’re making a scrollable container (other than the <body>), be sure to have a height set and overflow-y: scroll; applied to it—alongside a tabindex="0" to ensure keyboard access.
+
+
+
Example in navbar
+
Scroll the area below the navbar and watch the active class change. The dropdown items will be highlighted as well.
+
+
+
+
@fat
+
Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.
+
@mdo
+
Veniam marfa mustache skateboard, adipisicing fugiat velit pitchfork beard. Freegan beard aliqua cupidatat mcsweeney's vero. Cupidatat four loko nisi, ea helvetica nulla carles. Tattooed cosby sweater food truck, mcsweeney's quis non freegan vinyl. Lo-fi wes anderson +1 sartorial. Carles non aesthetic exercitation quis gentrify. Brooklyn adipisicing craft beer vice keytar deserunt.
+
one
+
Occaecat commodo aliqua delectus. Fap craft beer deserunt skateboard ea. Lomo bicycle rights adipisicing banh mi, velit ea sunt next level locavore single-origin coffee in magna veniam. High life id vinyl, echo park consequat quis aliquip banh mi pitchfork. Vero VHS est adipisicing. Consectetur nisi DIY minim messenger bag. Cred ex in, sustainable delectus consectetur fanny pack iphone.
+
two
+
In incididunt echo park, officia deserunt mcsweeney's proident master cleanse thundercats sapiente veniam. Excepteur VHS elit, proident shoreditch +1 biodiesel laborum craft beer. Single-origin coffee wayfarers irure four loko, cupidatat terry richardson master cleanse. Assumenda you probably haven't heard of them art party fanny pack, tattooed nulla cardigan tempor ad. Proident wolf nesciunt sartorial keffiyeh eu banh mi sustainable. Elit wolf voluptate, lo-fi ea portland before they sold out four loko. Locavore enim nostrud mlkshk brooklyn nesciunt.
+
three
+
Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.
+
Keytar twee blog, culpa messenger bag marfa whatever delectus food truck. Sapiente synth id assumenda. Locavore sed helvetica cliche irony, thundercats you probably haven't heard of them consequat hoodie gluten-free lo-fi fap aliquip. Labore elit placeat before they sold out, terry richardson proident brunch nesciunt quis cosby sweater pariatur keffiyeh ut helvetica artisan. Cardigan craft beer seitan readymade velit. VHS chambray laboris tempor veniam. Anim mollit minim commodo ullamco thundercats.
+
Scrollspy also works with nested .navs. If a nested .nav is .active, its parents will also be .active. Scroll the area next to the navbar and watch the active class change.
+
+
+
+
+
+
+
+
Item 1
+
Ex consequat commodo adipisicing exercitation aute excepteur occaecat ullamco duis aliqua id magna ullamco eu. Do aute ipsum ipsum ullamco cillum consectetur ut et aute consectetur labore. Fugiat laborum incididunt tempor eu consequat enim dolore proident. Qui laborum do non excepteur nulla magna eiusmod consectetur in. Aliqua et aliqua officia quis et incididunt voluptate non anim reprehenderit adipisicing dolore ut consequat deserunt mollit dolore. Aliquip nulla enim veniam non fugiat id cupidatat nulla elit cupidatat commodo velit ut eiusmod cupidatat elit dolore.
+
Item 1-1
+
Amet tempor mollit aliquip pariatur excepteur commodo do ea cillum commodo Lorem et occaecat elit qui et. Aliquip labore ex ex esse voluptate occaecat Lorem ullamco deserunt. Aliqua cillum excepteur irure consequat id quis ea. Sit proident ullamco aute magna pariatur nostrud labore. Reprehenderit aliqua commodo eiusmod aliquip est do duis amet proident magna consectetur consequat eu commodo fugiat non quis. Enim aliquip exercitation ullamco adipisicing voluptate excepteur minim exercitation minim minim commodo adipisicing exercitation officia nisi adipisicing. Anim id duis qui consequat labore adipisicing sint dolor elit cillum anim et fugiat.
+
Item 1-2
+
Cillum nisi deserunt magna eiusmod qui eiusmod velit voluptate pariatur laborum sunt enim. Irure laboris mollit consequat incididunt sint et culpa culpa incididunt adipisicing magna magna occaecat. Nulla ipsum cillum eiusmod sint elit excepteur ea labore enim consectetur in labore anim. Proident ullamco ipsum esse elit ut Lorem eiusmod dolor et eiusmod. Anim occaecat nulla in non consequat eiusmod velit incididunt.
+
Item 2
+
Quis magna Lorem anim amet ipsum do mollit sit cillum voluptate ex nulla tempor. Laborum consequat non elit enim exercitation cillum aliqua consequat id aliqua. Esse ex consectetur mollit voluptate est in duis laboris ad sit ipsum anim Lorem. Incididunt veniam velit elit elit veniam Lorem aliqua quis ullamco deserunt sit enim elit aliqua esse irure. Laborum nisi sit est tempor laborum mollit labore officia laborum excepteur commodo non commodo dolor excepteur commodo. Ipsum fugiat ex est consectetur ipsum commodo tempor sunt in proident.
+
Item 3
+
Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum fugiat minim proident occaecat excepteur aliquip culpa aute tempor reprehenderit. Deserunt tempor mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamco excepteur.
+
Item 3-1
+
Deserunt quis elit Lorem eiusmod amet enim enim amet minim Lorem proident nostrud. Ea id dolore anim exercitation aute fugiat labore voluptate cillum do laboris labore. Ex velit exercitation nisi enim labore reprehenderit labore nostrud ut ut. Esse officia sunt duis aliquip ullamco tempor eiusmod deserunt irure nostrud irure. Ullamco proident veniam laboris ea consectetur magna sunt ex exercitation aliquip minim enim culpa occaecat exercitation. Est tempor excepteur aliquip laborum consequat do deserunt laborum esse eiusmod irure proident ipsum esse qui.
+
Item 3-2
+
Labore sit culpa commodo elit adipisicing sit aliquip elit proident voluptate minim mollit nostrud aute reprehenderit do. Mollit excepteur eu Lorem ipsum anim commodo sint labore Lorem in exercitation velit incididunt. Occaecat consectetur nisi in occaecat proident minim enim sunt reprehenderit exercitation cupidatat et do officia. Aliquip consequat ad labore labore mollit ut amet. Sit pariatur tempor proident in veniam culpa aliqua excepteur elit magna fugiat eiusmod amet officia.
Ex consequat commodo adipisicing exercitation aute excepteur occaecat ullamco duis aliqua id magna ullamco eu. Do aute ipsum ipsum ullamco cillum consectetur ut et aute consectetur labore. Fugiat laborum incididunt tempor eu consequat enim dolore proident. Qui laborum do non excepteur nulla magna eiusmod consectetur in. Aliqua et aliqua officia quis et incididunt voluptate non anim reprehenderit adipisicing dolore ut consequat deserunt mollit dolore. Aliquip nulla enim veniam non fugiat id cupidatat nulla elit cupidatat commodo velit ut eiusmod cupidatat elit dolore.
+
Item 2
+
Quis magna Lorem anim amet ipsum do mollit sit cillum voluptate ex nulla tempor. Laborum consequat non elit enim exercitation cillum aliqua consequat id aliqua. Esse ex consectetur mollit voluptate est in duis laboris ad sit ipsum anim Lorem. Incididunt veniam velit elit elit veniam Lorem aliqua quis ullamco deserunt sit enim elit aliqua esse irure. Laborum nisi sit est tempor laborum mollit labore officia laborum excepteur commodo non commodo dolor excepteur commodo. Ipsum fugiat ex est consectetur ipsum commodo tempor sunt in proident.
+
Item 3
+
Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum fugiat minim proident occaecat excepteur aliquip culpa aute tempor reprehenderit. Deserunt tempor mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamco excepteur.
+
Item 4
+
Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum fugiat minim proident occaecat excepteur aliquip culpa aute tempor reprehenderit. Deserunt tempor mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamco excepteur.
To easily add scrollspy behavior to your topbar navigation, add data-bs-spy="scroll" to the element you want to spy on (most typically this would be the <body>). Then add the data-bs-target attribute with the ID or class of the parent element of any Bootstrap .nav component.
Navbar links must have resolvable id targets. For example, a <a href="#home">home</a> must correspond to something in the DOM like <div id="home"></div>.
+
+
+
+
Non-visible target elements ignored
+
Target elements that are not visible will be ignored and their corresponding nav items will never be highlighted.
+
+
+
Methods
+
refresh
+
When using scrollspy in conjunction with adding or removing of elements from the DOM, you’ll need to call the refresh method like so:
Destroys an element’s scrollspy. (Removes stored data on the DOM element)
+
getInstance
+
Static method which allows you to get the scrollspy instance associated with a DOM element
+
varscrollSpyContentEl=document.getElementById('content')
+varscrollSpy=bootstrap.ScrollSpy.getInstance(scrollSpyContentEl)// Returns a Bootstrap scrollspy instance
+
Options
+
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-bs-, as in data-bs-offset="".
+
+
+
+
Name
+
Type
+
Default
+
Description
+
+
+
+
+
offset
+
number
+
10
+
Pixels to offset from top when calculating position of scroll.
+
+
+
method
+
string
+
auto
+
Finds which section the spied element is in. auto will choose the best method to get scroll coordinates. offset will use the Element.getBoundingClientRect() method to get scroll coordinates. position will use the HTMLElement.offsetTop and HTMLElement.offsetLeft properties to get scroll coordinates.
+
+
+
target
+
string | jQuery object | DOM element
+
+
Specifies element to apply Scrollspy plugin.
+
+
+
+
Events
+
+
+
+
Event type
+
Description
+
+
+
+
+
activate.bs.scrollspy
+
This event fires on the scroll element whenever a new item becomes activated by the scrollspy.
+
+
+
+
varfirstScrollSpyEl=document.querySelector('[data-bs-spy="scroll"]')
+firstScrollSpyEl.addEventListener('activate.bs.scrollspy',function(){
+ // do something...
+})
+
Indicate the loading state of a component or page with Bootstrap spinners, built entirely with HTML, CSS, and no JavaScript.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
About
+
Bootstrap “spinners” can be used to show the loading state in your projects. They’re built only with HTML and CSS, meaning you don’t need any JavaScript to create them. You will, however, need some custom JavaScript to toggle their visibility. Their appearance, alignment, and sizing can be easily customized with our amazing utility classes.
+
For accessibility purposes, each loader here includes role="status" and a nested <span class="visually-hidden">Loading...</span>.
The border spinner uses currentColor for its border-color, meaning you can customize the color with text color utilities. You can use any of our text color utilities on the standard spinner.
+Why not use border-color utilities? Each border spinner specifies a transparent border for at least one side, so .border-{color} utilities would override that.
+
+
+
Growing spinner
+
If you don’t fancy a border spinner, switch to the grow spinner. While it doesn’t technically spin, it does repeatedly grow!
Once again, this spinner is built with currentColor, so you can easily change its appearance with text color utilities. Here it is in blue, along with the supported variants.
Spinners in Bootstrap are built with rems, currentColor, and display: inline-flex. This means they can easily be resized, recolored, and quickly aligned.
Use spinners within buttons to indicate an action is currently processing or taking place. You may also swap the text out of the spinner element and utilize button text as needed.
Push notifications to your visitors with a toast, a lightweight and easily customizable alert message.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Toasts are lightweight notifications designed to mimic the push notifications that have been popularized by mobile and desktop operating systems. They’re built with flexbox, so they’re easy to align and position.
+
Overview
+
Things to know when using the toast plugin:
+
+
Toasts are opt-in for performance reasons, so you must initialize them yourself.
+
Toasts will automatically hide if you do not specify autohide: false.
To encourage extensible and predictable toasts, we recommend a header and body. Toast headers use display: flex, allowing easy alignment of content thanks to our margin and flexbox utilities.
+
Toasts are as flexible as you need and have very little required markup. At a minimum, we require a single element to contain your “toasted” content and strongly encourage a dismiss button.
+
+
+
+
+
+ Bootstrap
+ 11 mins ago
+
+
+
+ Hello, world! This is a toast message.
+
+
+
<divclass="toast"role="alert"aria-live="assertive"aria-atomic="true">
+ <divclass="toast-header">
+ <imgsrc="..."class="rounded me-2"alt="...">
+ <strongclass="me-auto">Bootstrap</strong>
+ <small>11 mins ago</small>
+ <buttontype="button"class="btn-close"data-bs-dismiss="toast"aria-label="Close"></button>
+ </div>
+ <divclass="toast-body">
+ Hello, world! This is a toast message.
+ </div>
+</div>
+
Translucent
+
Toasts are slightly translucent, too, so they blend over whatever they might appear over. For browsers that support the backdrop-filter CSS property, we’ll also attempt to blur the elements under a toast.
+
+
+
+
+
+ Bootstrap
+ 11 mins ago
+
+
+
+ Hello, world! This is a toast message.
+
+
+
<divclass="toast"role="alert"aria-live="assertive"aria-atomic="true">
+ <divclass="toast-header">
+ <imgsrc="..."class="rounded me-2"alt="...">
+ <strongclass="me-auto">Bootstrap</strong>
+ <smallclass="text-muted">11 mins ago</small>
+ <buttontype="button"class="btn-close"data-bs-dismiss="toast"aria-label="Close"></button>
+ </div>
+ <divclass="toast-body">
+ Hello, world! This is a toast message.
+ </div>
+</div>
+
Stacking
+
You can stack toasts by wrapping them in a toast container, which will vertically add some spacing.
Customize your toasts by removing sub-components, tweaking with utilities, or adding your own markup. Here we’ve created a simpler toast by removing the default .toast-header, adding a custom hide icon from Bootstrap Icons, and using some flexbox utilities to adjust the layout.
+
+
+
+ Hello, world! This is a toast message.
+
+
+
+
<divclass="toast d-flex align-items-center"role="alert"aria-live="assertive"aria-atomic="true">
+ <divclass="toast-body">
+ Hello, world! This is a toast message.
+ </div>
+ <buttontype="button"class="btn-close ms-auto me-2"data-bs-dismiss="toast"aria-label="Close"></button>
+</div>
+
Alternatively, you can also add additional controls and components to toasts.
+
+
+
+ Hello, world! This is a toast message.
+
+
+
+
+
+
+
<divclass="toast"role="alert"aria-live="assertive"aria-atomic="true">
+ <divclass="toast-body">
+ Hello, world! This is a toast message.
+ <divclass="mt-2 pt-2 border-top">
+ <buttontype="button"class="btn btn-primary btn-sm">Take action</button>
+ <buttontype="button"class="btn btn-secondary btn-sm"data-bs-dismiss="toast">Close</button>
+ </div>
+ </div>
+</div>
+
Color schemes
+
Building on the above example, you can create different toast color schemes with our color utilities. Here we’ve added .bg-primary and .text-white to the .toast, and then added .text-white to our close button. For a crisp edge, we remove the default border with .border-0.
+
+
+
+ Hello, world! This is a toast message.
+
+
+
+
<divclass="toast d-flex align-items-center text-white bg-primary border-0"role="alert"aria-live="assertive"aria-atomic="true">
+ <divclass="toast-body">
+ Hello, world! This is a toast message.
+ </div>
+ <buttontype="button"class="btn-close btn-close-white ms-auto me-2"data-bs-dismiss="toast"aria-label="Close"></button>
+</div>
+
Placement
+
Place toasts with custom CSS as you need them. The top right is often used for notifications, as is the top middle. If you’re only ever going to show one toast at a time, put the positioning styles right on the .toast.
For systems that generate more notifications, consider using a wrapping element so they can easily stack.
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Bootstrap
+ just now
+
+
+
+ See? Just like this.
+
+
+
+
+
+
+
+ Bootstrap
+ 2 seconds ago
+
+
+
+ Heads up, toasts will stack automatically
+
+
+
+
+
<divaria-live="polite"aria-atomic="true"class="position-relative">
+ <!-- Position it: -->
+ <!-- - `.toast-container` for spacing between toasts -->
+ <!-- - `.position-absolute`, `top-0` & `end-0` to position the toasts in the upper right corner -->
+ <!-- - `.p-3` to prevent the toasts from sticking to the edge of the container -->
+ <divclass="toast-container position-absolute top-0 end-0 p-3">
+
+ <!-- Then put toasts within -->
+ <divclass="toast"role="alert"aria-live="assertive"aria-atomic="true">
+ <divclass="toast-header">
+ <imgsrc="..."class="rounded me-2"alt="...">
+ <strongclass="me-auto">Bootstrap</strong>
+ <smallclass="text-muted">just now</small>
+ <buttontype="button"class="btn-close"data-bs-dismiss="toast"aria-label="Close"></button>
+ </div>
+ <divclass="toast-body">
+ See? Just like this.
+ </div>
+ </div>
+
+ <divclass="toast"role="alert"aria-live="assertive"aria-atomic="true">
+ <divclass="toast-header">
+ <imgsrc="..."class="rounded me-2"alt="...">
+ <strongclass="me-auto">Bootstrap</strong>
+ <smallclass="text-muted">2 seconds ago</small>
+ <buttontype="button"class="btn-close"data-bs-dismiss="toast"aria-label="Close"></button>
+ </div>
+ <divclass="toast-body">
+ Heads up, toasts will stack automatically
+ </div>
+ </div>
+ </div>
+</div>
+
You can also get fancy with flexbox utilities to align toasts horizontally and/or vertically.
+
+
+
+
+
+
+
+
+
+ Bootstrap
+ 11 mins ago
+
+
+
+ Hello, world! This is a toast message.
+
+
+
+
<!-- Flexbox container for aligning the toasts -->
+<divaria-live="polite"aria-atomic="true"class="d-flex justify-content-center align-items-center w-100">
+
+ <!-- Then put toasts within -->
+ <divclass="toast"role="alert"aria-live="assertive"aria-atomic="true">
+ <divclass="toast-header">
+ <imgsrc="..."class="rounded me-2"alt="...">
+ <strongclass="me-auto">Bootstrap</strong>
+ <small>11 mins ago</small>
+ <buttontype="button"class="btn-close"data-bs-dismiss="toast"aria-label="Close"></button>
+ </div>
+ <divclass="toast-body">
+ Hello, world! This is a toast message.
+ </div>
+ </div>
+</div>
+
Accessibility
+
Toasts are intended to be small interruptions to your visitors or users, so to help those with screen readers and similar assistive technologies, you should wrap your toasts in an aria-live region. Changes to live regions (such as injecting/updating a toast component) are automatically announced by screen readers without needing to move the user’s focus or otherwise interrupt the user. Additionally, include aria-atomic="true" to ensure that the entire toast is always announced as a single (atomic) unit, rather than announcing what was changed (which could lead to problems if you only update part of the toast’s content, or if displaying the same toast content at a later point in time). If the information needed is important for the process, e.g. for a list of errors in a form, then use the alert component instead of toast.
+
Note that the live region needs to be present in the markup before the toast is generated or updated. If you dynamically generate both at the same time and inject them into the page, they will generally not be announced by assistive technologies.
+
You also need to adapt the role and aria-live level depending on the content. If it’s an important message like an error, use role="alert" aria-live="assertive", otherwise use role="status" aria-live="polite" attributes.
+
As the content you’re displaying changes, be sure to update the delay timeout to ensure people have enough time to read the toast.
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-bs-, as in data-bs-animation="".
+
+
+
+
Name
+
Type
+
Default
+
Description
+
+
+
+
+
animation
+
boolean
+
true
+
Apply a CSS fade transition to the toast
+
+
+
autohide
+
boolean
+
true
+
Auto hide the toast
+
+
+
delay
+
number
+
+ 5000
+
+
Delay hiding the toast (ms)
+
+
+
+
Methods
+
+
Asynchronous methods and transitions
+
All API methods are asynchronous and start a transition. They return to the caller as soon as the transition is started but before it ends. In addition, a method call on a transitioning component will be ignored.
Reveals an element’s toast. Returns to the caller before the toast has actually been shown (i.e. before the shown.bs.toast event occurs).
+You have to manually call this method, instead your toast won’t show.
+
toast.show()
+
hide
+
Hides an element’s toast. Returns to the caller before the toast has actually been hidden (i.e. before the hidden.bs.toast event occurs). You have to manually call this method if you made autohide to false.
+
toast.hide()
+
dispose
+
Hides an element’s toast. Your toast will remain on the DOM but won’t show anymore.
+
toast.dispose()
+
Events
+
+
+
+
Event type
+
Description
+
+
+
+
+
show.bs.toast
+
This event fires immediately when the show instance method is called.
+
+
+
shown.bs.toast
+
This event is fired when the toast has been made visible to the user.
+
+
+
hide.bs.toast
+
This event is fired immediately when the hide instance method has been called.
+
+
+
hidden.bs.toast
+
This event is fired when the toast has finished being hidden from the user.
+
+
+
+
varmyToastEl=document.getElementById('myToast')
+myToastEl.addEventListener('hidden.bs.toast',function(){
+ // do something...
+})
+
Documentation and examples for adding custom Bootstrap tooltips with CSS and JavaScript using CSS3 for animations and data-bs-attributes for local title storage.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Overview
+
Things to know when using the tooltip plugin:
+
+
Tooltips rely on the 3rd party library Popper for positioning. You must include popper.min.js before bootstrap.js or use bootstrap.bundle.min.js / bootstrap.bundle.js which contains Popper in order for tooltips to work!
+
Tooltips are opt-in for performance reasons, so you must initialize them yourself.
+
Tooltips with zero-length titles are never displayed.
+
Specify container: 'body' to avoid rendering problems in more complex components (like our input groups, button groups, etc).
+
Triggering tooltips on hidden elements will not work.
+
Tooltips for .disabled or disabled elements must be triggered on a wrapper element.
+
When triggered from hyperlinks that span multiple lines, tooltips will be centered. Use white-space: nowrap; on your <a>s to avoid this behavior.
+
Tooltips must be hidden before their corresponding elements have been removed from the DOM.
+
Tooltips can be triggered thanks to an element inside a shadow DOM.
Tight pants next level keffiyeh you probably haven't heard of them. Photo booth beard raw denim letterpress vegan messenger bag stumptown. Farm-to-table seitan, mcsweeney's fixie sustainable quinoa 8-bit american apparel have a terry richardson vinyl chambray. Beard stumptown, cardigans banh mi lomo thundercats. Tofu biodiesel williamsburg marfa, four loko mcsweeney's cleanse vegan chambray. A really ironic artisan whatever keytar, scenester farm-to-table banksy Austin twitter handle freegan cred raw denim single-origin coffee viral.
+
+
+
Hover over the buttons below to see the four tooltips directions: top, right, bottom, and left. Directions are mirrored when using Bootstrap in RTL.
+
+
+
+
+
+
+
+
+
+
<buttontype="button"class="btn btn-secondary"data-bs-toggle="tooltip"data-bs-placement="top"title="Tooltip on top">
+ Tooltip on top
+</button>
+<buttontype="button"class="btn btn-secondary"data-bs-toggle="tooltip"data-bs-placement="right"title="Tooltip on right">
+ Tooltip on right
+</button>
+<buttontype="button"class="btn btn-secondary"data-bs-toggle="tooltip"data-bs-placement="bottom"title="Tooltip on bottom">
+ Tooltip on bottom
+</button>
+<buttontype="button"class="btn btn-secondary"data-bs-toggle="tooltip"data-bs-placement="left"title="Tooltip on left">
+ Tooltip on left
+</button>
+
And with custom HTML added:
+
<buttontype="button"class="btn btn-secondary"data-bs-toggle="tooltip"data-bs-html="true"title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
+ Tooltip with HTML
+</button>
+
Tooltip position attempts to automatically change when a parent container has overflow: auto or overflow: scroll like our .table-responsive, but still keeps the original placement’s positioning. To resolve, set the boundary option to anything other than default value, 'scrollParent', such as 'window':
The required markup for a tooltip is only a data attribute and title on the HTML element you wish to have a tooltip. The generated markup of a tooltip is rather simple, though it does require a position (by default, set to top by the plugin).
+
+
Making tooltips work for keyboard and assistive technology users
+
You should only add tooltips to HTML elements that are traditionally keyboard-focusable and interactive (such as links or form controls). Although arbitrary HTML elements (such as <span>s) can be made focusable by adding the tabindex="0" attribute, this will add potentially annoying and confusing tab stops on non-interactive elements for keyboard users, and most assistive technologies currently do not announce the tooltip in this situation. Additionally, do not rely solely on hover as the trigger for your tooltip, as this will make your tooltips impossible to trigger for keyboard users.
+
+
+
<!-- HTML to write -->
+<ahref="#"data-bs-toggle="tooltip"title="Some tooltip text!">Hover over me</a>
+
+<!-- Generated markup by the plugin -->
+<divclass="tooltip bs-tooltip-top"role="tooltip">
+ <divclass="tooltip-arrow"></div>
+ <divclass="tooltip-inner">
+ Some tooltip text!
+ </div>
+</div>
+
Disabled elements
+
Elements with the disabled attribute aren’t interactive, meaning users cannot focus, hover, or click them to trigger a tooltip (or popover). As a workaround, you’ll want to trigger the tooltip from a wrapper <div> or <span>, ideally made keyboard-focusable using tabindex="0", and override the pointer-events on the disabled element.
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-bs-, as in data-bs-animation="".
+
+Note that for security reasons the sanitize, sanitizeFn, and allowList options cannot be supplied using data attributes.
+
+
+
+
+
+
Name
+
Type
+
Default
+
Description
+
+
+
+
+
animation
+
boolean
+
true
+
Apply a CSS fade transition to the tooltip
+
+
+
container
+
string | element | false
+
false
+
+
Appends the tooltip to a specific element. Example: container: 'body'. This option is particularly useful in that it allows you to position the tooltip in the flow of the document near the triggering element - which will prevent the tooltip from floating away from the triggering element during a window resize.
+
+
+
+
delay
+
number | object
+
0
+
+
Delay showing and hiding the tooltip (ms) - does not apply to manual trigger type
+
If a number is supplied, delay is applied to both hide/show
+
Object structure is: delay: { "show": 500, "hide": 100 }
+
+
+
+
html
+
boolean
+
false
+
+
Allow HTML in the tooltip.
+
If true, HTML tags in the tooltip's title will be rendered in the tooltip. If false, innerText property will be used to insert content into the DOM.
+
Use text if you're worried about XSS attacks.
+
+
+
+
placement
+
string | function
+
'top'
+
+
How to position the tooltip - auto | top | bottom | left | right. When auto is specified, it will dynamically reorient the tooltip.
+
When a function is used to determine the placement, it is called with the tooltip DOM node as its first argument and the triggering element DOM node as its second. The this context is set to the tooltip instance.
+
+
+
+
selector
+
string | false
+
false
+
If a selector is provided, tooltip objects will be delegated to the specified targets. In practice, this is used to also apply tooltips to dynamically added DOM elements (jQuery.on support). See this and an informative example.
The tooltip's title will be injected into the .tooltip-inner.
+
.tooltip-arrow will become the tooltip's arrow.
+
The outermost wrapper element should have the .tooltip class and role="tooltip".
+
+
+
+
title
+
string | element | function
+
''
+
+
Default title value if title attribute isn't present.
+
If a function is given, it will be called with its this reference set to the element that the tooltip is attached to.
+
+
+
+
trigger
+
string
+
'hover focus'
+
+
How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.
+
'manual' indicates that the tooltip will be triggered programmatically via the .tooltip('show'), .tooltip('hide') and .tooltip('toggle') methods; this value cannot be combined with any other trigger.
+
'hover' on its own will result in tooltips that cannot be triggered via the keyboard, and should only be used if alternative methods for conveying the same information for keyboard users is present.
+
+
+
+
fallbackPlacement
+
null | array
+
null
+
Allow to specify which position Popper will use on fallback. For more information refer to
+ Popper's behavior docs
+
+
+
boundary
+
string | element
+
'clippingParents'
+
Overflow constraint boundary of the tooltip. By default it's 'clippingParents' and can accept an HTMLElement reference (JavaScript only). For more information refer to Popper's preventOverflow docs.
+
+
+
customClass
+
string | function
+
''
+
+
Add classes to the tooltip when it is shown. Note that these classes will be added in addition to any classes specified in the template. To add multiple classes, separate them with spaces: 'class-1 class-2'.
+
You can also pass a function that should return a single string containing additional class names.
+
+
+
+
sanitize
+
boolean
+
true
+
Enable or disable the sanitization. If activated 'template' and 'title' options will be sanitized.
Options for individual tooltips can alternatively be specified through the use of data attributes, as explained above.
+
+
+
Methods
+
+
Asynchronous methods and transitions
+
All API methods are asynchronous and start a transition. They return to the caller as soon as the transition is started but before it ends. In addition, a method call on a transitioning component will be ignored.
Reveals an element’s tooltip. Returns to the caller before the tooltip has actually been shown (i.e. before the shown.bs.tooltip event occurs). This is considered a “manual” triggering of the tooltip. Tooltips with zero-length titles are never displayed.
+
tooltip.show()
+
hide
+
Hides an element’s tooltip. Returns to the caller before the tooltip has actually been hidden (i.e. before the hidden.bs.tooltip event occurs). This is considered a “manual” triggering of the tooltip.
+
tooltip.hide()
+
toggle
+
Toggles an element’s tooltip. Returns to the caller before the tooltip has actually been shown or hidden (i.e. before the shown.bs.tooltip or hidden.bs.tooltip event occurs). This is considered a “manual” triggering of the tooltip.
+
tooltip.toggle()
+
dispose
+
Hides and destroys an element’s tooltip (Removes stored data on the DOM element). Tooltips that use delegation (which are created using the selector option) cannot be individually destroyed on descendant trigger elements.
+
tooltip.dispose()
+
enable
+
Gives an element’s tooltip the ability to be shown. Tooltips are enabled by default.
+
tooltip.enable()
+
disable
+
Removes the ability for an element’s tooltip to be shown. The tooltip will only be able to be shown if it is re-enabled.
+
tooltip.disable()
+
toggleEnabled
+
Toggles the ability for an element’s tooltip to be shown or hidden.
+
tooltip.toggleEnabled()
+
update
+
Updates the position of an element’s tooltip.
+
tooltip.update()
+
getInstance
+
Static method which allows you to get the tooltip instance associated with a DOM element
+
varexampleTriggerEl=document.getElementById('example')
+vartooltip=bootstrap.Tooltip.getInstance(exampleTriggerEl)// Returns a Bootstrap tooltip instance
+
Events
+
+
+
+
Event type
+
Description
+
+
+
+
+
show.bs.tooltip
+
This event fires immediately when the show instance method is called.
+
+
+
shown.bs.tooltip
+
This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).
+
+
+
hide.bs.tooltip
+
This event is fired immediately when the hide instance method has been called.
+
+
+
hidden.bs.tooltip
+
This event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).
+
+
+
inserted.bs.tooltip
+
This event is fired after the show.bs.tooltip event when the tooltip template has been added to the DOM.
Documentation and examples for displaying related images and text with the figure component in Bootstrap.
+
+
+
+
+
+
+
+
+
+
Anytime you need to display a piece of content—like an image with an optional caption, consider using a <figure>.
+
Use the included .figure, .figure-img and .figure-caption classes to provide some baseline styles for the HTML5 <figure> and <figcaption> elements. Images in figures have no explicit size, so be sure to add the .img-fluid class to your <img> to make it responsive.
+
+
+
+
+ A caption for the above image.
+
+
<figureclass="figure">
+ <imgsrc="..."class="figure-img img-fluid rounded"alt="...">
+ <figcaptionclass="figure-caption">A caption for the above image.</figcaption>
+</figure>
+
Aligning the figure’s caption is easy with our text utilities.
+
+
+
+
+ A caption for the above image.
+
+
<figureclass="figure">
+ <imgsrc="..."class="figure-img img-fluid rounded"alt="...">
+ <figcaptionclass="figure-caption text-end">A caption for the above image.</figcaption>
+</figure>
Documentation and examples for opting images into responsive behavior (so they never become larger than their parent elements) and add lightweight styles to them—all via classes.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Responsive images
+
Images in Bootstrap are made responsive with .img-fluid. This applies max-width: 100%; and height: auto; to the image so that it scales with the parent element.
+
+
+
+
<imgsrc="..."class="img-fluid"alt="...">
+
Image thumbnails
+
In addition to our border-radius utilities, you can use .img-thumbnail to give an image a rounded 1px border appearance.
If you are using the <picture> element to specify multiple <source> elements for a specific <img>, make sure to add the .img-* classes to the <img> and not to the <picture> tag.
Reboot, a collection of element-specific CSS changes in a single file, kickstart Bootstrap to provide an elegant, consistent, and simple baseline to build upon.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Approach
+
Reboot builds upon Normalize, providing many HTML elements with somewhat opinionated styles using only element selectors. Additional styling is done only with classes. For example, we reboot some <table> styles for a simpler baseline and later provide .table, .table-bordered, and more.
+
Here are our guidelines and reasons for choosing what to override in Reboot:
+
+
Update some browser default values to use rems instead of ems for scalable component spacing.
+
Avoid margin-top. Vertical margins can collapse, yielding unexpected results. More importantly though, a single direction of margin is a simpler mental model.
+
For easier scaling across device sizes, block elements should use rems for margins.
+
Keep declarations of font-related properties to a minimum, using inherit whenever possible.
+
+
Page defaults
+
The <html> and <body> elements are updated to provide better page-wide defaults. More specifically:
+
+
The box-sizing is globally set on every element—including *::before and *::after, to border-box. This ensures that the declared width of element is never exceeded due to padding or border.
+
+
No base font-size is declared on the <html>, but 16px is assumed (the browser default). font-size: 1rem is applied on the <body> for easy responsive type-scaling via media queries while respecting user preferences and ensuring a more accessible approach. This browser default can be overridden by modifying the $font-size-root variable.
+
+
+
The <body> also sets a global font-family, font-weight, line-height, and color. This is inherited later by some form elements to prevent font inconsistencies.
+
For safety, the <body> has a declared background-color, defaulting to #fff.
+
+
Native font stack
+
Bootstrap utilizes a “native font stack” or “system font stack” for optimum text rendering on every device and OS. These system fonts have been designed specifically with today’s devices in mind, with improved rendering on screens, variable font support, and more. Read more about native font stacks in this Smashing Magazine article.
+
$font-family-sans-serif:
+ // Safari for macOS and iOS (San Francisco)
+ -apple-system,
+ // Chrome < 56 for macOS (San Francisco)
+ BlinkMacSystemFont,
+ // Windows
+ "Segoe UI",
+ // Android
+ Roboto,
+ // Basic web fallback
+ "Helvetica Neue",Arial,
+ // Linux
+ "Noto Sans",
+ "Liberation Sans",
+ // Sans serif fallback
+ sans-serif,
+ // Emoji fonts
+ "Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji"!default;
+
Note that because the font stack includes emoji fonts, many common symbol/dingbat unicode characters will be rendered as multi-colored pictographs. Their appearance will vary, depending on the style used in the browser/platform’s native emoji font, and they won’t be affected by any CSS color styles.
+
This font-family is applied to the <body> and automatically inherited globally throughout Bootstrap. To switch the global font-family, update $font-family-base and recompile Bootstrap.
+
Headings and paragraphs
+
All heading elements—e.g., <h1>—and <p> are reset to have their margin-top removed. Headings have margin-bottom: .5rem added and paragraphs margin-bottom: 1rem for easy spacing.
+
+
+
+
Heading
+
Example
+
+
+
+
+
+ <h1></h1>
+
+
h1. Bootstrap heading
+
+
+
+ <h2></h2>
+
+
h2. Bootstrap heading
+
+
+
+ <h3></h3>
+
+
h3. Bootstrap heading
+
+
+
+ <h4></h4>
+
+
h4. Bootstrap heading
+
+
+
+ <h5></h5>
+
+
h5. Bootstrap heading
+
+
+
+ <h6></h6>
+
+
h6. Bootstrap heading
+
+
+
+
Lists
+
All lists—<ul>, <ol>, and <dl>—have their margin-top removed and a margin-bottom: 1rem. Nested lists have no margin-bottom. We’ve also reset the padding-left on <ul> and <ol> elements.
+
+
+
Lorem ipsum dolor sit amet
+
Consectetur adipiscing elit
+
Integer molestie lorem at massa
+
Facilisis in pretium nisl aliquet
+
Nulla volutpat aliquam velit
+
+
Phasellus iaculis neque
+
Purus sodales ultricies
+
Vestibulum laoreet porttitor sem
+
Ac tristique libero volutpat at
+
+
+
Faucibus porta lacus fringilla vel
+
Aenean sit amet erat nunc
+
Eget porttitor lorem
+
+
+
Lorem ipsum dolor sit amet
+
Consectetur adipiscing elit
+
Integer molestie lorem at massa
+
Facilisis in pretium nisl aliquet
+
Nulla volutpat aliquam velit
+
Faucibus porta lacus fringilla vel
+
Aenean sit amet erat nunc
+
Eget porttitor lorem
+
+
+
+
For simpler styling, clear hierarchy, and better spacing, description lists have updated margins. <dd>s reset margin-left to 0 and add margin-bottom: .5rem. <dt>s are bolded.
+
+
+
Description lists
+
A description list is perfect for defining terms.
+
Euismod
+
Vestibulum id ligula porta felis euismod semper eget lacinia odio sem.
+
Donec id elit non mi porta gravida at eget metus.
+
Malesuada porta
+
Etiam porta sem malesuada magna mollis euismod.
+
+
+
Inline code
+
Wrap inline snippets of code with <code>. Be sure to escape HTML angle brackets.
+
+For example, <section> should be wrapped as inline.
+
For example, <code><section></code> should be wrapped as inline.
+
Code blocks
+
Use <pre>s for multiple lines of code. Once again, be sure to escape any angle brackets in the code for proper rendering. The <pre> element is reset to remove its margin-top and use rem units for its margin-bottom.
+
+
<p>Sample text here...</p>
+<p>And another line of sample text here...</p>
+
+
<pre><code><p>Sample text here...</p>
+<p>And another line of sample text here...</p>
+</code></pre>
Use the <kbd> to indicate input that is typically entered via keyboard.
+
+To switch directories, type cd followed by the name of the directory.
+To edit settings, press ctrl + ,
+
To switch directories, type <kbd>cd</kbd> followed by the name of the directory.<br>
+To edit settings, press <kbd><kbd>ctrl</kbd> + <kbd>,</kbd></kbd>
+
Sample output
+
For indicating sample output from a program use the <samp> tag.
+
+This text is meant to be treated as sample output from a computer program.
+
<samp>This text is meant to be treated as sample output from a computer program.</samp>
+
Tables
+
Tables are slightly adjusted to style <caption>s, collapse borders, and ensure consistent text-align throughout. Additional changes for borders, padding, and more come with the .table class.
+
+
+
+ This is an example table, and this is its caption to describe the contents.
+
+
+
+
Table heading
+
Table heading
+
Table heading
+
Table heading
+
+
+
+
+
Table cell
+
Table cell
+
Table cell
+
Table cell
+
+
+
Table cell
+
Table cell
+
Table cell
+
Table cell
+
+
+
Table cell
+
Table cell
+
Table cell
+
Table cell
+
+
+
+
+
Forms
+
Various form elements have been rebooted for simpler base styles. Here are some of the most notable changes:
+
+
<fieldset>s have no borders, padding, or margin so they can be easily used as wrappers for individual inputs or groups of inputs.
+
<legend>s, like fieldsets, have also been restyled to be displayed as a heading of sorts.
+
<label>s are set to display: inline-block to allow margin to be applied.
+
<input>s, <select>s, <textarea>s, and <button>s are mostly addressed by Normalize, but Reboot removes their margin and sets line-height: inherit, too.
+
<textarea>s are modified to only be resizable vertically as horizontal resizing often “breaks” page layout.
+
<button>s and <input> button elements have cursor: pointer when :not(:disabled).
+
+
These changes, and more, are demonstrated below.
+
+
+
Date & color input support
+
Keep in mind date inputs are not fully supported by all browsers, namely Safari.
+
+
+
Pointers on buttons
+
Reboot includes an enhancement for role="button" to change the default cursor to pointer. Add this attribute to elements to help indicate elements are interactive. This role isn’t necessary for <button> elements, which get their own cursor change.
+
+Non-button element button
+
<spanrole="button"tabindex="0">Non-button element button</span>
+
Misc elements
+
Address
+
The <address> element is updated to reset the browser default font-style from italic to normal. line-height is also now inherited, and margin-bottom: 1rem has been added. <address>s are for presenting contact information for the nearest ancestor (or an entire body of work). Preserve formatting by ending lines with <br>.
+
+
+ Twitter, Inc.
+ 1355 Market St, Suite 900
+ San Francisco, CA 94103
+ P: (123) 456-7890
+
+
+ Full Name
+ first.last@example.com
+
+
+
Blockquote
+
The default margin on blockquotes is 1em 40px, so we reset that to 0 0 1rem for something more consistent with other elements.
+
+
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
+
+
Someone famous in Source Title
+
+
Inline elements
+
The <abbr> element receives basic styling to make it stand out amongst paragraph text.
+
+ Nulla attr vitae elit libero, a pharetra augue.
+
+
Summary
+
The default cursor on summary is text, so we reset that to pointer to convey that the element can be interacted with by clicking on it.
+
+
+ Some details
+
More info about the details.
+
+
+ Even more details
+
Here are even more details about the details.
+
+
+
HTML5 [hidden] attribute
+
HTML5 adds a new global attribute named [hidden], which is styled as display: none by default. Borrowing an idea from PureCSS, we improve upon this default by making [hidden] { display: none !important; } to help prevent its display from getting accidentally overridden.
+
<inputtype="text"hidden>
+
+
jQuery incompatibility
+
[hidden] is not compatible with jQuery’s $(...).hide() and $(...).show() methods. Therefore, we don’t currently especially endorse [hidden] over other techniques for managing the display of elements.
+
+
+
To merely toggle the visibility of an element, meaning its display is not modified and the element can still affect the flow of the document, use the .invisible class instead.
Documentation and examples for opt-in styling of tables (given their prevalent use in JavaScript plugins) with Bootstrap.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Overview
+
Due to the widespread use of <table> elements across third-party widgets like calendars and date pickers, Bootstrap’s tables are opt-in. Add the base class .table to any <table>, then extend with our optional modifier classes or custom styles. All table styles are not inherited in Bootstrap, meaning any nested tables can be styled independent from the parent.
+
Using the most basic table markup, here’s how .table-based tables look in Bootstrap.
Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the .visually-hidden class.
+
+
+
Accented tables
+
Striped rows
+
Use .table-striped to add zebra-striping to any table row within the <tbody>.
We start by setting the background of a table cell with the --bs-table-bg custom property. All table variants then set that custom property to colorize the table cells. This way, we don’t get into trouble if semi-transparent colors are used as table backgrounds.
+
Then we add a gradient on the table cells with background-image: linear-gradient(var(--bs-table-accent-bg), var(--bs-table-accent-bg)); to layer on top of any specified background-color. Since --bs-table-accent-bg is transparent by default, we have an invisible transparent linear gradient by default.
+
When either .table-striped, .table-hover or .table-active classes are added, the --bs-table-accent-bg is set to a semitransparent color to colorize the background.
+
For each table variant, we generate a --bs-table-accent-bg color with the highest contrast depending on that color. For example, the accent color for .table-primary is darker while .table-dark has a lighter accent color.
+
Text and border colors are generated the same way, and their colors are inherited by default.
Table cells of <thead> are always vertical aligned to the bottom. Table cells in <tbody> inherit their alignment from <table> and are aligned to the the top by default. Use the vertical align classes to re-align where needed.
+
+
+
+
+
+
Heading 1
+
Heading 2
+
Heading 3
+
Heading 4
+
+
+
+
+
This cell inherits vertical-align: middle; from the table
+
This cell inherits vertical-align: middle; from the table
+
This cell inherits vertical-align: middle; from the table
+
Nulla vitae elit libero, a pharetra augue. Cras mattis consectetur purus sit amet fermentum. Vestibulum id ligula porta felis euismod semper.
+
+
+
This cell inherits vertical-align: bottom; from the table row
+
This cell inherits vertical-align: bottom; from the table row
+
This cell inherits vertical-align: bottom; from the table row
+
Nulla vitae elit libero, a pharetra augue. Cras mattis consectetur purus sit amet fermentum. Vestibulum id ligula porta felis euismod semper.
+
+
+
This cell inherits vertical-align: middle; from the table
+
This cell inherits vertical-align: middle; from the table
+
This cell is aligned to the top.
+
Nulla vitae elit libero, a pharetra augue. Cras mattis consectetur purus sit amet fermentum. Vestibulum id ligula porta felis euismod semper.
To prevent any styles from leaking to nested tables, we use the child combinator (>) selector in our CSS. Since we need to target all the tds and ths in the thead, tbody, and tfoot, our selector would look pretty long without it. As such, we use the rather odd looking .table > :not(caption) > * > * selector to target all tds and ths of the .table, but none of any potential nested tables.
+
Note that if you add <tr>s as direct children of a table, those <tr> will be wrapped in a <tbody> by default, thus making our selectors work as intended.
+
Anatomy
+
Table head
+
Similar to tables and dark tables, use the modifier classes .table-light or .table-dark to make <thead>s appear light or dark gray.
A <caption> functions like a heading for a table. It helps users with screen readers to find a table and understand what it’s about and decide if they want to read it.
Responsive tables allow tables to be scrolled horizontally with ease. Make any table responsive across all viewports by wrapping a .table with .table-responsive. Or, pick a maximum breakpoint with which to have a responsive table up to by using .table-responsive{-sm|-md|-lg|-xl|-xxl}.
+
+
Vertical clipping/truncation
+
Responsive tables make use of overflow-y: hidden, which clips off any content that goes beyond the bottom or top edges of the table. In particular, this can clip off dropdown menus and other third-party widgets.
+
+
+
Always responsive
+
Across every breakpoint, use .table-responsive for horizontally scrolling tables.
Use .table-responsive{-sm|-md|-lg|-xl|-xxl} as needed to create responsive tables up to a particular breakpoint. From that breakpoint and up, the table will behave normally and not scroll horizontally.
+
These tables may appear broken until their responsive styles apply at specific viewport widths.
The factor variables ($table-striped-bg-factor, $table-active-bg-factor & $table-hover-bg-factor) are used to determine the contrast in table variants.
+
Apart from the light & dark table variants, theme colors are lightened by the $table-bg-level variable.
Documentation and examples for Bootstrap typography, including global settings, headings, body text, lists, and more.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Global settings
+
Bootstrap sets basic global display, typography, and link styles. When more control is needed, check out the textual utility classes.
+
+
Use a native font stack that selects the best font-family for each OS and device.
+
For a more inclusive and accessible type scale, we use the browser’s default root font-size (typically 16px) so visitors can customize their browser defaults as needed.
+
Use the $font-family-base, $font-size-base, and $line-height-base attributes as our typographic base applied to the <body>.
+
Set the global link color via $link-color.
+
Use $body-bg to set a background-color on the <body> (#fff by default).
+
+
These styles can be found within _reboot.scss, and the global variables are defined in _variables.scss. Make sure to set $font-size-base in rem.
+
Headings
+
All HTML headings, <h1> through <h6>, are available.
Traditional heading elements are designed to work best in the meat of your page content. When you need a heading to stand out, consider using a display heading—a larger, slightly more opinionated heading style.
+ Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Duis mollis, est non commodo luctus.
+
+
<pclass="lead">
+ Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Duis mollis, est non commodo luctus.
+</p>
+
Inline text elements
+
Styling for common inline HTML5 elements.
+
+
You can use the mark tag to highlight text.
+
This line of text is meant to be treated as deleted text.
+
This line of text is meant to be treated as no longer accurate.
+
This line of text is meant to be treated as an addition to the document.
+
This line of text will render as underlined.
+
This line of text is meant to be treated as fine print.
+
This line rendered as bold text.
+
This line rendered as italicized text.
+
<p>You can use the mark tag to <mark>highlight</mark> text.</p>
+<p><del>This line of text is meant to be treated as deleted text.</del></p>
+<p><s>This line of text is meant to be treated as no longer accurate.</s></p>
+<p><ins>This line of text is meant to be treated as an addition to the document.</ins></p>
+<p><u>This line of text will render as underlined.</u></p>
+<p><small>This line of text is meant to be treated as fine print.</small></p>
+<p><strong>This line rendered as bold text.</strong></p>
+<p><em>This line rendered as italicized text.</em></p>
+
Beware that those tags should be used for semantic purpose:
+
+
<mark> represents text which is marked or highlighted for reference or notation purposes.
+
<small> represents side-comments and small print, like copyright and legal text.
+
<s> represents element that are no longer relevant or no longer accurate.
+
<u> represents a span of inline text which should be rendered in a way that indicates that it has a non-textual annotation.
+
+
If you want to style your text, you should use the following classes instead:
+
+
.mark will apply the same styles as <mark>.
+
.small will apply the same styles as <small>.
+
.text-decoration-underline will apply the same styles as <u>.
+
.text-decoration-line-through will apply the same styles as <s>.
+
+
While not shown above, feel free to use <b> and <i> in HTML5. <b> is meant to highlight words or phrases without conveying additional importance, while <i> is mostly for voice, technical terms, etc.
+
Text utilities
+
Change text alignment, transform, style, weight, line-height, decoration and color with our text utilities and color utilities.
+
Abbreviations
+
Stylized implementation of HTML’s <abbr> element for abbreviations and acronyms to show the expanded version on hover. Abbreviations have a default underline and gain a help cursor to provide additional context on hover and to users of assistive technologies.
+
Add .initialism to an abbreviation for a slightly smaller font-size.
For quoting blocks of content from another source within your document. Wrap <blockquote class="blockquote"> around any HTML as the quote.
+
+
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
+
+
<blockquoteclass="blockquote">
+ <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p>
+</blockquote>
+
Naming a source
+
The HTML spec requires that blockquote attribution be placed outside the <blockquote>. When providing attribution, wrap your <blockquote> in a <figure> and use a <figcaption> or a block level element (e.g., <p>) with the .blockquote-footer class. Be sure to wrap the name of the source work in <cite> as well.
+
+
+
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
+
+
+ Someone famous in Source Title
+
+
+
<figure>
+ <blockquoteclass="blockquote">
+ <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p>
+ </blockquote>
+ <figcaptionclass="blockquote-footer">
+ Someone famous in <citetitle="Source Title">Source Title</cite>
+ </figcaption>
+</figure>
+
Alignment
+
Use text utilities as needed to change the alignment of your blockquote.
+
+
+
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
+
+
+ Someone famous in Source Title
+
+
+
<figureclass="text-center">
+ <blockquoteclass="blockquote">
+ <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p>
+ </blockquote>
+ <figcaptionclass="blockquote-footer">
+ Someone famous in <citetitle="Source Title">Source Title</cite>
+ </figcaption>
+</figure>
+
+
+
+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
+
+
+ Someone famous in Source Title
+
+
+
<figureclass="text-end">
+ <blockquoteclass="blockquote">
+ <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p>
+ </blockquote>
+ <figcaptionclass="blockquote-footer">
+ Someone famous in <citetitle="Source Title">Source Title</cite>
+ </figcaption>
+</figure>
+
Lists
+
Unstyled
+
Remove the default list-style and left margin on list items (immediate children only). This only applies to immediate children list items, meaning you will need to add the class for any nested lists as well.
+
+
+
Lorem ipsum dolor sit amet
+
Consectetur adipiscing elit
+
Integer molestie lorem at massa
+
Facilisis in pretium nisl aliquet
+
Nulla volutpat aliquam velit
+
+
Phasellus iaculis neque
+
Purus sodales ultricies
+
Vestibulum laoreet porttitor sem
+
Ac tristique libero volutpat at
+
+
+
Faucibus porta lacus fringilla vel
+
Aenean sit amet erat nunc
+
Eget porttitor lorem
+
+
<ulclass="list-unstyled">
+ <li>Lorem ipsum dolor sit amet</li>
+ <li>Consectetur adipiscing elit</li>
+ <li>Integer molestie lorem at massa</li>
+ <li>Facilisis in pretium nisl aliquet</li>
+ <li>Nulla volutpat aliquam velit
+ <ul>
+ <li>Phasellus iaculis neque</li>
+ <li>Purus sodales ultricies</li>
+ <li>Vestibulum laoreet porttitor sem</li>
+ <li>Ac tristique libero volutpat at</li>
+ </ul>
+ </li>
+ <li>Faucibus porta lacus fringilla vel</li>
+ <li>Aenean sit amet erat nunc</li>
+ <li>Eget porttitor lorem</li>
+</ul>
+
Inline
+
Remove a list’s bullets and apply some light margin with a combination of two classes, .list-inline and .list-inline-item.
Align terms and descriptions horizontally by using our grid system’s predefined classes (or semantic mixins). For longer terms, you can optionally add a .text-truncate class to truncate the text with an ellipsis.
+
+
+
Description lists
+
A description list is perfect for defining terms.
+
+
Euismod
+
+
Vestibulum id ligula porta felis euismod semper eget lacinia odio sem nec elit.
+
Donec id elit non mi porta gravida at eget metus.
+
+
+
Malesuada porta
+
Etiam porta sem malesuada magna mollis euismod.
+
+
Truncated term is truncated
+
Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.
+
+
Nesting
+
+
+
Nested definition list
+
Aenean posuere, tortor sed cursus feugiat, nunc augue blandit nunc.
+
+
+
+
<dlclass="row">
+ <dtclass="col-sm-3">Description lists</dt>
+ <ddclass="col-sm-9">A description list is perfect for defining terms.</dd>
+
+ <dtclass="col-sm-3">Euismod</dt>
+ <ddclass="col-sm-9">
+ <p>Vestibulum id ligula porta felis euismod semper eget lacinia odio sem nec elit.</p>
+ <p>Donec id elit non mi porta gravida at eget metus.</p>
+ </dd>
+
+ <dtclass="col-sm-3">Malesuada porta</dt>
+ <ddclass="col-sm-9">Etiam porta sem malesuada magna mollis euismod.</dd>
+
+ <dtclass="col-sm-3 text-truncate">Truncated term is truncated</dt>
+ <ddclass="col-sm-9">Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.</dd>
+
+ <dtclass="col-sm-3">Nesting</dt>
+ <ddclass="col-sm-9">
+ <dlclass="row">
+ <dtclass="col-sm-4">Nested definition list</dt>
+ <ddclass="col-sm-8">Aenean posuere, tortor sed cursus feugiat, nunc augue blandit nunc.</dd>
+ </dl>
+ </dd>
+</dl>
+
Responsive font sizes
+
In Bootstrap 5, we’ve enabled responsive font sizes by default, allowing text to scale more naturally across device and viewport sizes. Have a look at the RFS page to find out how this works.
Bootstrap is supported by an extensive color system that themes our styles and components. This enables more comprehensive customization and extension for any project.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Theme colors
+
We use a subset of all colors to create a smaller color palette for generating color schemes, also available as Sass variables and a Sass map in Bootstrap’s scss/_variables.scss file.
+
+
+
+
Primary
+
+
+
+
Secondary
+
+
+
+
Success
+
+
+
+
Danger
+
+
+
+
Warning
+
+
+
+
Info
+
+
+
+
Light
+
+
+
+
Dark
+
+
+
+
All these colors are available as a Sass map, $theme-colors.
All Bootstrap colors are available as Sass variables and a Sass map in scss/_variables.scss file. To avoid increased file sizes, we don’t create text or background color classes for each of these variables. Instead, we choose a subset of these colors for a theme palette.
+
Be sure to monitor contrast ratios as you customize colors. As shown below, we’ve added three contrast ratios to each of the main colors—one for the swatch’s current colors, one for against white, and one for against black.
+
+
+
+
+ $blue
+ #0d6efd
+
+
+
$blue-100
+
+
$blue-200
+
+
$blue-300
+
+
$blue-400
+
+
$blue-500
+
+
$blue-600
+
+
$blue-700
+
+
$blue-800
+
+
$blue-900
+
+
+
+
+
+ $indigo
+ #6610f2
+
+
+
$indigo-100
+
+
$indigo-200
+
+
$indigo-300
+
+
$indigo-400
+
+
$indigo-500
+
+
$indigo-600
+
+
$indigo-700
+
+
$indigo-800
+
+
$indigo-900
+
+
+
+
+
+ $purple
+ #6f42c1
+
+
+
$purple-100
+
+
$purple-200
+
+
$purple-300
+
+
$purple-400
+
+
$purple-500
+
+
$purple-600
+
+
$purple-700
+
+
$purple-800
+
+
$purple-900
+
+
+
+
+
+ $pink
+ #d63384
+
+
+
$pink-100
+
+
$pink-200
+
+
$pink-300
+
+
$pink-400
+
+
$pink-500
+
+
$pink-600
+
+
$pink-700
+
+
$pink-800
+
+
$pink-900
+
+
+
+
+
+ $red
+ #dc3545
+
+
+
$red-100
+
+
$red-200
+
+
$red-300
+
+
$red-400
+
+
$red-500
+
+
$red-600
+
+
$red-700
+
+
$red-800
+
+
$red-900
+
+
+
+
+
+ $orange
+ #fd7e14
+
+
+
$orange-100
+
+
$orange-200
+
+
$orange-300
+
+
$orange-400
+
+
$orange-500
+
+
$orange-600
+
+
$orange-700
+
+
$orange-800
+
+
$orange-900
+
+
+
+
+
+ $yellow
+ #ffc107
+
+
+
$yellow-100
+
+
$yellow-200
+
+
$yellow-300
+
+
$yellow-400
+
+
$yellow-500
+
+
$yellow-600
+
+
$yellow-700
+
+
$yellow-800
+
+
$yellow-900
+
+
+
+
+
+ $green
+ #198754
+
+
+
$green-100
+
+
$green-200
+
+
$green-300
+
+
$green-400
+
+
$green-500
+
+
$green-600
+
+
$green-700
+
+
$green-800
+
+
$green-900
+
+
+
+
+
+ $teal
+ #20c997
+
+
+
$teal-100
+
+
$teal-200
+
+
$teal-300
+
+
$teal-400
+
+
$teal-500
+
+
$teal-600
+
+
$teal-700
+
+
$teal-800
+
+
$teal-900
+
+
+
+
+
+ $cyan
+ #0dcaf0
+
+
+
$cyan-100
+
+
$cyan-200
+
+
$cyan-300
+
+
$cyan-400
+
+
$cyan-500
+
+
$cyan-600
+
+
$cyan-700
+
+
$cyan-800
+
+
$cyan-900
+
+
+
+
+ $gray-500
+ #adb5bd
+
+
$gray-100
+
+
$gray-200
+
+
$gray-300
+
+
$gray-400
+
+
$gray-500
+
+
$gray-600
+
+
$gray-700
+
+
$gray-800
+
+
$gray-900
+
+
+
+
+ $black
+ #000
+
+
+ $white
+ #fff
+
+
+
+
Notes on Sass
+
Sass cannot programmatically generate variables, so we manually created variables for every tint and shade ourselves. We specify the midpoint value (e.g., $blue-500) and use custom color functions to tint (lighten) or shade (darken) our colors via Sass’s mix() color function.
+
Using mix() is not the same as lighten() and darken()—the former blends the specified color with white or black, while the latter only adjusts the lightness value of each color. The result is a much more complete suite of colors, as shown in this CodePen demo.
+
Our tint-color() and shade-color() functions use mix() alongside our $theme-color-interval variable, which specifies a stepped percentage value for each mixed color we produce. See the scss/_functions.scss and scss/_variables.scss files for the full source code.
+
Color Sass maps
+
Bootstrap’s source Sass files include three maps to help you quickly and easily loop over a list of colors and their hex values.
+
+
$colors lists all our available base (500) colors
+
$theme-colors lists all semantically named theme colors (shown below)
+
$grays lists all tints and shades of gray
+
+
Within scss/_variables.scss, you’ll find Bootstrap’s color variables and Sass map. Here’s an example of the $colors Sass map:
Add, remove, or modify values within the map to update how they’re used in many other components. Unfortunately at this time, not every component utilizes this Sass map. Future updates will strive to improve upon this. Until then, plan on making use of the ${color} variables and this Sass map.
Learn how and why we build nearly all our components responsively and with base and modifier classes.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Base classes
+
Bootstrap’s components are largely built with a base-modifier nomenclature. We group as many shared properties as possible into a base class, like .btn, and then group individual styles for each variant into modifier classes, like .btn-primary or .btn-success.
+
To build our modifier classes, we use Sass’s @each loops to iterate over a Sass map. This is especially helpful for generating variants of a component by our $theme-colors and creating responsive variants for each breakpoint. As you customize these Sass maps and recompile, you’ll automatically see your changes reflected in these loops.
+
Check out our Sass maps and loops docs for how to customize these loops and extend Bootstrap’s base-modifier approach to your own code.
+
Modifiers
+
Many of Bootstrap’s components are built with a base-modifier class approach. This means the bulk of the styling is contained to a base class (e.g., .btn) while style variations are confined to modifier classes (e.g., .btn-danger). These modifier classes are built from the $theme-colors map to make customizing the number and name of our modifier classes.
+
Here are two examples of how we loop over the $theme-colors map to generate modifiers to the .alert and .list-group components.
// List group contextual variants
+//
+// Add modifier classes to change text and background color on individual items.
+// Organizationally, this must come after the `:hover` states.
+
+@each$state,$valuein$theme-colors{
+ $background:shift-color($value,$list-group-item-bg-scale);
+ $color:shift-color($value,$list-group-item-color-scale);
+ @if(contrast-ratio($background,$color)<$min-contrast-ratio){
+ $color:mix($value,color-contrast($background),abs($alert-color-scale));
+ }
+
+ @include list-group-item-variant($state,$background,$color);
+}
+
Responsive
+
These Sass loops aren’t limited to color maps, either. You can also generate responsive variations of your components. Take for example our responsive alignment of the dropdowns where we mix an @each loop for the $grid-breakpoints Sass map with a media query include.
+
// We deliberately hardcode the `bs-` prefix because we check
+// this custom property in JS to determine Popper's positioning
+
+@each$breakpointinmap-keys($grid-breakpoints){
+ @include media-breakpoint-up($breakpoint){
+ $infix:breakpoint-infix($breakpoint,$grid-breakpoints);
+
+ .dropdown-menu#{$infix}-start{
+ --bs-position:start;
+ right:auto#{"/* rtl:ignore */"};
+ left:0#{"/* rtl:ignore */"};
+ }
+
+ .dropdown-menu#{$infix}-end{
+ --bs-position:end;
+ right:0#{"/* rtl:ignore */"};
+ left:auto#{"/* rtl:ignore */"};
+ }
+ }
+}
+
Should you modify your $grid-breakpoints, your changes will apply to all the loops iterating over that map.
We encourage you to adopt these guidelines when building with Bootstrap to create your own components. We’ve extended this approach ourselves to the custom components in our documentation and examples. Components like our callouts are built just like our provided components with base and modifier classes.
+
+
+ This is a callout. We built it custom for our docs so our messages to you stand out. It has three variants via modifier classes.
+
+
+
<divclass="callout">...</div>
+
In your CSS, you’d have something like the following where the bulk of the styling is done via .callout. Then, the unique styles between each variant is controlled via modifier class.
+
// Base class
+.callout{}
+
+// Modifier classes
+.callout-info{}
+.callout-warning{}
+.callout-danger{}
+
For the callouts, that unique styling is just a border-left-color. When you combine that base class with one of those modifier classes, you get your complete component family:
+
+This is an info callout. Example text to show it in action.
+
+
+
+This is a warning callout. Example text to show it in action.
+
+
+
+This is a danger callout. Example text to show it in action.
+
Use Bootstrap’s CSS custom properties for fast and forward-looking design and development.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Bootstrap includes around two dozen CSS custom properties (variables) in its compiled CSS, with dozens more on the way for improved customization on a per-component basis. These provide easy access to commonly used values like our theme colors, breakpoints, and primary font stacks when working in your browser’s inspector, a code sandbox, or general prototyping.
+
All our custom properties are prefixed with bs- to avoid conflicts with third party CSS.
+
Root variables
+
Here are the variables we include (note that the :root is required) that can be accessed anywhere Bootstrap’s CSS is loaded. They’re located in our _root.scss file and included in our compiled dist files.
We’re also beginning to make use of custom properties as local variables for various components. This way we can reduce our compiled CSS, ensure styles aren’t inherited in places like nested tables, and allow some basic restyling and extending of Bootstrap components after Sass compilation.
We’re also using CSS variables across our grids—primarily for gutters—with more component usage coming in the future.
+
Examples
+
CSS variables offer similar flexibility to Sass’s variables, but without the need for compilation before being served to the browser. For example, here we’re resetting our page’s font and link styles with CSS variables.
Keep your projects lean, responsive, and maintainable so you can deliver the best experience and focus on more important jobs.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Lean Sass imports
+
When using Sass in your asset pipeline, make sure you optimize Bootstrap by only @importing the components you need. Your largest optimizations will likely come from the Layout & Components section of our bootstrap.scss.
If you’re not using a component, comment it out or delete it entirely. For example, if you’re not using the carousel, remove that import to save some file size in your compiled CSS. Keep in mind there are some dependencies across Sass imports that may make it more difficult to omit a file.
+
Lean JavaScript
+
Bootstrap’s JavaScript includes every component in our primary dist files (bootstrap.js and bootstrap.min.js), and even our primary dependency (Popper) with our bundle files (bootstrap.bundle.js and bootstrap.bundle.min.js). While you’re customizing via Sass, be sure to remove related JavaScript.
+
For instance, assuming you’re using your own JavaScript bundler like Webpack or Rollup, you’d only import the JavaScript you plan on using. In the example below, we show how to just include our modal JavaScript:
+
// Import just what we need
+
+// import 'bootstrap/js/dist/alert';
+// import 'bootstrap/js/dist/button';
+// import 'bootstrap/js/dist/carousel';
+// import 'bootstrap/js/dist/collapse';
+// import 'bootstrap/js/dist/dropdown';
+import'bootstrap/js/dist/modal';
+// import 'bootstrap/js/dist/popover';
+// import 'bootstrap/js/dist/scrollspy';
+// import 'bootstrap/js/dist/tab';
+// import 'bootstrap/js/dist/toast';
+// import 'bootstrap/js/dist/tooltip';
+
This way, you’re not including any JavaScript you don’t intend to use for components like buttons, carousels, and tooltips. If you’re importing dropdowns, tooltips or popovers, be sure to list the Popper dependency in your package.json file.
+
+
Default Exports
+
Files in bootstrap/js/dist use the default export, so if you want to use one of them you have to do the following:
Bootstrap depends on Autoprefixer to automatically add browser prefixes to certain CSS properties. Prefixes are dictated by our .browserslistrc file, found in the root of the Bootstrap repo. Customizing this list of browsers and recompiling the Sass will automatically remove some CSS from your compiled CSS, if there are vendor prefixes unique to that browser or version.
+
Unused CSS
+
Help wanted with this section, please consider opening a PR. Thanks!
+
While we don’t have a prebuilt example for using PurgeCSS with Bootstrap, there are some helpful articles and walkthroughs that the community has written. Here are some options:
Whenever possible, be sure to compress all the code you serve to your visitors. If you’re using Bootstrap dist files, try to stick to the minified versions (indicated by the .min.css and .min.js extensions). If you’re building Bootstrap from the source with your own build system, be sure to implement your own minifiers for HTML, CSS, and JS.
+
Nonblocking files
+
Help wanted with this section, please consider opening a PR. Thanks!
+
Always use https
+
Help wanted with this section, please consider opening a PR. Thanks!
Quickly customize Bootstrap with built-in variables to easily toggle global CSS preferences for controlling style and behavior.
+
+
+
+
+
+
+
+
+
+
Customize Bootstrap with our built-in custom variables file and easily toggle global CSS preferences with new $enable-* Sass variables. Override a variable’s value and recompile with npm run test as needed.
+
You can find and customize these variables for key global options in Bootstrap’s scss/_variables.scss file.
+
+
+
+
Variable
+
Values
+
Description
+
+
+
+
+
$spacer
+
1rem (default), or any value > 0
+
Specifies the default spacer value to programmatically generate our spacer utilities.
+
+
+
$enable-rounded
+
true (default) or false
+
Enables predefined border-radius styles on various components.
+
+
+
$enable-shadows
+
true or false (default)
+
Enables predefined box-shadow styles on various components.
+
+
+
$enable-gradients
+
true or false (default)
+
Enables predefined gradients via background-image styles on various components.
+
+
+
$enable-transitions
+
true (default) or false
+
Enables predefined transitions on various components.
+
+
+
$enable-reduced-motion
+
true (default) or false
+
Enables the prefers-reduced-motion media query, which suppresses certain animations/transitions based on the users' browser/operating system preferences.
+
+
+
$enable-grid-classes
+
true (default) or false
+
Enables the generation of CSS classes for the grid system (e.g. .row, .col-md-1, etc.).
+
+
+
$enable-caret
+
true (default) or false
+
Enables pseudo element caret on .dropdown-toggle.
+
+
+
$enable-button-pointers
+
true (default) or false
+
Add “hand” cursor to non-disabled button elements.
There are multiple ways to customize Bootstrap. Your best path can depend on your project, the complexity of your build tools, the version of Bootstrap you’re using, browser support, and more.
+
Our two preferred methods are:
+
+
Using Bootstrap via package manager so you can use and extend our source files.
+
Using Bootstrap’s compiled distribution files or jsDelivr so you can add onto or override Bootstrap’s styles.
For those who want to use the distribution files, review the getting started page for how to include those files and an example HTML page. From there, consult the docs for the layout, components, and behaviors you’d like to use.
+
As you familiarize yourself with Bootstrap, continue exploring this section for more details on how to utilize our global options, making use of and changing our color system, how we build our components, how to use our growing list of CSS custom properties, and how to optimize your code when building with Bootstrap.
Utilize our source Sass files to take advantage of variables, maps, mixins, and functions to help you build faster and customize your project.
+
+
+
+
+
+
+ On this page
+
+
+
+
+
+
+
+
Utilize our source Sass files to take advantage of variables, maps, mixins, and more. In our build we’ve increased the Sass rounding precision to 6 (by default it’s 5) to prevent issues with browser rounding.
+
File structure
+
Whenever possible, avoid modifying Bootstrap’s core files. For Sass, that means creating your own stylesheet that imports Bootstrap so you can modify and extend it. Assuming you’re using a package manager like npm, you’ll have a file structure that looks like this:
If you’ve downloaded our source files and aren’t using a package manager, you’ll want to manually setup something similar to that structure, keeping Bootstrap’s source files separate from your own.
In your custom.scss, you’ll import Bootstrap’s source Sass files. You have two options: include all of Bootstrap, or pick the parts you need. We encourage the latter, though be aware there are some requirements and dependencies across our components. You also will need to include some JavaScript for our plugins.
+
// Custom.scss
+// Option A: Include all of Bootstrap
+
+@import"../node_modules/bootstrap/scss/bootstrap";
+
// Custom.scss
+// Option B: Include parts of Bootstrap
+
+// Required
+@import"../node_modules/bootstrap/scss/functions";
+@import"../node_modules/bootstrap/scss/variables";
+@import"../node_modules/bootstrap/scss/mixins";
+
+// Optional
+@import"../node_modules/bootstrap/scss/root";
+@import"../node_modules/bootstrap/scss/reboot";
+@import"../node_modules/bootstrap/scss/type";
+@import"../node_modules/bootstrap/scss/images";
+@import"../node_modules/bootstrap/scss/containers";
+@import"../node_modules/bootstrap/scss/grid";
+
With that setup in place, you can begin to modify any of the Sass variables and maps in your custom.scss. You can also start to add parts of Bootstrap under the // Optional section as needed. We suggest using the full import stack from our bootstrap.scss file as your starting point.
+
Variable defaults
+
Every Sass variable in Bootstrap includes the !default flag allowing you to override the variable’s default value in your own Sass without modifying Bootstrap’s source code. Copy and paste variables as needed, modify their values, and remove the !default flag. If a variable has already been assigned, then it won’t be re-assigned by the default values in Bootstrap.
+
You will find the complete list of Bootstrap’s variables in scss/_variables.scss. Some variables are set to null, these variables don’t output the property unless they are overridden in your configuration.
+
Variable overrides within the same Sass file can come before or after the default variables. However, when overriding across Sass files, your overrides must come before you import Bootstrap’s Sass files.
+
Here’s an example that changes the background-color and color for the <body> when importing and compiling Bootstrap via npm:
+
// Your variable overrides
+$body-bg:#000;
+$body-color:#111;
+
+// Bootstrap and its default variables
+@import"../node_modules/bootstrap/scss/bootstrap";
+
Repeat as necessary for any variable in Bootstrap, including the global options below.
+
Maps and loops
+
Bootstrap includes a handful of Sass maps, key value pairs that make it easier to generate families of related CSS. We use Sass maps for our colors, grid breakpoints, and more. Just like Sass variables, all Sass maps include the !default flag and can be overridden and extended.
+
Some of our Sass maps are merged into empty ones by default. This is done to allow easy expansion of a given Sass map, but comes at the cost of making removing items from a map slightly more difficult.
+
Modify map
+
All variables in the $theme-colors map are defined as standalone variables. To modify an existing color in our $theme-colors map, add the following to your custom Sass file:
+
$primary:#0074d9;
+$danger:#ff4136;
+
Later on, theses variables are set in Bootstrap’s $theme-colors map:
Add new colors to $theme-colors, or any other map, by creating a new Sass map with your custom values and merging it with the original map. In this case, we’ll create a new $custom-colors map and merge it with $theme-colors.
+
// Create your own map
+$custom-colors:(
+ "custom-color":#900
+);
+
+// Merge the maps
+$theme-colors:map-merge($theme-colors,$custom-colors);
+
Remove from map
+
To remove colors from $theme-colors, or any other map, use map-remove. Be aware you must insert it between our requirements and options:
Bootstrap assumes the presence of some specific keys within Sass maps as we used and extend these ourselves. As you customize the included maps, you may encounter errors where a specific Sass map’s key is being used.
+
For example, we use the primary, success, and danger keys from $theme-colors for links, buttons, and form states. Replacing the values of these keys should present no issues, but removing them may cause Sass compilation issues. In these instances, you’ll need to modify the Sass code that makes use of those values.
+
Functions
+
Colors
+
Next to the Sass maps we have, theme colors can also be used as standalone variables, like $primary.
You can lighten or darken colors with Bootstrap’s tint-color() and shade-color() functions. These functions will mix colors with black or white, unlike Sass' native lighten() and darken() functions which will change the lightness by a fixed amount, which often doesn’t lead to the desired effect.
+
// Tint a color: mix a color with white
+@functiontint-color($color,$weight){
+ @returnmix(white,$color,$weight);
+}
+
+// Shade a color: mix a color with black
+@functionshade-color($color,$weight){
+ @returnmix(black,$color,$weight);
+}
+
+// Shade the color if the weight is positive, else tint it
+@functionshift-color($color,$weight){
+ @returnif($weight>0,shade-color($color,$weight),tint-color($color,-$weight));
+}
+
In practice, you’d call the function and pass in the color and weight parameters.
An additional function we include in Bootstrap is the color contrast function, color-contrast. It utilizes the WCAG 2.0 algorithm for calculating contrast thresholds based on relative luminance in a sRGB colorspace to automatically return a light (#fff), dark (#212529) or black (#000) contrast color based on the specified base color. This function is especially useful for mixins or loops where you’re generating multiple classes.
+
For example, to generate color swatches from our $theme-colors map:
We use the escape-svg function to escape the <, > and # characters for SVG background images. When using the escape-svg function, data URIs must be quoted.
+
Add and Subtract functions
+
We use the add and subtract functions to wrap the CSS calc function. The primary purpose of these functions is to avoid errors when a “unitless” 0 value is passed into a calc expression. Expressions like calc(10px - 0) will return an error in all browsers, despite being mathematically correct.
+
Example where the calc is valid:
+
$border-radius:.25rem;
+$border-width:1px;
+
+.element{
+ // Output calc(.25rem - 1px) is valid
+border-radius:calc($border-radius-$border-width);
+}
+
+.element{
+ // Output the same calc(.25rem - 1px) as above
+border-radius:subtract($border-radius,$border-width);
+}
+
` all receive top and bottom margins. We nuke the top\n// margin for easier control within type scales as it avoids margin collapsing.\n\n%heading {\n margin-top: 0; // 1\n margin-bottom: $headings-margin-bottom;\n font-family: $headings-font-family;\n font-style: $headings-font-style;\n font-weight: $headings-font-weight;\n line-height: $headings-line-height;\n color: $headings-color;\n}\n\nh1 {\n @extend %heading;\n @include font-size($h1-font-size);\n}\n\nh2 {\n @extend %heading;\n @include font-size($h2-font-size);\n}\n\nh3 {\n @extend %heading;\n @include font-size($h3-font-size);\n}\n\nh4 {\n @extend %heading;\n @include font-size($h4-font-size);\n}\n\nh5 {\n @extend %heading;\n @include font-size($h5-font-size);\n}\n\nh6 {\n @extend %heading;\n @include font-size($h6-font-size);\n}\n\n\n// Reset margins on paragraphs\n//\n// Similarly, the top margin on `
`s get reset. However, we also reset the\n// bottom margin to use `rem` units instead of `em`.\n\np {\n margin-top: 0;\n margin-bottom: $paragraph-margin-bottom;\n}\n\n\n// Abbreviations\n//\n// 1. Duplicate behavior to the data-bs-* attribute for our tooltip plugin\n// 2. Add the correct text decoration in Chrome, Edge, Opera, and Safari.\n// 3. Add explicit cursor to indicate changed behavior.\n// 4. Prevent the text-decoration to be skipped.\n\nabbr[title],\nabbr[data-bs-original-title] { // 1\n text-decoration: underline; // 2\n text-decoration: underline dotted; // 2\n cursor: help; // 3\n text-decoration-skip-ink: none; // 4\n}\n\n\n// Address\n\naddress {\n margin-bottom: 1rem;\n font-style: normal;\n line-height: inherit;\n}\n\n\n// Lists\n\nol,\nul {\n padding-left: 2rem;\n}\n\nol,\nul,\ndl {\n margin-top: 0;\n margin-bottom: 1rem;\n}\n\nol ol,\nul ul,\nol ul,\nul ol {\n margin-bottom: 0;\n}\n\ndt {\n font-weight: $dt-font-weight;\n}\n\n// 1. Undo browser default\n\ndd {\n margin-bottom: .5rem;\n margin-left: 0; // 1\n}\n\n\n// Blockquote\n\nblockquote {\n margin: 0 0 1rem;\n}\n\n\n// Strong\n//\n// Add the correct font weight in Chrome, Edge, and Safari\n\nb,\nstrong {\n font-weight: $font-weight-bolder;\n}\n\n\n// Small\n//\n// Add the correct font size in all browsers\n\nsmall {\n @include font-size($small-font-size);\n}\n\n\n// Mark\n\nmark {\n padding: $mark-padding;\n background-color: $mark-bg;\n}\n\n\n// Sub and Sup\n//\n// Prevent `sub` and `sup` elements from affecting the line height in\n// all browsers.\n\nsub,\nsup {\n position: relative;\n @include font-size($sub-sup-font-size);\n line-height: 0;\n vertical-align: baseline;\n}\n\nsub { bottom: -.25em; }\nsup { top: -.5em; }\n\n\n// Links\n\na {\n color: $link-color;\n text-decoration: $link-decoration;\n\n &:hover {\n color: $link-hover-color;\n text-decoration: $link-hover-decoration;\n }\n}\n\n// And undo these styles for placeholder links/named anchors (without href).\n// It would be more straightforward to just use a[href] in previous block, but that\n// causes specificity issues in many other styles that are too complex to fix.\n// See https://github.com/twbs/bootstrap/issues/19402\n\na:not([href]):not([class]) {\n &,\n &:hover {\n color: inherit;\n text-decoration: none;\n }\n}\n\n\n// Code\n\npre,\ncode,\nkbd,\nsamp {\n font-family: $font-family-code;\n @include font-size(1em); // Correct the odd `em` font sizing in all browsers.\n direction: ltr #{\"/* rtl:ignore */\"};\n unicode-bidi: bidi-override;\n}\n\n// 1. Remove browser default top margin\n// 2. Reset browser default of `1em` to use `rem`s\n// 3. Don't allow content to break outside\n\npre {\n display: block;\n margin-top: 0; // 1\n margin-bottom: 1rem; // 2\n overflow: auto; // 3\n @include font-size($code-font-size);\n color: $pre-color;\n\n // Account for some code outputs that place code tags in pre tags\n code {\n @include font-size(inherit);\n color: inherit;\n word-break: normal;\n }\n}\n\ncode {\n @include font-size($code-font-size);\n color: $code-color;\n word-wrap: break-word;\n\n // Streamline the style when inside anchors to avoid broken underline and more\n a > & {\n color: inherit;\n }\n}\n\nkbd {\n padding: $kbd-padding-y $kbd-padding-x;\n @include font-size($kbd-font-size);\n color: $kbd-color;\n background-color: $kbd-bg;\n @include border-radius($border-radius-sm);\n\n kbd {\n padding: 0;\n @include font-size(1em);\n font-weight: $nested-kbd-font-weight;\n }\n}\n\n\n// Figures\n//\n// Apply a consistent margin strategy (matches our type styles).\n\nfigure {\n margin: 0 0 1rem;\n}\n\n\n// Images and content\n\nimg,\nsvg {\n vertical-align: middle;\n}\n\n\n// Tables\n//\n// Prevent double borders\n\ntable {\n caption-side: bottom;\n border-collapse: collapse;\n}\n\ncaption {\n padding-top: $table-cell-padding-y;\n padding-bottom: $table-cell-padding-y;\n color: $table-caption-color;\n text-align: left;\n}\n\n// 1. Removes font-weight bold by inheriting\n// 2. Matches default `
` alignment by inheriting `text-align`.\n// 3. Fix alignment for Safari\n\nth {\n font-weight: $table-th-font-weight; // 1\n text-align: inherit; // 2\n text-align: -webkit-match-parent; // 3\n}\n\nthead,\ntbody,\ntfoot,\ntr,\ntd,\nth {\n border-color: inherit;\n border-style: solid;\n border-width: 0;\n}\n\n\n// Forms\n//\n// 1. Allow labels to use `margin` for spacing.\n\nlabel {\n display: inline-block; // 1\n}\n\n// Remove the default `border-radius` that macOS Chrome adds.\n// See https://github.com/twbs/bootstrap/issues/24093\n\nbutton {\n // stylelint-disable-next-line property-disallowed-list\n border-radius: 0;\n}\n\n// Work around a Firefox bug where the transparent `button` background\n// results in a loss of the default `button` focus styles.\n// Credit https://github.com/suitcss/base/\n\nbutton:focus {\n outline: dotted 1px;\n outline: -webkit-focus-ring-color auto 5px;\n}\n\n// 1. Remove the margin in Firefox and Safari\n\ninput,\nbutton,\nselect,\noptgroup,\ntextarea {\n margin: 0; // 1\n font-family: inherit;\n @include font-size(inherit);\n line-height: inherit;\n}\n\n// Remove the inheritance of text transform in Firefox\n\nbutton,\nselect {\n text-transform: none;\n}\n\n// Set the cursor for non-`
+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+