Home Get StartedTokensDocsComponents

Modal

Modals are overlays that display content in a layer above the page requires user interaction.

Contents

Bootstrap 5 Modal dialog component

Responsive modal dialog built with the latest Bootstrap 5. Modal is used for display content in a layer above the page, includes prompts, configurations, cookie consents, etc.

Use Bootstrap’s JavaScript modal plugin to add dialogs to your site for lightboxes, user notifications, or completely custom content.

Toggle a working modal demo by clicking the button below. It will slide down and fade in from the top of the page.

<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModal">
  Open Modal
</button>
<div class="modal fade" tabindex="-1" id="exampleModal" aria-labelledby="exampleModalLabel" aria-hidden="true">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title" id="exampleModalLabel">Modal title</h5>
        <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
      </div>
      <div class="modal-body">
        Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum pretium nisi nunc, 
        sit amet tincidunt ipsum faucibus vitae. Pellentesque eget odio tristique, mattis elit id.
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-subtle" data-bs-dismiss="modal">Secondary Action</button>
        <button type="button" class="btn btn-primary">Confirm</button>
      </div>
    </div>
  </div>
</div>

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.
  • 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:
const myModal = document.getElementById('myModal')
const myInput = document.getElementById('myInput')

myModal.addEventListener('shown.bs.modal', () => {
  myInput.focus()
})

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.

Modal title

Modal body text goes here.

<div class="modal" tabindex="-1">
  <div class="modal-dialog shadow">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title">Modal title</h5>
        <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
      </div>
      <div class="modal-body">
        <p class="mb-0">Modal body text goes here.</p>
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-subtle" data-bs-dismiss="modal">Close</button>
        <button type="button" class="btn btn-primary">Save changes</button>
      </div>
    </div>
  </div>
</div>

Static backdrop

When backdrop is set to static by data-bs-backdrop="static", the modal will not close when clicking outside of it. Click the button below to try it.

<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#staticBackdrop">
  Open static backdrop modal
</button>
<div class="modal fade" id="staticBackdrop" data-bs-backdrop="static"
 data-bs-keyboard="false" tabindex="-1" aria-labelledby="staticBackdropLabel" aria-hidden="true">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title" id="staticBackdropLabel">Modal title</h5>
        <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
      </div>
      <div class="modal-body">
        Sit nulla est ex deserunt exercitation anim occaecat. Nostrud ullamco 
        deserunt aute id consequat veniam incididunt duis in sint irure nisi. 
        Mollit officia cillum Lorem ullamco minim nostrud elit officia tempor esse quis.
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-subtle" data-bs-dismiss="modal">Close</button>
        <button type="button" class="btn btn-primary">Understood</button>
      </div>
    </div>
  </div>
</div>

Width

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.

SizeClassModal max-width
Small.modal-sm400px
DefaultNone600px
Large.modal-lg800px
Extra large.modal-xl968px

Our default modal without modifier class constitutes the “medium” size modal.

<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModalSm">
  Small model
</button>
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModalMd">
  Medium model
</button>
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModalLg">
  Large model
</button>
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModalXl">
  X-large model
</button>

Scrolling long content

By default, when modals become too long for the user’s viewport or device, they scroll independent of the page itself. You can also create a scrollable modal that allows scroll the modal body by adding .modal-dialog-scrollable to .modal-dialog.

<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#scrollBodyModal">
  Scroll inside body
</button>
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#scrollViewportModal">
  Scroll inside viewport
