How it works
Before getting started with Melodic’s modal component, be sure to read the following about how our modals work.
<body>so that modal content scrolls instead.
- Clicking on the modal “backdrop” will automatically close the modal.
- Melodic 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
Keep reading for demos and usage guidelines.
Below is a static modal example (meaning its
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.
Toggle a working modal demo by clicking the button below. It will slide down and fade in from the top of the page.
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-dialog to vertically center the modal.
Tooltips and popovers
Using the grid
Utilize the Melodic 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.
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.
<button type="button" class="btn btn-primary" data-toggle="modal" data-target="#exampleModal" data-whatever="@mdo">Open modal for @mdo</button> <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#exampleModal" data-whatever="@fat">Open modal for @fat</button> <button type="button" class="btn btn-primary" data-toggle="modal" data-target="#exampleModal" data-whatever="@helloinspire">Open modal for @helloinspire</button> <div class="modal fade" id="exampleModal" tabindex="-1" role="dialog" aria-labelledby="exampleModalLabel" aria-hidden="true"> <div class="modal-dialog" role="document"> <div class="modal-content"> <div class="modal-header"> <h5 class="modal-title" id="exampleModalLabel">New message</h5> <button type="button" class="close" data-dismiss="modal" aria-label="Close"> <span aria-hidden="true">×</span> </button> </div> <div class="modal-body"> <form> <div class="form-group"> <label for="recipient-name" class="col-form-label">Recipient:</label> <input type="text" class="form-control" id="recipient-name"> </div> <div class="form-group"> <label for="message-text" class="col-form-label">Message:</label> <textarea class="form-control" id="message-text"></textarea> </div> </form> </div> <div class="modal-footer"> <button type="button" class="btn btn-secondary" data-dismiss="modal">Close</button> <button type="button" class="btn btn-primary">Send message</button> </div> </div> </div> </div>
For modals that simply appear rather than fade in to view, remove the
.fade class from your modal markup.
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.
Be sure to add
aria-labelledby="...", referencing the modal title, to
role="document" to the
.modal-dialog itself. Additionally, you may give a description of your modal dialog with
Embedding YouTube videos
Modals have two 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.
.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
data-toggle="modal" on a controller element, like a button, along with a
href="#foo" to target a specific modal to toggle.
Call a modal with id
data-, as in
|backdrop||boolean or the string
||true||Includes a modal-backdrop element. Alternatively, specify
|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.|
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.
Activates your content as a modal. Accepts an optional options
Manually toggles a modal. Returns to the caller before the modal has actually been shown or hidden (i.e. before the
hidden.mel.modal event occurs).
Manually opens a modal. Returns to the caller before the modal has actually been shown (i.e. before the
shown.mel.modal event occurs).
Manually hides a modal. Returns to the caller before the modal has actually been hidden (i.e. before the
hidden.mel.modal event occurs).
Manually readjust the modal’s position if the height of a modal changes while it is open (i.e. in case a scrollbar appears).
Destroys an element’s modal.
Melodic’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
|show.mel.modal||This event fires immediately when the
|shown.mel.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
|hide.mel.modal||This event is fired immediately when the
|hidden.mel.modal||This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).|