Modal Components
Live Demo
Scrolling Long Content
Tooltips and Popovers
Using the Grid
Varying Modal Content
Remove animation
For modals that simply appear rather than fade in to view, remove the .fade class from your modal markup.
<div class="modal" tabindex="-1" role="dialog" aria-labelledby="..." aria-hidden="true">
...
</div>Dynamic heights
If the height of a modal changes while it is open, you should call $('#myModal').data('bs.modal').handleUpdate() or $('#myModal').modal('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
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:
$('#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 returns 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.
.modal(options)
Activates your content as a modal. Accepts an optional options object.
$('#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).
$('#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).
$('#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).
$('#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).
$('#myModal').modal('handleUpdate')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). |
$('#myModal').on('hidden.bs.modal', function (e) {
// do something...
})