</button>
<div class="modal fade" id="scrollBodyModal" data-bs-keyboard="false" tabindex="-1" aria-hidden="true">
  <div class="modal-dialog modal-dialog-scrollable">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title">Modal title</h5>
      </div>
      <div class="modal-body">
        <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. In aliquet nunc massa, sed posuere eros feugiat ac. Ut vestibulum purus vitae tempor laoreet. Pellentesque mollis cursus ipsum ut interdum. Fusce faucibus a dolor vitae condimentum. Nulla id ex interdum, consequat risus non, elementum lectus. Vestibulum felis dolor, iaculis vel pellentesque sit amet, mattis in lacus. Donec eu aliquam turpis. Pellentesque dignissim sem id sem commodo viverra. Maecenas a ligula eu quam tincidunt pellentesque at at nunc. Quisque euismod, nisi fermentum consequat euismod, sapien urna malesuada augue, a pellentesque mi felis at magna. Nam dignissim arcu ac dolor iaculis faucibus.</p>
        <p>In interdum eget lorem in tincidunt. Mauris cursus sollicitudin consectetur. Ut sodales pulvinar ante vitae gravida. Etiam ipsum eros, egestas eget ex vitae, lobortis vestibulum est. Cras eu dui consectetur, porttitor tortor nec, rutrum tellus. Pellentesque sagittis, leo vel pulvinar tempor, neque nisl vestibulum ante, non cursus quam lectus suscipit turpis. Cras aliquam massa orci, quis convallis odio imperdiet tempus. Pellentesque facilisis et purus id semper. Quisque mi nisl, consectetur auctor nunc non, tempor porta sapien. Pellentesque et velit quis leo accumsan ultrices sed et felis. Proin malesuada mi eu odio dignissim, et vehicula ante ultrices.</p>
        <p>Aenean et posuere tortor. Suspendisse eleifend ipsum ligula. Fusce quis ornare enim. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque auctor velit in purus malesuada aliquam. Praesent vehicula blandit erat, nec vulputate turpis posuere vitae. Nam pharetra vehicula tortor, ut molestie ligula tincidunt ut. Aliquam sit amet venenatis ipsum, at commodo nunc. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus ullamcorper nibh et mauris vulputate fringilla.</p>
        <p>Phasellus vitae justo sem. Phasellus eget rutrum massa, vitae pharetra orci. Phasellus sollicitudin bibendum urna in suscipit. Morbi posuere nulla at lorem sagittis blandit. Quisque non velit eget metus vehicula suscipit sed ut nunc. Etiam sollicitudin sagittis mi, sed tincidunt neque feugiat vel. Fusce elementum aliquet feugiat. Morbi et egestas dui, eget dignissim leo. Etiam a facilisis lacus. Integer convallis sodales magna, dignissim fermentum purus facilisis eu. Pellentesque eleifend id nulla et mattis. Morbi quis sodales augue, ut convallis nisi. Nulla pharetra magna dolor, et rhoncus urna pulvinar eget.</p>
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-primary" data-bs-dismiss="modal">Close</button>
      </div>
    </div>
  </div>
</div>
<div class="modal fade" id="scrollViewportModal" data-bs-keyboard="false" tabindex="-1" aria-hidden="true">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title">Modal title</h5>       
      </div>
      <div class="modal-body">
        <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. In aliquet nunc massa, sed posuere eros feugiat ac. Ut vestibulum purus vitae tempor laoreet. Pellentesque mollis cursus ipsum ut interdum. Fusce faucibus a dolor vitae condimentum. Nulla id ex interdum, consequat risus non, elementum lectus. Vestibulum felis dolor, iaculis vel pellentesque sit amet, mattis in lacus. Donec eu aliquam turpis. Pellentesque dignissim sem id sem commodo viverra. Maecenas a ligula eu quam tincidunt pellentesque at at nunc. Quisque euismod, nisi fermentum consequat euismod, sapien urna malesuada augue, a pellentesque mi felis at magna. Nam dignissim arcu ac dolor iaculis faucibus.</p>
        <p>In interdum eget lorem in tincidunt. Mauris cursus sollicitudin consectetur. Ut sodales pulvinar ante vitae gravida. Etiam ipsum eros, egestas eget ex vitae, lobortis vestibulum est. Cras eu dui consectetur, porttitor tortor nec, rutrum tellus. Pellentesque sagittis, leo vel pulvinar tempor, neque nisl vestibulum ante, non cursus quam lectus suscipit turpis. Cras aliquam massa orci, quis convallis odio imperdiet tempus. Pellentesque facilisis et purus id semper. Quisque mi nisl, consectetur auctor nunc non, tempor porta sapien. Pellentesque et velit quis leo accumsan ultrices sed et felis. Proin malesuada mi eu odio dignissim, et vehicula ante ultrices.</p>
        <p>Aenean et posuere tortor. Suspendisse eleifend ipsum ligula. Fusce quis ornare enim. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque auctor velit in purus malesuada aliquam. Praesent vehicula blandit erat, nec vulputate turpis posuere vitae. Nam pharetra vehicula tortor, ut molestie ligula tincidunt ut. Aliquam sit amet venenatis ipsum, at commodo nunc. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus ullamcorper nibh et mauris vulputate fringilla.</p>
        <p>Phasellus vitae justo sem. Phasellus eget rutrum massa, vitae pharetra orci. Phasellus sollicitudin bibendum urna in suscipit. Morbi posuere nulla at lorem sagittis blandit. Quisque non velit eget metus vehicula suscipit sed ut nunc. Etiam sollicitudin sagittis mi, sed tincidunt neque feugiat vel. Fusce elementum aliquet feugiat. Morbi et egestas dui, eget dignissim leo. Etiam a facilisis lacus. Integer convallis sodales magna, dignissim fermentum purus facilisis eu. Pellentesque eleifend id nulla et mattis. Morbi quis sodales augue, ut convallis nisi. Nulla pharetra magna dolor, et rhoncus urna pulvinar eget.</p>
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-primary" data-bs-dismiss="modal">Close</button>
      </div>
    </div>
  </div>
