Modal

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

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. 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:
  1. $('#myModal').on('shown.bs.modal', function () {
  2.   $('#myInput').trigger('focus')
  3. })

The animation effect of this component is dependent on the prefers-reduced-motion media query. See the reduced motion section of our accessibility documentation.

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 - 图1

  1. <div class="modal" tabindex="-1">
  2.   <div class="modal-dialog">
  3.     <div class="modal-content">
  4.       <div class="modal-header">
  5.         <h5 class="modal-title">Modal title</h5>
  6.         <button type="button" class="close" data-dismiss="modal" aria-label="Close">
  7.           <span aria-hidden="true">&times;</span>
  8.         </button>
  9.       </div>
  10.       <div class="modal-body">
  11.         <p>Modal body text goes here.</p>
  12.       </div>
  13.       <div class="modal-footer">
  14.         <button type="button" class="btn btn-secondary" data-dismiss="modal">Close</button>
  15.         <button type="button" class="btn btn-primary">Save changes</button>
  16.       </div>
  17.     </div>
  18.   </div>
  19. </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.

Modal title

Woohoo, you’re reading this text in a modal!

Modal - 图2

  1. <!-- Button trigger modal -->
  2. <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#exampleModal">
  3.   Launch demo modal
  4. </button>
  6. <!-- Modal -->
  7. <div class="modal fade" id="exampleModal" tabindex="-1" aria-labelledby="exampleModalLabel" aria-hidden="true">
  8.   <div class="modal-dialog">
  9.     <div class="modal-content">
  10.       <div class="modal-header">
  11.         <h5 class="modal-title" id="exampleModalLabel">Modal title</h5>
  12.         <button type="button" class="close" data-dismiss="modal" aria-label="Close">
  13.           <span aria-hidden="true">&times;</span>
  14.         </button>
  15.       </div>
  16.       <div class="modal-body">
  17.         ...
  18.       </div>
  19.       <div class="modal-footer">
  20.         <button type="button" class="btn btn-secondary" data-dismiss="modal">Close</button>
  21.         <button type="button" class="btn btn-primary">Save changes</button>
  22.       </div>
  23.     </div>
  24.   </div>
  25. </div>

Static backdrop

When backdrop is set to static, the modal will not close when clicking outside it. Click the button below to try it.

Modal title

I will not close if you click outside me. Don’t even try to press escape key.

Modal - 图3

  1. <!-- Button trigger modal -->
  2. <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#staticBackdrop">
  3.   Launch static backdrop modal
  4. </button>
  6. <!-- Modal -->
  7. <div class="modal fade" id="staticBackdrop" data-backdrop="static" data-keyboard="false" tabindex="-1" aria-labelledby="staticBackdropLabel" aria-hidden="true">
  8.   <div class="modal-dialog">
  9.     <div class="modal-content">
  10.       <div class="modal-header">
  11.         <h5 class="modal-title" id="staticBackdropLabel">Modal title</h5>
  12.         <button type="button" class="close" data-dismiss="modal" aria-label="Close">
  13.           <span aria-hidden="true">&times;</span>
  14.         </button>
  15.       </div>
  16.       <div class="modal-body">
  17.         ...
  18.       </div>
  19.       <div class="modal-footer">
  20.         <button type="button" class="btn btn-secondary" data-dismiss="modal">Close</button>
  21.         <button type="button" class="btn btn-primary">Understood</button>
  22.       </div>
  23.     </div>
  24.   </div>
  25. </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.

Modal title

What follows is just some placeholder text for this modal dialog. Sipping on Rosé, Silver Lake sun, coming up all lazy. It’s in the palm of your hand now baby. So we hit the boulevard. So make a wish, I’ll make it like your birthday everyday. Do you ever feel already buried deep six feet under? It’s time to bring out the big balloons. You could’ve been the greatest. Passport stamps, she’s cosmopolitan. Your kiss is cosmic, every move is magic.

We’re living the life. We’re doing it right. Open up your heart. I was tryna hit it and quit it. Her love is like a drug. Always leaves a trail of stardust. The girl’s a freak, she drive a jeep in Laguna Beach. Fine, fresh, fierce, we got it on lock. All my girls vintage Chanel baby.

