Bootstrap Modal v2.2.5
=============
See live demo [here](http://jschr.github.com/bootstrap-modal/).
Extends Bootstrap's native modals to provide additional functionality. Introduces a **ModalManager** class that operates behind the scenes to handle multiple modals by listening on their events.
A single ModalManager is created by default on body and can be accessed through the jQuery plugin interface.
$('body').modalmanager('loading');
Bootstrap-Modal can be used as a replacement for Bootstrap's Modal class or as a patch to the library.
Bootstrap 3
-----------
If you're using BS3, I've provided a compatible css patch. Include `bootstrap-modal-bs3patch.css` **before** the main `bootstrap-modal.css` file to use this plugin with Bootstrap 3.
If you're using the loading spinner functionality you may also need to change the default template to be compatible in js:
$.fn.modal.defaults.spinner = $.fn.modalmanager.defaults.spinner =
'
' +
'
' +
'' +
'
' +
'
';
**Note**: Since this plugin was created to solve a lot of the issues with BS2, it still uses the BS2 markup syntax. Currently I believe the default BS3 modal addresses some of the bigger issues and is not worth maintaining two versions of this plugin.
Overview
-----------
+ Backwards compatible
+ Responsive
+ Stackable
+ Full width
+ Load content via AJAX
+ Disable background scrolling
Installation
-----------
+ Include `css/bootstrap-modal.css` after the main bootstrap css files.
+ Include `js/bootstrap-modalmanager.js` and `js/bootstrap-modal.js` after the main bootstrap js files.
Options
-----------
In addition to the standard bootstrap options, you now have access to the following options
**Modal**
+ **width**
Set the inital width of the modal.
+ **height**
Set the inital height of the modal.
+ **maxHeight**
Set the max-height of the modal-body.
+ **loading**
Toggle the loading state.
+ **spinner**
Provide a custom image or animation for the loading spinner.
+ **backdropTemplate**
Provide a custom modal backdrop.
+ **consumeTab**
Used to enable tabindexing for modals with `data-tabindex`. This is set to true by default.
+ **focusOn**
The element or selector to set the focus to once the modal is shown.
+ **replace**
If set to true, the modal will replace the topmost modal when opened.
+ **attentionAnimation**
Set the animation used by the `attention` method. Any animation in [animate.css](http://daneden.me/animate/) is supported but only the *shake* animation is included by default.
+ **modalOverflow**
Set this property to true for modals with highly dynamic content. This will force the modal to behave as if it is larger than the viewport.
+ **manager**
Set the modal's manager. By default this is set to the `GlobalModalManager` and will most likely not need to be overridden.
**ModalManager**
+ **loading**
Toggle the loading state.
+ **backdropLimit**
Limit the amount of backdrops that will appear on the page at the same time.
+ **spinner**
Provide a custom image or animation for the loading spinner.
+ **backdropTemplate**
Provide a custom modalmanager backdrop. This backdrop is used when `$element.modalmanager('loading')` is called.
Disable Background Scrolling
-----------
If you want to prevent the background page from scrolling (see [demo](http://jschr.github.com/bootstrap-modal/) for example) you must wrap the page contents in a `
`. For example:
...
...
The reason for doing this instead of just simply setting `overflow: hidden` when a modal is open is to avoid having the page shift as a result of the scrollbar appearing/disappearing. This also allows the document to be scrollable when there is a tall modal but only to the height of the modal, not the entire page.
Constrain Modal to Window Size
-----------
You can bind the the height of the modal body to the window with something like this:
$.fn.modal.defaults.maxHeight = function(){
// subtract the height of the modal header and footer
return $(window).height() - 165;
}
**Note:** This will be overwritten by the responsiveness and is only set when the modal is displayed, not when the window is resized.
Tab Index for Modal Forms
-----------
You can use `data-tabindex` instead of the default `tabindex` to specify the tabindex within a modal.
See the stackable example on the [demo](http://jschr.github.com/bootstrap-modal/) page for an example.
[](https://bitdeli.com/free "Bitdeli Badge")