</div>

Vertically centered

Add .modal-dialog-centered to .modal-dialog to vertically center the modal.

<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModalCenter">
  Vertically centered modal
</button>
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModalCenteredScrollable">
  Vertically centered scrollable modal
</button>
<div class="modal fade" id="exampleModalCenter" data-bs-keyboard="false" tabindex="-1" aria-hidden="true">
  <div class="modal-dialog modal-dialog-centered">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title">Modal title</h5>
        <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
      </div>
      <div class="modal-body">
        Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum pretium nisi nunc, 
        sit amet tincidunt ipsum faucibus vitae. Pellentesque eget odio tristique, mattis elit id.
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-subtle" data-bs-dismiss="modal">Close</button>
        <button type="button" class="btn btn-primary">Save changes</button>
      </div>
    </div>
  </div>
</div>
<div class="modal fade" id="exampleModalCenteredScrollable" data-bs-keyboard="false" tabindex="-1" aria-hidden="true">
  <div class="modal-dialog modal-dialog-centered modal-dialog-scrollable">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title">Modal title</h5>
        <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
      </div>
      <div class="modal-body">
         <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. In aliquet nunc massa, sed posuere eros feugiat ac. Ut vestibulum purus vitae tempor laoreet. Pellentesque mollis cursus ipsum ut interdum. Fusce faucibus a dolor vitae condimentum. Nulla id ex interdum, consequat risus non, elementum lectus. Vestibulum felis dolor, iaculis vel pellentesque sit amet, mattis in lacus. Donec eu aliquam turpis. Pellentesque dignissim sem id sem commodo viverra. Maecenas a ligula eu quam tincidunt pellentesque at at nunc. Quisque euismod, nisi fermentum consequat euismod, sapien urna malesuada augue, a pellentesque mi felis at magna. Nam dignissim arcu ac dolor iaculis faucibus.</p>
        <p>In interdum eget lorem in tincidunt. Mauris cursus sollicitudin consectetur. Ut sodales pulvinar ante vitae gravida. Etiam ipsum eros, egestas eget ex vitae, lobortis vestibulum est. Cras eu dui consectetur, porttitor tortor nec, rutrum tellus. Pellentesque sagittis, leo vel pulvinar tempor, neque nisl vestibulum ante, non cursus quam lectus suscipit turpis. Cras aliquam massa orci, quis convallis odio imperdiet tempus. Pellentesque facilisis et purus id semper. Quisque mi nisl, consectetur auctor nunc non, tempor porta sapien. Pellentesque et velit quis leo accumsan ultrices sed et felis. Proin malesuada mi eu odio dignissim, et vehicula ante ultrices.</p>
        <p>Aenean et posuere tortor. Suspendisse eleifend ipsum ligula. Fusce quis ornare enim. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque auctor velit in purus malesuada aliquam. Praesent vehicula blandit erat, nec vulputate turpis posuere vitae. Nam pharetra vehicula tortor, ut molestie ligula tincidunt ut. Aliquam sit amet venenatis ipsum, at commodo nunc. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus ullamcorper nibh et mauris vulputate fringilla.</p>
        <p>Phasellus vitae justo sem. Phasellus eget rutrum massa, vitae pharetra orci. Phasellus sollicitudin bibendum urna in suscipit. Morbi posuere nulla at lorem sagittis blandit. Quisque non velit eget metus vehicula suscipit sed ut nunc. Etiam sollicitudin sagittis mi, sed tincidunt neque feugiat vel. Fusce elementum aliquet feugiat. Morbi et egestas dui, eget dignissim leo. Etiam a facilisis lacus. Integer convallis sodales magna, dignissim fermentum purus facilisis eu. Pellentesque eleifend id nulla et mattis. Morbi quis sodales augue, ut convallis nisi. Nulla pharetra magna dolor, et rhoncus urna pulvinar eget.</p>
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-subtle" data-bs-dismiss="modal">Close</button>
        <button type="button" class="btn btn-primary">Save changes</button>
      </div>
    </div>
  </div>