Before you met me I was alright but things were kinda heavy. Peach-pink lips, yeah, everybody stares. This is no big deal. Calling out my name. I could have rewrite your addiction. She’s got that, je ne sais quoi, you know it. Heavy is the head that wears the crown. ‘Cause, baby, you’re a firework. Like thunder gonna shake the ground.

Just own the night like the 4th of July! I’m gon’ put her in a coma. What you’re waiting for, it’s time for you to show it off. Can’t replace you with a million rings. You open my eyes and I’m ready to go, lead me into the light. And here you are. I’m gon’ put her in a coma. Come on, let your colours burst. So cover your eyes, I have a surprise. As I march alone to a different beat. Glitter all over the room pink flamingos in the pool.

You just gotta ignite the light and let it shine! Come just as you are to me. Just own the night like the 4th of July. Infect me with your love and fill me with your poison. Come just as you are to me. End of the rainbow looking treasure.

I can’t sleep let’s run away and don’t ever look back, don’t ever look back. I can’t sleep let’s run away and don’t ever look back, don’t ever look back. Yes, we make angels cry, raining down on earth from up above. I’m walking on air (tonight). Let you put your hands on me in my skin-tight jeans. Stinging like a bee I earned my stripes. I went from zero, to my own hero. Even brighter than the moon, moon, moon. Make ‘em go, ‘Aah, aah, aah’ as you shoot across the sky-y-y! Why don’t you let me stop by?

Boom, boom, boom. Never made me blink one time. Yeah, you’re lucky if you’re on her plane. Talk about our future like we had a clue. Oh my God no exaggeration. You’re original, cannot be replaced. The girl’s a freak, she drive a jeep in Laguna Beach. It’s no big deal, it’s no big deal, it’s no big deal. In another life I would make you stay. I’m ma get your heart racing in my skin-tight jeans. I wanna walk on your wave length and be there when you vibrate Never made me blink one time.

We’d keep all our promises be us against the world. If you get the chance you better keep her. It’s time to bring out the big, big, big, big, big, big balloons. I hope you got a healthy appetite. Don’t let the greatness get you down, oh, oh yeah. Yeah, she’s footloose and so fancy free. I want the jaw droppin’, eye poppin’, head turnin’, body shockin’. End of the rainbow looking treasure.

Modal - 图4

You can also create a scrollable modal that allows scroll the modal body by adding .modal-dialog-scrollable to .modal-dialog.

Modal title

What follows is just some placeholder text for this modal dialog. You just gotta ignite the light and let it shine! Come just as you are to me. Just own the night like the 4th of July. Infect me with your love and fill me with your poison. Come just as you are to me. End of the rainbow looking treasure.

I can’t sleep let’s run away and don’t ever look back, don’t ever look back. I can’t sleep let’s run away and don’t ever look back, don’t ever look back. Yes, we make angels cry, raining down on earth from up above. I’m walking on air (tonight). Let you put your hands on me in my skin-tight jeans. Stinging like a bee I earned my stripes. I went from zero, to my own hero. Even brighter than the moon, moon, moon. Make ‘em go, ‘Aah, aah, aah’ as you shoot across the sky-y-y! Why don’t you let me stop by?

Boom, boom, boom. Never made me blink one time. Yeah, you’re lucky if you’re on her plane. Talk about our future like we had a clue. Oh my God no exaggeration. You’re original, cannot be replaced. The girl’s a freak, she drive a jeep in Laguna Beach. It’s no big deal, it’s no big deal, it’s no big deal. In another life I would make you stay. I’m ma get your heart racing in my skin-tight jeans. I wanna walk on your wave length and be there when you vibrate Never made me blink one time.

We’d keep all our promises be us against the world. In another life I would be your girl. We can dance, until we die, you and I, will be young forever. And on my 18th Birthday we got matching tattoos. So open up your heart and just let it begin. ‘Cause she’s the muse and the artist. She eats your heart out. Like Jeffrey Dahmer (woo). Pop your confetti. (This is how we do) I know one spark will shock the world, yeah yeah. If you only knew what the future holds.

Sipping on Rosé, Silver Lake sun, coming up all lazy. It’s in the palm of your hand now baby. So we hit the boulevard. So make a wish, I’ll make it like your birthday everyday. Do you ever feel already buried deep six feet under? It’s time to bring out the big balloons. You could’ve been the greatest. Passport stamps, she’s cosmopolitan. Your kiss is cosmic, every move is magic.

