Back to Bootstrap

Close button

site/src/content/docs/components/close-button.mdx

5.3.81.7 KB
Original Source

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.

<Example code={<button type="button" class="btn-close" aria-label="Close"></button>} />

Disabled state

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.

<Example code={<button type="button" class="btn-close" disabled aria-label="Close"></button>} />

Dark variant

<DeprecatedIn version="5.3.0" /> <Callout type="warning"> **Heads up!** As of v5.3.0, the `.btn-close-white` class is deprecated. Instead, use `data-bs-theme="dark"` to change the color mode of the close button. </Callout>

Add data-bs-theme="dark" to the .btn-close, or to its parent element, to invert the close button. This uses the filter property to invert the background-image without overriding its value.

<Example class="bg-dark" code={`<div data-bs-theme="dark"> <button type="button" class="btn-close" aria-label="Close"></button> <button type="button" class="btn-close" disabled aria-label="Close"></button>

</div>`} />

CSS

Variables

<AddedIn version="5.3.0" />

As part of Bootstrap’s evolving CSS variables approach, close button now uses local CSS variables on .btn-close for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.

<ScssDocs name="close-css-vars" file="scss/_close.scss" />

Sass variables

<ScssDocs name="close-variables" file="scss/_variables.scss" />