</div>

Tooltips and popovers

Tooltips and popovers can be placed within modals as needed. When modals are closed, any tooltips and popovers within are also automatically dismissed.

<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModalPopovers">
  Open model
</button>
<div class="modal fade" id="exampleModalPopovers" tabindex="-1" aria-hidden="true">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title">Modal title</h5>
      </div>
      <div class="modal-body">
        <h5>Popover in a modal</h5>
        <p>This <a href="#" role="button" class="btn btn-primary" data-bs-toggle="popover" 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><a href="#" data-bs-toggle="tooltip" title="Tooltip">This link</a> and <a href="#" data-bs-toggle="tooltip" title="Tooltip">that link</a> have tooltips on hover.</p>
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-subtle" data-bs-dismiss="modal">Close</button>
        <button type="button" class="btn btn-primary">Save changes</button>
      </div>
    </div>
  </div>
</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.

<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#gridSystemModal">
  Open model
</button>
<div class="modal fade" id="gridSystemModal" tabindex="-1" aria-hidden="true">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title">Modal title</h5>
      </div>
      <div class="modal-body">
        <div class="container-fluid">
          <div class="row">
            <div class="col-md-4 ">.col-md-4</div>
            <div class="col-md-4 ms-auto">.col-md-4 .ms-auto</div>
          </div>
          <div class="row">
            <div class="col-md-3 ms-auto">.col-md-3 .ms-auto</div>
            <div class="col-md-2 ms-auto">.col-md-2 .ms-auto</div>
          </div>
          <div class="row">
            <div class="col-md-6 ms-auto">.col-md-6 .ms-auto</div>
          </div>
          <div class="row">
            <div class="col-sm-9">
              Level 1: .col-sm-9
              <div class="row">
                <div class="col-8 col-sm-6">Level 2: .col-8 .col-sm-6</div>
                <div class="col-4 col-sm-6">Level 2: .col-4 .col-sm-6</div>
              </div>
            </div>
          </div>
        </div>
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-subtle" data-bs-dismiss="modal">Close</button>
        <button type="button" class="btn btn-primary">Save changes</button>
      </div>
    </div>
  </div>
</div>

Multiple modals

Toggle between multiple modals with some clever placement of the data-bs-target and data-bs-toggle attributes. For example, you could toggle a password reset modal from within an already open sign in modal.

<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModalToggle">
  Open: first modal
</button>
<div class="modal fade" id="exampleModalToggle" aria-hidden="true" tabindex="-1">
  <div class="modal-dialog modal-lg">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title" id="exampleModalToggleLabel">First Modal</h5>
      </div>
      <div class="modal-body">
        Show a second modal and hide this one with the button below.
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-subtle" data-bs-dismiss="modal">Close</button>
        <button class="btn btn-primary" data-bs-target="#exampleModalToggle2" data-bs-toggle="modal">
          Open: second modal
        </button>
      </div>
    </div>
  </div>
</div>
<div class="modal fade" id="exampleModalToggle2" aria-hidden="true" tabindex="-1">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title" id="exampleModalToggleLabel2">Second modal</h5>        
      </div>
      <div class="modal-body">
        Hide this modal and show the first with the button below.
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-subtle" data-bs-dismiss="modal">Close</button>
        <button class="btn btn-primary" data-bs-target="#exampleModalToggle" data-bs-toggle="modal">
          Back: first modal
        </button>
      </div>
    </div>
  </div>
</div>

Fullscreen Modals

Another override is the option to pop up a modal that covers the user viewport, available via modifier classes that are placed on a .modal-dialog.

ClassAvailability
.modal-fullscreenAlways
.modal-fullscreen-sm-down576px
.modal-fullscreen-md-down768px
.modal-fullscreen-lg-down992px
.modal-fullscreen-xl-down1200px
.modal-fullscreen-xxl-down1400px
<div class="modal-dialog modal-fullscreen">
  ...
