widget_prompt.md

group	javascript-developer-guide
subgroup	3_Widgets
title	Prompt widget

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.]

Initialize the prompt widget {#prompt_init}

The prompt widget can be initialized with or without binding to a certain element.

Example 1: 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(){}
    }
});

Example 2: 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 {#prompt_options}

• actions
• autoOpen
• clickableOverlay
• content
• focus
• title
• modalClass
• promptContentTmpl
• value
• promptField
• attributesForm
• attributesField
• validation
• validationRules

actions {#prompt_actions}

Widget callbacks.

Type: Object.

Default value:

actions: {
    confirm: function(){},
    cancel: function(){},
    always: function(){}
}

autoOpen {#prompt_autoopen}

Automatically open the prompt window when the widget is initialized.

Type: Boolean

Default value: false

clickableOverlay {#prompt_clickableOverlay}

Close the prompt window when a user clicks on the overlay.

Type: Boolean

Default value: true

content {#prompt_content}

The prompt window content.

Type: String.

focus {#prompt_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 required, set focus to none.

Type: String.

Default value: ''

title {#prompt_title}

The title of the prompt window.

Type: String.

Default value: ''

modalClass {#prompt_modalClass}

The CSS class of the prompt window.

Type: String.

Default value: 'prompt'

promptContentTmpl {#prompt_promptContentTmpl}

The template of the prompt popup form.

Type: String.

Default value:

<form <%= formAttr %>>
    <fieldset class="fieldset">
        <div class="field">
            <% if(data.label){ %>
            <label for="prompt-field-<%- data.id %>" class="label">
                <span><%= data.label %></span>
            </label>
            <% } %>
            <div class="control">
                <input type="text" data-role="promptField" id="prompt-field-<%- data.id %>" class="input-text" <%= inputAttr %>/>
            </div>
        </div>
    </fieldset>
</form>

The file with template [ui/template/modal/modal-prompt-content.html].

value {#prompt_value}

The value of the prompt field.

Type: String.

Default value: ''

promptField {#prompt_promptField}

The prompt field selector.

Type: String.

Default value: '[data-role="promptField"]'

attributesForm {#prompt_attributesForm}

The attributes for the prompt form.

Type: Object.

Default value: {}

attributesField {#prompt_attributesField}

The attributes for the prompt field.

Type: Object.

Default value: {}

validation {#prompt_validation}

Specifies if the prompt form should be validated, when the confirmation button is clicked.

Type: Boolean

Default value: false

validationRules {#prompt_validationRules}

The array of validation classes which will be added to prompt field.

Type: Array

Default value: []

Events {#prompt_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: called when the popup is closed.

Keyboard navigation {#prompt_key_navigation}

The keyboard navigation for the alert windows is similar to the [navigation of the modal widget].

Code Sample

Code sample of initialization on an element

<script>
    require([
        'jquery',
        'Magento_Ui/js/modal/prompt'
    ], function ($) {
        'use strict';

        $('.prompt-modal-content').prompt({
            title: 'Prompt Title',
            modalClass: 'prompt',
            value: 'Value by default',
            validation: true,
            promptField: '[data-role="promptField"]',
            validationRules: ['required-entry'],
            attributesForm: {
                novalidate: 'novalidate',
                action: ''
            },
            attributesField: {
                name: 'name',
                'data-validate': '{required:true}',
                maxlength: '255'
            }, // attributes for the input field
            actions: {
                always: function() {
                    // do something when the modal is closed
                },
                confirm: function () {
                    // do something when the confirmation button is clicked
                },
                cancel: function () {
                    // do something when the cancel button is clicked
                }
            }
        });
    });
</script>

Code sample of standalone initialization

<div class="prompt-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/prompt'
    ], function ($, prompt) {
        'use strict';

        prompt({
            title: 'Prompt Title',
            content: $('.prompt-modal-content'),
            modalClass: 'prompt',
            value: 'Value by default',
            validation: true,
            promptField: '[data-role="promptField"]',
            validationRules: ['required-entry'],
            attributesForm: {
                novalidate: 'novalidate',
                action: ''
            },
            attributesField: {
                name: 'name',
                'data-validate': '{required:true}',
                maxlength: '255'
            },
            actions: {
                always: function() {
                    // do something when the modal is closed
                },
                confirm: function () {
                    // do something when the confirmation button is clicked
                },
                cancel: function () {
                    // do something when the cancel button is clicked
                }
            }
        });
    });
</script>

Result


[<Magento_Ui_module_dir>/view/base/web/js/modal/prompt.js]: {{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Ui/view/base/web/js/modal/prompt.js [ui/template/modal/modal-prompt-content.html]: {{ site.mage2bloburl }}/{{ page.guide_version }}/app/code/Magento/Ui/view/base/web/templates/modal/modal-prompt-content.html [Magento Admin Pattern Library, the Slide-out Panels, Modal Windows, and Overlays topic.]: {{page.baseurl}}/pattern-library/containers/slideouts-modals-overlays/slideouts-modals-overalys.html#modals [JavaScript initialization]: {{page.baseurl}}/javascript-dev-guide/javascript/js_init.html [navigation of the modal widget]: {{page.baseurl}}/javascript-dev-guide/widgets/widget_modal.html#key_navigation