The modal widget allows you to add dialog style windows to your site or application.
- Important Notes
- Modals get positioned over everything else in the document and remove scroll from the
<body>so that modal content scrolls instead.
- By default, clicking on the modal “backdrop” will automatically close the modal.
- Figuration only supports one modal at a time. Nested modals are not supported, as this can cause difficult usability and accessibility issues.
- Modals use
position: fixed. Always try to place modal HTML code in a top-level position in your document, such as a direct chld of the
<body>element. Putting modal HTML within a fixed position element will adversely affect placement.
- There are some caveats regarding using modals on mobile devices. See our browser support docs for details.
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). It is highly suggested to include modal headers with dismiss actions whenever possible, or provide another explicit dismiss action.
<div class="modal"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-cfw-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button> <h4 class="modal-title">Modal title</h4> </div> <div class="modal-body"> <p>Modal body content…</p> </div> <div class="modal-footer"> <button type="button" class="btn" data-cfw-dismiss="modal">Close</button> <button type="button" class="btn btn-primary">Save changes</button> </div> </div> </div> </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 for an example.
.modal-dialog to vertically center the modal.
A vertically centered dialog will also scroll when the content is longer than the viewport.
To take advantage of the grid system within a modal, just nest
.container-fluid within the
.modal-body and then use the normal grid system classes within this container.
Tooltips and Popovers
Modals have two optional sizes, provided by Figuration’s base CSS, available via modifier classes to be placed on a
.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-cfw="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
Any an element with a data attribute of
data-cfw-dismiss="modal" within the modal element will act as a close trigger for the modal. There can be multiple close triggers, such as a header/titlebar close and a cancel button in the footer.
If the height of a modal changes while it is open, you will need to call
$('#myModal').CFW_Modal('handleUpdate'); to readjust the modal’s position and backdrop.
With Fixed Position Content
Since the scrollbar is removed from the
<body> when a modal is shown, there can be some shifting of content in fixed position elements. To help with this issue, when a modal is shown, any elements using the fixed positioning utility classes, (
.fixed-bottom), will have additional padding added to their right side. This padding width should match the width of the scrollbar that becomes hidden. When the modal is hidden, the
padding-right CSS value will be reset.
There is also an additional special classname that the modal widget will look for when adjusting padding values. Simply add the
.is-fixed class to your element, and it will automatically be handled.
data-cfw-modal-, as in
|target||string||null||The selector (jQuery style) of the target modal.|
|animate||boolean||true||If modal targets should fade and slide in.|
|unlink||boolean||false||If the `unlink` method should be called when the modal is hidden. This leaves the modal behind in the DOM.|
|dispose||boolean||false||If the `dispose` method should be called when the modal is hidden. This will remove the modal from the DOM.|
|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.
The backdrop is the semi-opaque overlay used to visually seperate the modal from the page content.
|keyboard||boolean||true||Closes the modal when escape key is pressed|
|show||boolean||false||Shows the modal when initialized.|
Activates a modal dialog. Accepts an optional options
Toggles a modal dialog to be shown or hidden.
Shows a modal dialog.
Hides a modal dialog.
Hides the modal, removes events and attributes from both trigger and modal.
unlink method, and then removes the modal from the DOM.
Event callbacks happen on the target
<div class="modal"> element.
|init.cfw.modal||This event fires after the modal item is initialized.|
|beforeShow.cfw.modal||This event is fired immediately when the
|scrollbarSet.cfw.modal||This event is fired immediately when the
|afterShow.cfw.modal||This event is fired when a modal dialog has been made visible to the user (will wait for CSS transitions to complete).|
|scrollbarReset.cfw.modal||This event is fired immediately when the
|beforeHide.cfw.modal||This event is fired immediately when the
|afterHide.cfw.modal||This event is fired when a modal dialog has been hidden from the user (will wait for CSS transitions to complete).|
|beforeUnlink.cfw.modal||This event is fired immediately when the
|afterUnlink.cfw.modal||This event is fired when a modal item has been unlinked from its trigger item and the data-api removed. This event can occur after the
|dispose.cfw.modal||This event is fired immediately before the modal item is removed from the DOM.|
Modals are designed to hopefully work with server side applications, such as Apache Wicket, and other instances where the server-side application might need to create or update the modal content after the initial page load.
A quick example:
- An item with an event handler that makes a callback to create a new modal is interacted with.
Call as needed:
- Update/create the modal object and insert into DOM.
- Initialize the modal:
$('#myModal').CFW_Modal(options);with desired options.
- Show modal:
The following key commands are handled when focus is inside the modal:
- Esc - Close the modal
In order to keep assistive technology users from interacting with the rest of the page when a modal is open, the focus is automatically forced back to the modal when a user tries to navigate out.
When navigating forward, out the bottom of the modal, focus will be moved to the top of the modal.
When navigation backward, out the top of the modal, focus will be moved back to the top of the modal.
If for some reason you need to disable the enforced focus for modals, you can override the
However, we do not advise disabling it completely, but overriding the function to handle the focus conditionally.