41 KiB
| layout | title | description | group | toc |
|---|---|---|---|---|
| docs | Modal | Use Bootstrap's JavaScript modal plugin to add dialogs to your site for lightboxes, user notifications, or completely custom content. | components | true |
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.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]({{< docsref "/getting-started/browsers-devices#modals-and-dropdowns-on-mobile" >}}) 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 JavaScript:
{{< highlight js >}} var myModal = document.getElementById('myModal') var myInput = document.getElementById('myInput')
myModal.addEventListener('shown.bs.modal', function () { myInput.focus() }) {{< /highlight >}}
{{< callout info >}} {{< partial "callout-info-prefersreducedmotion.md" >}} {{< /callout >}}
Keep reading for demos and usage guidelines.
Examples
Modal components
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.
{{< highlight html >}}
Modal title
Modal body text goes here.
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.
{{< highlight html >}}
Launch demo modal {{< /highlight >}}Static backdrop
When backdrop is set to static, the modal will not close when clicking outside it. Click the button below to try it.
{{< highlight html >}}
Launch static backdrop modal {{< /highlight >}}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.
{{< highlight html >}}
Launch demo modal {{< /highlight >}}You can also create a scrollable modal that allows scroll the modal body by adding .modal-dialog-scrollable to .modal-dialog.
{{< highlight html >}}
Launch demo modal {{< /highlight >}}Vertically centered
Add .modal-dialog-centered to .modal-dialog to vertically center the modal.
{{< highlight html >}}
Launch demo modal {{< /highlight >}}Tooltips and popovers
[Tooltips]({{< docsref "/components/tooltips" >}}) and [popovers]({{< docsref "/components/popovers" >}}) can be placed within modals as needed. When modals are closed, any tooltips and popovers within are also automatically dismissed.
{{< highlight html >}}
{{< /highlight >}}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.
{{< highlight html >}}
Varying modal content
Have a bunch of buttons that all trigger the same modal with slightly different contents? Use event.relatedTarget and HTML data-* 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.
{{< example >}} Open modal for @mdo Open modal for @fat Open modal for @getbootstrap
{{< /example >}}{{< highlight js >}} var exampleModal = document.getElementById('exampleModal') exampleModal.addEventListener('show.bs.modal', function (event) { // Button that triggered the modal var button = event.relatedTarget // Extract info from data-* attributes var recipient = button.getAttribute('data-whatever') // If necessary, you could initiate an AJAX request here // and then do the updating in a callback. // // Update the modal's content. exampleModal.querySelector('.modal-title').textContent = 'New message to ' + recipient exampleModal.querySelector('.modal-body input').value = recipient }) {{< /highlight >}}
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.
{{< highlight html >}}
{{< /highlight >}}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.
Accessibility
Be sure to add role="dialog" and aria-labelledby="...", referencing the modal title, to .modal, and role="document" to the .modal-dialog itself. Additionally, you may give a description of your modal dialog with aria-describedby on .modal.
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.
{{< highlight html >}}
Extra large modal
Large modal
Small modal
{{< /highlight >}}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-toggle="modal" on a controller element, like a button, along with a data-target="#foo" or href="#foo" to target a specific modal to toggle.
{{< highlight html >}} Launch modal {{< /highlight >}}
Via JavaScript
Create a modal with a single line of JavaScript:
{{< highlight js >}} var myModal = new bootstrap.Modal(document.getElementById('myModal'), options) {{< /highlight >}}
Options
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-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 or on escape key press. |
| keyboard | boolean | true | Closes the modal when escape key is pressed |
| focus | boolean | true | Puts the focus on the modal when initialized. |
| show | boolean | true | Shows the modal when initialized. |
Methods
{{< callout danger >}} {{< partial "callout-danger-async-methods.md" >}} {{< /callout >}}
Passing options
Activates your content as a modal. Accepts an optional options object.
{{< highlight js >}} var myModal = new bootstrap.Modal(document.getElementById('myModal'), { keyboard: false }) {{< /highlight >}}
toggle
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).
{{< highlight js >}}myModal.toggle(){{< /highlight >}}
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).
{{< highlight js >}}myModal.show(){{< /highlight >}}
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).
{{< highlight js >}}myModal.hide(){{< /highlight >}}
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).
{{< highlight js >}}myModal.handleUpdate(){{< /highlight >}}
dispose
Destroys an element's modal.
{{< highlight js >}}myModal.dispose(){{< /highlight >}}
getInstance
Static method which allows you to get the modal instance associated with a DOM element
{{< highlight js >}} var myModalEl = document.getElementById('myModal') var modal = bootstrap.Modal.getInstance(myModalEl) // Returns a Bootstrap modal instance {{< /highlight >}}
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. |
{{< highlight js >}} var myModalEl = document.getElementById('myModal') myModalEl.addEventListener('hidden.bs.modal', function (e) { // do something... }) {{< /highlight >}}