Bootstrap 5 Modal
Modal
Bootstrap Modals offer a lightweight, multi-purpose JavaScript popup to add dialogs to yours. Learn how to customize Bootstrap Modals easily. Multiple examples and tutorial.
🤖 Looking for the LLM-optimized version?View llm.md
Other frameworks
CoreUI components are available as native Angular, React, and Vue components. To learn more please visit the following pages.
How it works
Bootstrap modals are lightweight and multi-purpose popups. Modals are split into three primary sections: header, body, and footer. Each has its role and so should be used accordingly. Before getting started with CoreUI for 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.modalwithin 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
autofocusHTML attribute has no effect in Bootstrap modals. To achieve the same effect, use some custom #"0">constmyModal=document.getElementById('myModal')constmyInput=document.getElementById('myInput')myModal.addEventListener('shown.coreui.modal',()=>{myInput.focus()})
prefers-reduced-motion media query. For more information, refer to thereduced motion section of our accessibility documentation.Keep reading for demos and usage guidelines.
Examples
Modal components
Below is astatic modal example (meaning itsposition anddisplay have been overridden). Included are the modal header, modal body (required forpadding), 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.
<divclass="modal"tabindex="-1"><divclass="modal-dialog"><divclass="modal-content"><divclass="modal-header"><h5class="modal-title">Modal title</h5><buttontype="button"class="btn-close"data-coreui-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-coreui-dismiss="modal">Close</button><buttontype="button"class="btn btn-primary">Save changes</button></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.
<!-- Button trigger modal --><buttontype="button"class="btn btn-primary"data-coreui-toggle="modal"data-coreui-target="#exampleModal"> Launch demo modal</button><!-- Modal --><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">Modal title</h5><buttontype="button"class="btn-close"data-coreui-dismiss="modal"aria-label="Close"></button></div><divclass="modal-body"> ...</div><divclass="modal-footer"><buttontype="button"class="btn btn-secondary"data-coreui-dismiss="modal">Close</button><buttontype="button"class="btn btn-primary">Save changes</button></div></div></div></div>Static backdrop
When backdrop is set to static, the modal will not close when clicking outside of it. Click the button below to try it.
<!-- Button trigger modal --><buttontype="button"class="btn btn-primary"data-coreui-toggle="modal"data-coreui-target="#staticBackdrop"> Launch static backdrop modal</button><!-- Modal --><divclass="modal fade"id="staticBackdrop"data-coreui-backdrop="static"data-coreui-keyboard="false"tabindex="-1"aria-labelledby="staticBackdropLabel"aria-hidden="true"><divclass="modal-dialog"><divclass="modal-content"><divclass="modal-header"><h5class="modal-title"id="staticBackdropLabel">Modal title</h5><buttontype="button"class="btn-close"data-coreui-dismiss="modal"aria-label="Close"></button></div><divclass="modal-body"> ...</div><divclass="modal-footer"><buttontype="button"class="btn btn-secondary"data-coreui-dismiss="modal">Close</button><buttontype="button"class="btn btn-primary">Understood</button></div></div></div></div>Scrolling long content
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.
You can also create a scrollable modal that allows scroll the modal body by adding.modal-dialog-scrollable to.modal-dialog.
<!-- Scrollable modal --><divclass="modal-dialog modal-dialog-scrollable"> ...</div>Vertically centered
Add.modal-dialog-centered to.modal-dialog to vertically center the modal.
<!-- Vertically centered modal --><divclass="modal-dialog modal-dialog-centered"> ...</div><!-- Vertically centered scrollable modal --><divclass="modal-dialog modal-dialog-centered modal-dialog-scrollable"> ...</div>Tooltips and popovers
Tooltips andpopovers 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<buttonclass="btn btn-secondary"data-coreui-toggle="popover"title="Popover title"data-coreui-content="Popover body content is set in this attribute.">button</button> triggers a popover on click.</p><hr><h5>Tooltips in a modal</h5><p><ahref="#"data-coreui-toggle="tooltip"title="Tooltip">This link</a> and<ahref="#"data-coreui-toggle="tooltip"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.
<divclass="modal-body"><divclass="container-fluid"><divclass="row"><divclass="col-md-4">.col-md-4</div><divclass="col-md-4 ms-auto">.col-md-4 .ms-auto</div></div><divclass="row"><divclass="col-md-3 ms-auto">.col-md-3 .ms-auto</div><divclass="col-md-2 ms-auto">.col-md-2 .ms-auto</div></div><divclass="row"><divclass="col-md-6 ms-auto">.col-md-6 .ms-auto</div></div><divclass="row"><divclass="col-sm-9"> Level 1: .col-sm-9<divclass="row"><divclass="col-8 col-sm-6"> Level 2: .col-8 .col-sm-6</div><divclass="col-4 col-sm-6"> Level 2: .col-4 .col-sm-6</div></div></div></div></div></div>Varying modal content
Have a bunch of buttons that all trigger the same modal with slightly different contents? Useevent.relatedTarget andHTMLdata-coreui-* 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 onrelatedTarget.
<buttontype="button"class="btn btn-primary"data-coreui-toggle="modal"data-coreui-target="#exampleModal"data-coreui-whatever="@mdo">Open modal for @mdo</button><buttontype="button"class="btn btn-primary"data-coreui-toggle="modal"data-coreui-target="#exampleModal"data-coreui-whatever="@fat">Open modal for @fat</button><buttontype="button"class="btn btn-primary"data-coreui-toggle="modal"data-coreui-target="#exampleModal"data-coreui-whatever="@getbootstrap">Open modal for @getbootstrap</button><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 message</h5><buttontype="button"class="btn-close"data-coreui-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-coreui-dismiss="modal">Close</button><buttontype="button"class="btn btn-primary">Send message</button></div></div></div></div>constexampleModal=document.getElementById('exampleModal')if(exampleModal){exampleModal.addEventListener('show.coreui.modal',event=>{// Button that triggered the modalconstbutton=event.relatedTarget// Extract info from data-coreui-* attributesconstrecipient=button.getAttribute('data-coreui-whatever')// If necessary, you could initiate an Ajax request here// and then do the updating in a callback.// Update the modal's content.constmodalTitle=exampleModal.querySelector('.modal-title')constmodalBodyInput=exampleModal.querySelector('.modal-body input')modalTitle.textContent=`New message to${recipient}`modalBodyInput.value=recipient})}Toggle between modals
Toggle between multiple modals with some clever placement of thedata-coreui-target anddata-coreui-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 1</h5><buttontype="button"class="btn-close"data-coreui-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-coreui-target="#exampleModalToggle2"data-coreui-toggle="modal">Open second modal</button></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 2</h5><buttontype="button"class="btn-close"data-coreui-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-coreui-target="#exampleModalToggle"data-coreui-toggle="modal">Back to first</button></div></div></div></div><buttonclass="btn btn-primary"data-coreui-target="#exampleModalToggle"data-coreui-toggle="modal">Open first modal</button>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.
<divclass="modal"tabindex="-1"aria-labelledby="..."aria-hidden="true"> ...</div>Dynamic heights
If the height of a modal changes while it is open, you should callmyModal.handleUpdate() to readjust the modal’s position in case a scrollbar appears.
Accessibility
Be sure to addaria-labelledby="...", referencing the modal title, to.modal. Additionally, you may give a description of your modal dialog witharia-describedby on.modal. Note that you don’t need to addrole="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.
<divclass="modal-dialog modal-xl">...</div><divclass="modal-dialog modal-lg">...</div><divclass="modal-dialog modal-sm">...</div>Fullscreen Modal
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.
| Class | Availability |
|---|---|
.modal-fullscreen | Always |
.modal-fullscreen-sm-down | 576px |
.modal-fullscreen-md-down | 768px |
.modal-fullscreen-lg-down | 992px |
.modal-fullscreen-xl-down | 1200px |
.modal-fullscreen-xxl-down | 1400px |
<!-- Full screen modal --><divclass="modal-dialog modal-fullscreen-sm-down"> ...</div>Usage
Heads up! In our documentation, all examples showstandard CoreUI implementation. If you are using aBootstrap-compatible version of CoreUI, remember to use the following changes:
- In the constructor, please usebootstrap instead ofcoreui. For example,
new bootstrap.Alert(...)instead ofnew coreui.Alert(...) - In events, please usebs instead ofcoreui, for example
close.bs.alertinstead ofclose.coreui.alert - In data attributes, please usebs instead ofcoreui. For example,
data-bs-toggle="..."instead ofdata-coreui-toggle="..."
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
Toggle
Activate a modal without writing JavaScript. Setdata-coreui-toggle="modal" on a controller element, like a button, along with adata-coreui-target="#foo" orhref="#foo" to target a specific modal to toggle.
<buttontype="button"data-coreui-toggle="modal"data-coreui-target="#myModal">Launch modal</button>Dismiss
Dismissal can be achieved with thedata attribute on a buttonwithin the modal as demonstrated below:
<buttontype="button"class="btn-close"data-coreui-dismiss="modal"aria-label="Close"></button>or on a buttonoutside the modal using thedata-coreui-target as demonstrated below:
<buttontype="button"class="btn-close"data-coreui-dismiss="modal"data-coreui-target="#my-modal"aria-label="Close"></button>Via JavaScript
Create a modal with a single line of #"0">constmyModal=newcoreui.Modal(document.getElementById('myModal'),options)// orconstmyModalAlternative=newcoreui.Modal('#myModal',options)