Modal

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

Points to remember

Modals are positioned using position: fixed.
Clicking on the modal “backdrop” will automatically close the modal.
Bootstrap only supports one modal window at a time.

How to Use

$('#myModal').on('shown.bs.modal', function () {
  $('#myInput').trigger('focus')
})

Static Modal

Below is an example of static modal (position and display have been overridden). Modal contains the modal header, modal body (required for padding), and modal footer (optional). Modal header has dismiss button.

Modal triggered from button

In below example modal is triggered by clicking the button. It will slide down and fade in from the top of the page.

Scrolling long content

Modal which are too long for the user's viewport or device will scroll independent of the page.

Vertically centered

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

Tooltips and popovers in Modal

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

Using the grid

You can use the Bootstrap grid system within a modal by nesting .container-fluid within the .modal-body. Place any grid inside it.

Varying modal content

If you many buttons but use same modal with slightly different contents for each buttons that triggers? Use event.relatedTarget and HTML data-* attributes to vary the contents of the modal depending on button which was clicked.

$('#exampleModal').on('show.bs.modal', function (event) {
  var button = $(event.relatedTarget) // Button that triggered the modal
  var recipient = button.data('whatever') // Extract info from data-* attributes
  // If necessary, you could initiate an AJAX request here (and then do the updating in a callback).
  // Update the modal's content. We'll use jQuery here, but you could use a data binding library or other methods instead.
  var modal = $(this)
  modal.find('.modal-title').text('New message to ' + recipient)
  modal.find('.modal-body input').val(recipient)
})

Remove animation

If you dont need fade animation effect in your modal, remove the .fade class from your modal markup.

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

Dynamic heights

When the model is open and more contents are added to it dynamically scrollbar may appear. It that case you should call $('#myModal').modal('handleUpdate') to readjust the modal's position.

Note

Accessibility

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.

Modal sizes

Modals have two optional sizes large and small. Add modifier classes .modal-lg(large) .modal-sm(small) on a .modal-dialog.

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.

<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:

Copy

$('#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="".

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.
show	boolean	true	Shows 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.

Copy

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

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

Copy

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

Copy

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

Copy

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

Copy

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

Copy

$('#myModal').on('hidden.bs.modal', function (e) {
  // do something...
})