Create modal dialogs with different styles and transitions.

\n\n

Usage

The modal component consists of an overlay, a dialog and a close button.

\n\n

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Class	Description
`.uk-modal`	Add this class to a `<div>` element to create the dialog container and an overlay that blanks out the page. It is important to add an id to indicate the element for toggling.
`.uk-modal-dialog`	Add this class to a child `<div>` element to create the dialog box.
`.uk-modal-close`	Add this class to an `<a>` or `<button>` element to create a close button within the dialog box. We recommend adding the `.uk-close` class from the Close component to give the button a proper styling, though you can also use text or an image.

\n\n

You can use any element to toggle a modal dialog. An <a> element needs to be linked to the modal’s id. To enable the necessary JavaScript, add the data-uk-modal attribute. If you are using another element, like a button, just add the data-uk-modal="{target:'#ID'}" attribute to target the modal’s id.

\n\n

Example

\n\n \n Open\n \n\n

Markup

\n\n

<!-- This is an anchor toggling the modal -->\n<a href="#my-id" data-uk-modal>...</a>\n\n<!-- This is a button toggling the modal -->\n<button class="uk-button" data-uk-modal="{target:'#my-id'}">...</button>\n\n<!-- This is the modal -->\n<div id="my-id" class="uk-modal">\n    <div class="uk-modal-dialog">\n        <a class="uk-modal-close uk-close"></a>\n        ...\n    </div>\n</div>

\n\n

JavaScript options

\n\n

By default, the modal closes automatically when clicking on the modal overlay. To prevent this from happening, just add the data-uk-modal="{target:'#ID',bgclose:false}" attribute.

\n\n

\n\n \n\n

You can create a header and footer for your modal, which are seperated from the content. Just add the .uk-modal-header or the .uk-modal-footer class to a <div> element inside the modal dialog.

\n\n

Example

\n\n \n \n\n

Markup

\n\n

<div class="uk-modal">\n    <div class="uk-modal-dialog">\n        <div class="uk-modal-header">...</div>\n        ...\n        <div class="uk-modal-footer">...</div>\n    </div>\n</div>

\n\n

\n\n \n\n

You can also create a caption that will be placed outside the modal. Just add the .uk-modal-caption class to a <div> element inside the modal dialog.

\n\n

Example

\n\n \n \n\n

Markup

\n\n

<div class="uk-modal">\n    <div class="uk-modal-dialog">\n        <div class="uk-modal-caption">...</div>\n    </div>\n</div>

\n\n

\n\n \n\n

To place a spinning icon inside your modal, add the .uk-modal-spinner class to a <div> element inside the modal dialog.

\n\n

Example

\n\n Open\n \n\n

Markup

\n\n

<div class="uk-modal">\n    <div class="uk-modal-dialog">\n        <div class="uk-modal-spinner">...</div>\n    </div>\n</div>

\n\n

\n\n \n\n

To create a lightbox-like modal dialog, just add the .uk-modal-dialog-lightbox class. This can be useful, if you want to use the modal as a lightbox for your images. The close button will adjust its position automatically to the dialog.

\n\n

Example

\n\n \n \n\n

Markup

\n\n

<!-- This is the anchor toggling the modal -->\n<a href="#my-id" data-uk-modal>...</a>\n\n<!-- This is the modal -->\n<div id="my-id" class="uk-modal">\n    <div class="uk-modal-dialog uk-modal-dialog-lightbox">\n        <a href="" class="uk-modal-close uk-close uk-close-alt"></a>\n        <img src="" alt="">\n    </div>\n</div>

\n\n

NOTE When creating a close button within the lightbox modifier, we also recommend adding the .uk-close-alt class from the Close component to the close button to give your button a styling that fits the lightbox modal.

\n\n

\n\n \n\n

To vertically center the modal, add the {center:true} option to the data-attribute.

\n\n

Example

\n\n Open\n\n

Markup

\n\n

<a href="#my-id" data-uk-modal="{center:true}"></a>

\n\n

Large dialog modifier

\n\n

To apply the site’s container width to the modal dialog, just add the .uk-modal-dialog-large class.

\n\n

Example

\n\n Open\n \n\n

Markup

\n\n

<div class="uk-modal-dialog uk-modal-dialog-large">...</div>

\n\n

\n\n \n\n

You can also display the modal’s content in a scrollable container. Just add the .uk-overflow-container class to a <div> element inside the modal dialog. The modal will automatically expand and fill the site’s height.

\n\n

Example

\n\n Open\n

\n \n

Headline

Some text above the scrollable box

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Overflow container

Some text below the overflow container

\n\n

Markup

\n\n

<div class="uk-modal-dialog">\n    <p>...</p>\n    <div class="uk-overflow-container">...</div>\n    <p>...</p>\n</div>

\n\n

JavaScript

\n\n

You can handle modal dialogs via raw javascript.

\n\n

Example

\n\n

var modal = UIkit.modal(".modalSelector");\n\nif ( modal.isActive() ) {\n    modal.hide();\n} else {\n    modal.show();\n}

\n\n

Events

\n\n

The modal component triggers an show.uk.modal event every time a modal is opened and hide.uk.modal when a modal is closed.

\n\n

Example

\n\n

$('.modalSelector').on({\n\n    'show.uk.modal': function(){\n        console.log("Modal is visible.");\n    },\n\n    'hide.uk.modal': function(){\n        console.log("Element is not visible.");\n    }\n});

\n\n

Events

\n\n

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Name	Parameter	Description
`show.uk.modal`	event	On modal show
`hide.uk.modal`	event	On modal hide