Modals are built with HTML, CSS, and JavaScript. They’re positioned over everything else in the document and remove scroll from the 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.
Modal body text goes here.
<divclass="modal"tabindex="-1"><divclass="modal-dialog"><divclass="modal-content"><divclass="modal-header"><h5class="modal-title">Modal titleh5><buttontype="button"class="btn-close"data-bs-dismiss="modal"aria-label="Close">button>div><divclass="modal-body"><p>Modal body text goes here.p>div><divclass="modal-footer"><buttontype="button"class="btn btn-secondary"data-bs-dismiss="modal">Closebutton><buttontype="button"class="btn btn-primary">Save changesbutton>div>div>div>div>
Live demo
Toggle a working modal demo by clicking the button below. It will slide down and fade in from the top of the page.
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 modalh5><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.">buttona> triggers a popover on click.p><hr><h5>Tooltips in a modalh5><p><ahref="#"class="tooltip-test"title="Tooltip">This linka> and <ahref="#"class="tooltip-test"title="Tooltip">that linka> 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.
<buttontype="button"class="btn btn-primary"data-bs-toggle="modal"data-bs-target="#exampleModal"data-bs-whatever="@mdo">Open modal for @mdobutton><buttontype="button"class="btn btn-primary"data-bs-toggle="modal"data-bs-target="#exampleModal"data-bs-whatever="@fat">Open modal for @fatbutton><buttontype="button"class="btn btn-primary"data-bs-toggle="modal"data-bs-target="#exampleModal"data-bs-whatever="@getbootstrap">Open modal for @getbootstrapbutton><divclass="modal fade"id="exampleModal"tabindex="-1"aria-labelledby="exampleModalLabel"aria-hidden="true"><divclass="modal-dialog"><divclass="modal-content"><divclass="modal-header"><h5class="modal-title"id="exampleModalLabel">New messageh5><buttontype="button"class="btn-close"data-bs-dismiss="modal"aria-label="Close">button>div><divclass="modal-body"><form><divclass="mb-3"><labelfor="recipient-name"class="col-form-label">Recipient:label><inputtype="text"class="form-control"id="recipient-name">div><divclass="mb-3"><labelfor="message-text"class="col-form-label">Message:label><textareaclass="form-control"id="message-text">textarea>div>form>div><divclass="modal-footer"><buttontype="button"class="btn btn-secondary"data-bs-dismiss="modal">Closebutton><buttontype="button"class="btn btn-primary">Send messagebutton>div>div>div>div>
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 '+recipientmodalBodyInput.value=recipient})
Toggle between 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. Please note multiple modals cannot be open at the same
time—this method simply toggles between two separate modals.
<divclass="modal fade"id="exampleModalToggle"aria-hidden="true"aria-labelledby="exampleModalToggleLabel"tabindex="-1"><divclass="modal-dialog modal-dialog-centered"><divclass="modal-content"><divclass="modal-header"><h5class="modal-title"id="exampleModalToggleLabel">Modal 1h5><buttontype="button"class="btn-close"data-bs-dismiss="modal"aria-label="Close">button>div><divclass="modal-body">
Show a second modal and hide this one with the button below.
div><divclass="modal-footer"><buttonclass="btn btn-primary"data-bs-target="#exampleModalToggle2"data-bs-toggle="modal"data-bs-dismiss="modal">Open second modalbutton>div>div>div>div><divclass="modal fade"id="exampleModalToggle2"aria-hidden="true"aria-labelledby="exampleModalToggleLabel2"tabindex="-1"><divclass="modal-dialog modal-dialog-centered"><divclass="modal-content"><divclass="modal-header"><h5class="modal-title"id="exampleModalToggleLabel2">Modal 2h5><buttontype="button"class="btn-close"data-bs-dismiss="modal"aria-label="Close">button>div><divclass="modal-body">
Hide this modal and show the first with the button below.
div><divclass="modal-footer"><buttonclass="btn btn-primary"data-bs-target="#exampleModalToggle"data-bs-toggle="modal"data-bs-dismiss="modal">Back to firstbutton>div>div>div>div><aclass="btn btn-primary"data-bs-toggle="modal"href="#exampleModalToggle"role="button">Open first modala>
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.
$modal-inner-padding:$spacer;$modal-footer-margin-between:.5rem;$modal-dialog-margin:.5rem;$modal-dialog-margin-y-sm-up:1.75rem;$modal-title-line-height:$line-height-base;$modal-content-color:null;$modal-content-bg:$white;$modal-content-border-color:rgba($black,.2);$modal-content-border-width:$border-width;$modal-content-border-radius:$border-radius-lg;$modal-content-inner-border-radius:subtract($modal-content-border-radius,$modal-content-border-width);$modal-content-box-shadow-xs:$box-shadow-sm;$modal-content-box-shadow-sm-up:$box-shadow;$modal-backdrop-bg:$black;$modal-backdrop-opacity:.5;$modal-header-border-color:$border-color;$modal-footer-border-color:$modal-header-border-color;$modal-header-border-width:$modal-content-border-width;$modal-footer-border-width:$modal-header-border-width;$modal-header-padding-y:$modal-inner-padding;$modal-header-padding-x:$modal-inner-padding;$modal-header-padding:$modal-header-padding-y$modal-header-padding-x;// Keep this for backwards compatibility
$modal-sm:300px;$modal-md:500px;$modal-lg:800px;$modal-xl:1140px;$modal-fade-transform:translate(0,-50px);$modal-show-transform:none;$modal-transition:transform.3sease-out;$modal-scale-transform:scale(1.02);
Loop
Responsive fullscreen modals are generated via the $breakpoints map and a loop in scss/_modal.scss.
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.
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.
See our JavaScript documentation for more information.
Passing options
Activates your content as a modal. Accepts an optional options object.
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).
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).
Also, you can pass a DOM element as an argument that can be received in the modal events (as the relatedTarget property).
Manually hides a modal. Returns to the caller before the modal has actually been
hidden (i.e. before the hidden.bs.modal event occurs).
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).
dispose
Destroys an element’s modal. (Removes stored data on the DOM element)
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
getOrCreateInstance
Static method which allows you to get the modal instance associated with a DOM element, or create a new one in case it wasn’t initialised
varmyModalEl=document.querySelector('#myModal')varmodal=bootstrap.Modal.getOrCreateInstance(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
).
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...
})