Alert widget
Overview
The Magento alert widget implements a modal pop-up window with a confirmation button. It extends the Magento modal widget.
The alert widget source is <Magento_Ui_module_dir>/view/base/web/js/modal/alert.js.
The widget can be used for implementing alert windows for both Admin and storefront. The design patterns for the pop-up modal windows in the Admin are described in the Magento Admin Pattern Library, the Slide-out Panels, Modal Windows, and Overlays topic.
Initialize the alert widget
The alert widget can be initialized with or without binding to a certain element.
Example1: initialization on an element
1
2
3
4
5
6
7
$('#init_element').alert({
title: $.mage.__('Warning'),
content: $.mage.__('Warning content'),
actions: {
always: function(){}
}
});
Example2: standalone initialization
1
2
3
4
5
6
7
8
9
10
11
12
13
require([
'Magento_Ui/js/modal/alert'
], function(alert) { // Variable that represents the `alert` function
alert({
title: $.mage.__('Some title'),
content: $.mage.__('Some content'),
actions: {
always: function(){}
}
});
});
For details about how to initialize a widget in a.phtml template, refer to the JavaScript initialization topic.
Options
The alert widget has the following options:
actions
Widget callbacks.
Type: Object.
Default value:
1
2
3
actions: {
always: function(){}
}
autoOpen
Automatically open the alert window when the widget is initialized.
Type: Boolean
Default value: false
clickableOverlay
Close the alert window when a user clicks on the overlay.
Type: Boolean
Default value: true
content
The text displayed in the alert window.
Type: String.
focus
The selector of the element to be in focus when the alert window opens.
If focus is not specified or set to empty string, the focus is on the close button. If focusing is not required, set focus to none.
Type: String.
Default value: ''
title
The title of the alert window.
Type: String.
Default value: ''
modalClass
The CSS class of the alert window.
Type: String.
Default value: 'confirm'
Events
The alert widget implements a single event: the always callback.
The always callback is invoked when a modal window is closed.
Keyboard navigation
The keyboard navigation for the alert windows is similar to the navigation of the modal widget.
Code Sample
Code sample of standalone initialization
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<div class="alert-modal-content">
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Adipisci amet aut consequuntur culpa cum, distinctio earum harum, iste magnam nobis numquam pariatur tempora ullam vero vitae. Hic ipsam itaque velit.</p>
</div>
<script>
require([
'jquery',
'Magento_Ui/js/modal/alert'
], function ($, alert) {
'use strict';
alert({
title: 'Alert Title',
content: $('.alert-modal-content'),
modalClass: 'alert',
actions: {
always: function() {
// do something when the modal is closed
}
}
});
});
</script>
Code sample of initialization on an element
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<div class="alert-modal-content">
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit. Adipisci amet aut consequuntur culpa cum, distinctio earum harum, iste magnam nobis numquam pariatur tempora ullam vero vitae. Hic ipsam itaque velit.</p>
</div>
<script>
require([
'jquery',
'Magento_Ui/js/modal/alert'
], function ($) {
'use strict';
$('.alert-modal-content').alert({
title: 'Alert Title',
modalClass: 'alert',
actions: {
always: function() {
// do something when the modal is closed
}
}
});
});
</script>
Result
