Overview
The Magento prompt widget implements a modal pop-up window with an input field, and a cancel and a confirmation button.
It extends the Magento modal widget.
The prompt widget source is <Magento_Ui_module_dir>/view/base/web/js/modal/prompt.js
The widget can be used for implementing prompt windows for both, Admin and storefront. The design patterns for the modal pop-up windows in the Admin are described in the Magento Admin Pattern Library, the Slide-out Panels, Modal Windows, and Overlays topic.
Contents
Initialize the prompt widget
The prompt widget can be initialized with or without binding to a certain element.
Example1: initialization on an element
$('#prompt_init').prompt({
title: 'Prompt title',
actions: {
confirm: function(){}, //callback on 'Ok' button click
cancel: function(){}, //callback on 'Cancel' button click
always: function(){}
}
});
Example2: standalone initialization
require([
'Magento_Ui/js/modal/prompt'
], function(prompt) { // Variable that represents the `prompt` function
prompt({
title: 'Some title',
content: 'Some content',
actions: {
confirm: function(){},
cancel: function(){},
always: function(){}
}
});
});
For details about how to initialize a widget in a .phtml
template, refer to the Javascript initialization topic.
Options
actions
Widget callbacks.
Type: Object.
Default value:
actions: {
confirm: function(){},
cancel: function(){},
always: function(){}
}
autoOpen
Automatically open the prompt window when the widget is initialized.
Type: Boolean
Default value: false
clickableOverlay
Close the prompt window when a user clicks on the overlay.
Type: Boolean
Default value: true
content
The prompt window content.
Type: String.
focus
The selector of the element to be in focus when the prompt window opens.
If focus
is not specified or set to empty string, the focus is on the close button. If focusing is not requried, set focus
to none
.
Type: String.
Default value: ''
title
The title of the prompt window.
Type: String.
Default value: ''
Events
The prompt widget implements the following events:
confirm
callback: called when the confirmation button is clicked. The first argument is the value of the input field.cancel
callback: called when the cancel button is clicked.always
callback.
Keyboard navigation
The keyboard navigation for the alert windows is similar to the navigation of the modal widget.
Find us on