We’re living the life. We’re doing it right. Open up your heart. I was tryna hit it and quit it. Her love is like a drug. Always leaves a trail of stardust. The girl’s a freak, she drive a jeep in Laguna Beach. Fine, fresh, fierce, we got it on lock. All my girls vintage Chanel baby.

Before you met me I was alright but things were kinda heavy. Peach-pink lips, yeah, everybody stares. This is no big deal. Calling out my name. I could have rewrite your addiction. She’s got that, je ne sais quoi, you know it. Heavy is the head that wears the crown. ‘Cause, baby, you’re a firework. Like thunder gonna shake the ground.

Just own the night like the 4th of July! I’m gon’ put her in a coma. What you’re waiting for, it’s time for you to show it off. Can’t replace you with a million rings. You open my eyes and I’m ready to go, lead me into the light. And here you are. I’m gon’ put her in a coma. Come on, let your colours burst. So cover your eyes, I have a surprise. As I march alone to a different beat. Glitter all over the room pink flamingos in the pool.

Modal - 图5

  1. <!-- Scrollable modal -->
  2. <div class="modal-dialog modal-dialog-scrollable">
  3.   ...
  4. </div>

Vertically centered

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

Modal title

Placeholder text for this demonstration of a vertically centered modal dialog.

Modal title

Placeholder text for this demonstration of a vertically centered modal dialog.

In this case, the dialog has a bit more content, just to show how vertical centering can be added to a scrollable modal.

What follows is just some placeholder text for this modal dialog. Sipping on Rosé, Silver Lake sun, coming up all lazy. It’s in the palm of your hand now baby. So we hit the boulevard. So make a wish, I’ll make it like your birthday everyday. Do you ever feel already buried deep six feet under? It’s time to bring out the big balloons. You could’ve been the greatest. Passport stamps, she’s cosmopolitan. Your kiss is cosmic, every move is magic.

We’re living the life. We’re doing it right. Open up your heart. I was tryna hit it and quit it. Her love is like a drug. Always leaves a trail of stardust. The girl’s a freak, she drive a jeep in Laguna Beach. Fine, fresh, fierce, we got it on lock. All my girls vintage Chanel baby.

Modal - 图6

  1. <!-- Vertically centered modal -->
  2. <div class="modal-dialog modal-dialog-centered">
  3.   ...
  4. </div>
  6. <!-- Vertically centered scrollable modal -->
  7. <div class="modal-dialog modal-dialog-centered modal-dialog-scrollable">
  8.   ...
  9. </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.

Modal title
Popover in a modal

This button triggers a popover on click.

Tooltips in a modal

This link and that link have tooltips on hover.

Modal - 图7

  1. <div class="modal-body">
  2.   <h5>Popover in a modal</h5>
  3.   <p>This <a href="#" role="button" class="btn btn-secondary popover-test" title="Popover title" data-content="Popover body content is set in this attribute.">button</a> triggers a popover on click.</p>
  4.   <hr>
  5.   <h5>Tooltips in a modal</h5>
  6.   <p><a href="#" class="tooltip-test" title="Tooltip">This link</a> and <a href="#" class="tooltip-test" title="Tooltip">that link</a> have tooltips on hover.</p>
  7. </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.

Grids in modals

.col-md-4

.col-md-4 .ml-auto

.col-md-3 .ml-auto

.col-md-2 .ml-auto

.col-md-6 .ml-auto

Level 1: .col-sm-9

Level 2: .col-8 .col-sm-6

Level 2: .col-4 .col-sm-6

Modal - 图8

  1. <div class="modal-body">
  2.   <div class="container-fluid">
  3.     <div class="row">
  4.       <div class="col-md-4">.col-md-4</div>
  5.       <div class="col-md-4 ml-auto">.col-md-4 .ml-auto</div>
  6.     </div>
  7.     <div class="row">
  8.       <div class="col-md-3 ml-auto">.col-md-3 .ml-auto</div>
  9.       <div class="col-md-2 ml-auto">.col-md-2 .ml-auto</div>
  10.     </div>
  11.     <div class="row">
  12.       <div class="col-md-6 ml-auto">.col-md-6 .ml-auto</div>
  13.     </div>
  14.     <div class="row">
  15.       <div class="col-sm-9">
  16.         Level 1: .col-sm-9
  17.         <div class="row">
  18.           <div class="col-8 col-sm-6">
  19.             Level 2: .col-8 .col-sm-6
  20.           </div>
  21.           <div class="col-4 col-sm-6">
  22.             Level 2: .col-4 .col-sm-6
  23.           </div>
  24.         </div>
  25.       </div>
  26.     </div>
  27.   </div>
  28. </div>

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 (possibly via jQuery) 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.