</div>

<div class="modal-dialog modal-fullscreen-sm-down">
  ...
</div>

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.

<div class="modal" tabindex="-1" aria-labelledby="..." aria-hidden="true">
  ...
</div>

Dynamic heights

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.

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.

Accessibility

(WAI-ARIA: https://www.w3.org/WAI/ARIA/apg/patterns/dialogmodal/)

  • Be sure to add aria-labelledby="id...", referencing the modal title, to .modal. Additionally, you may give a description of your modal dialog with aria-describedby="id..." on .modal. Note that you don’t need to add role="dialog" since we already add it via JavaScript.
  • The WAI-ARIA authoring practices can help you set the initial focus on the most relevant element, based on your modal content.
Edit this page on Github
Last updated on April 6, 2024
Contents

Usage

The modal plugin toggles your hidden content on demand, via data attributes or JavaScript. It also overrides default scrolling behavior and generates a .modal-backdrop to provide a click area for dismissing shown modals when clicking outside the modal.

Use data attributes

Toggle

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.

<button type="button" data-bs-toggle="modal" data-bs-target="#myModal">Launch modal</button>

Dismiss

Dismissal can be achieved with the data attribute on a button within the modal as demonstrated below:

<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>

or on a button outside the modal using the data-bs-target as demonstrated below:

<button type="button" class="btn-close" data-bs-dismiss="modal" data-bs-target="#my-modal" aria-label="Close"></button>

Use JavaScript

Create a modal with a single line of JavaScript:

const myModal = new bootstrap.Modal(document.getElementById('myModal'), options)
// or
const myModalAlternative = new bootstrap.Modal('#myModal', options)

Options

As options can be passed via data attributes or JavaScript, you can append an option name to data-bs-, as in data-bs-animation="{value}". Make sure to change the case type of the option name from “camelCase” to “kebab-case” when passing the options via data attributes. For example, use data-bs-custom-class="beautifier" instead of data-bs-customClass="beautifier".

As of Bootstrap 5.2.0, all components support an experimental reserved data attribute data-bs-config that can house simple component configuration as a JSON string. When an element has data-bs-config='{"delay":0, "title":123}' and data-bs-title="456" attributes, the final title value will be 456 and the separate data attributes will override values given on data-bs-config. In addition, existing data attributes are able to house JSON values like data-bs-delay='{"show":0,"hide":150}'.

NameTypeDefaultDescription
backdropboolean, 'static'trueIncludes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn’t close the modal when clicked.
focusbooleantruePuts the focus on the modal when initialized.
keyboardbooleantrueCloses the modal when escape key is pressed.

Methods

Passing options

Activates your content as a modal. Accepts an optional options object.

const myModal = new bootstrap.Modal('#myModal', {
  keyboard: false
})
MethodDescription
disposeDestroys an element’s modal. (Removes stored data on the DOM element)
getInstanceStatic method which allows you to get the modal instance associated with a DOM element.
getOrCreateInstanceStatic method which allows you to get the modal instance associated with a DOM element, or create a new one in case it wasn’t initialized.
handleUpdateManually readjust the modal’s position if the height of a modal changes while it is open (i.e. in case a scrollbar appears).
hideManually hides a modal. Returns to the caller before the modal has actually been hidden (i.e. before the hidden.bs.modal event occurs).
showManually opens a modal. Returns to the caller before the modal has actually been shown (i.e. before the shown.bs.modal event occurs). Also, you can pass a DOM element as an argument that can be received in the modal events (as the relatedTarget property). (i.e. const modalToggle = document.getElementById('toggleMyModal'); myModal.show(modalToggle)
toggleManually 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).

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">).

EventDescription
hide.bs.modalThis event is fired immediately when the hide instance method has been called.
hidden.bs.modalThis event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).
hidePrevented.bs.modalThis event is fired when the modal is shown, its backdrop is static and a click outside of the modal is performed. The event is also fired when the escape key is pressed and the keyboard option is set to false.
show.bs.modalThis 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.modalThis 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.
const myModalEl = document.getElementById('myModal')
myModalEl.addEventListener('hidden.bs.modal', event => {
  // do something...
})
Edit this page on Github
Last updated on April 6, 2024