Modal - 图9

  1. <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#exampleModal" data-whatever="@mdo">Open modal for @mdo</button>
  2. <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#exampleModal" data-whatever="@fat">Open modal for @fat</button>
  3. <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#exampleModal" data-whatever="@getbootstrap">Open modal for @getbootstrap</button>
  5. <div class="modal fade" id="exampleModal" tabindex="-1" aria-labelledby="exampleModalLabel" aria-hidden="true">
  6.   <div class="modal-dialog">
  7.     <div class="modal-content">
  8.       <div class="modal-header">
  9.         <h5 class="modal-title" id="exampleModalLabel">New message</h5>
  10.         <button type="button" class="close" data-dismiss="modal" aria-label="Close">
  11.           <span aria-hidden="true">&times;</span>
  12.         </button>
  13.       </div>
  14.       <div class="modal-body">
  15.         <form>
  16.           <div class="form-group">
  17.             <label for="recipient-name" class="col-form-label">Recipient:</label>
  18.             <input type="text" class="form-control" id="recipient-name">
  19.           </div>
  20.           <div class="form-group">
  21.             <label for="message-text" class="col-form-label">Message:</label>
  22.             <textarea class="form-control" id="message-text"></textarea>
  23.           </div>
  24.         </form>
  25.       </div>
  26.       <div class="modal-footer">
  27.         <button type="button" class="btn btn-secondary" data-dismiss="modal">Close</button>
  28.         <button type="button" class="btn btn-primary">Send message</button>
  29.       </div>
  30.     </div>
  31.   </div>
  32. </div>
  1. $('#exampleModal').on('show.bs.modal', function (event) {
  2.   var button = $(event.relatedTarget) // Button that triggered the modal
  3.   var recipient = button.data('whatever') // Extract info from data-* attributes
  4.   // If necessary, you could initiate an AJAX request here (and then do the updating in a callback).
  5.   // Update the modal's content. We'll use jQuery here, but you could use a data binding library or other methods instead.
  6.   var modal = $(this)
  7.   modal.find('.modal-title').text('New message to ' + recipient)
  8.   modal.find('.modal-body input').val(recipient)
  9. })

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.

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

Dynamic heights

If the height of a modal changes while it is open, you should call $('#myModal').modal('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.

SizeClassModal max-width
Small.modal-sm300px
DefaultNone500px
Large.modal-lg800px
Extra large.modal-xl1140px

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

Modal - 图10

  1. <div class="modal-dialog modal-xl">...</div>
  2. <div class="modal-dialog modal-lg">...</div>
  3. <div class="modal-dialog modal-sm">...</div>
Extra large modal

…

Large modal

…

Small modal

…

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.

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

Via JavaScript

Call a modal with id myModal with a single line of JavaScript:

  1. $('#myModal').modal(options)

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-backdrop="".

NameTypeDefaultDescription
backdropboolean or the string ‘static’trueIncludes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn’t close the modal on click.
keyboardbooleantrueCloses the modal when escape key is pressed
focusbooleantruePuts the focus on the modal when initialized.
showbooleantrueShows 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.

.modal(options)

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

  1. $('#myModal').modal({
  2.   keyboard: false
  3. })

.modal('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).

  1. $('#myModal').modal('toggle')

.modal('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).

  1. $('#myModal').modal('show')

.modal('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).

  1. $('#myModal').modal('hide')

.modal('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).

  1. $('#myModal').modal('handleUpdate')

.modal('dispose')

Destroys an element’s modal.

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 TypeDescription
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.
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 the modal or an escape key press is performed with the keyboard option or data-keyboard set to false.
  1. $('#myModal').on('hidden.bs.modal', function (event) {
  2.   // do something...
  3. })