MDL-68409 js: Add helper to register close event on save/cancel
[moodle.git] / lib / amd / src / modal_factory.js
1 // This file is part of Moodle - http://moodle.org/
2 //
3 // Moodle is free software: you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation, either version 3 of the License, or
6 // (at your option) any later version.
7 //
8 // Moodle is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 // GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 /**
17  * Create a modal.
18  *
19  * @module     core/modal_factory
20  * @class      modal_factory
21  * @package    core
22  * @copyright  2016 Ryan Wyllie <ryan@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
25 define(['jquery', 'core/modal_events', 'core/modal_registry', 'core/modal',
26         'core/modal_save_cancel', 'core/modal_cancel',
27         'core/templates', 'core/notification', 'core/custom_interaction_events',
28         'core/pending'],
29     function($, ModalEvents, ModalRegistry, Modal, ModalSaveCancel,
30         ModalCancel, Templates, Notification, CustomEvents, Pending) {
32     // The templates for each type of modal.
33     var TEMPLATES = {
34         DEFAULT: 'core/modal',
35         SAVE_CANCEL: 'core/modal_save_cancel',
36         CANCEL: 'core/modal_cancel',
37     };
39     // The available types of modals.
40     var TYPES = {
41         DEFAULT: 'DEFAULT',
42         SAVE_CANCEL: 'SAVE_CANCEL',
43         CANCEL: 'CANCEL',
44     };
46     // Register the common set of modals.
47     ModalRegistry.register(TYPES.DEFAULT, Modal, TEMPLATES.DEFAULT);
48     ModalRegistry.register(TYPES.SAVE_CANCEL, ModalSaveCancel, TEMPLATES.SAVE_CANCEL);
49     ModalRegistry.register(TYPES.CANCEL, ModalCancel, TEMPLATES.CANCEL);
51     /**
52      * Set up the events required to show the modal and return focus when the modal
53      * is closed.
54      *
55      * @method setUpTrigger
56      * @param {Promise} modalPromise The modal instance
57      * @param {object} triggerElement The jQuery element to open the modal
58      * @param {object} modalConfig The modal configuration given to the factory
59      */
60     var setUpTrigger = function(modalPromise, triggerElement, modalConfig) {
61         // The element that actually shows the modal.
62         var actualTriggerElement = null;
63         // Check if the client has provided a callback function to be called
64         // before the modal is displayed.
65         var hasPreShowCallback = (typeof modalConfig.preShowCallback == 'function');
66         // Function to handle the trigger element being activated.
67         var triggeredCallback = function(e, data) {
68             var pendingPromise = new Pending('core/modal_factory:setUpTrigger:triggeredCallback');
69             actualTriggerElement = $(e.currentTarget);
70             modalPromise.then(function(modal) {
71                 if (hasPreShowCallback) {
72                     // If the client provided a pre-show callback then execute
73                     // it now before showing the modal.
74                     modalConfig.preShowCallback(actualTriggerElement, modal);
75                 }
77                 modal.show();
79                 return modal;
80             })
81             .then(pendingPromise.resolve);
82             data.originalEvent.preventDefault();
83         };
85         // The trigger element can either be a single element or it can be an
86         // element + selector pair to create a delegated event handler to trigger
87         // the modal.
88         if (Array.isArray(triggerElement)) {
89             var selector = triggerElement[1];
90             triggerElement = triggerElement[0];
92             CustomEvents.define(triggerElement, [CustomEvents.events.activate]);
93             triggerElement.on(CustomEvents.events.activate, selector, triggeredCallback);
94         } else {
95             CustomEvents.define(triggerElement, [CustomEvents.events.activate]);
96             triggerElement.on(CustomEvents.events.activate, triggeredCallback);
97         }
99         modalPromise.then(function(modal) {
100             modal.getRoot().on(ModalEvents.hidden, function() {
101                 // Focus on the trigger element that actually launched the modal.
102                 if (actualTriggerElement !== null) {
103                     actualTriggerElement.focus();
104                 }
105             });
107             return modal;
108         });
109     };
111     /**
112      * Create the correct instance of a modal based on the givem type. Sets up
113      * the trigger between the modal and the trigger element.
114      *
115      * @method createFromElement
116      * @param {object} registryConf A config from the ModalRegistry
117      * @param {object} modalElement The modal HTML jQuery object
118      * @return {object} Modal instance
119      */
120     var createFromElement = function(registryConf, modalElement) {
121         modalElement = $(modalElement);
122         var module = registryConf.module;
123         var modal = new module(modalElement);
125         return modal;
126     };
128     /**
129      * Create the correct modal instance for the given type, including loading
130      * the correct template.
131      *
132      * @method createFromType
133      * @param {object} registryConf A config from the ModalRegistry
134      * @param {object} templateContext The context to render the template with
135      * @return {promise} Resolved with a Modal instance
136      */
137     var createFromType = function(registryConf, templateContext) {
138         var templateName = registryConf.template;
140         var modalPromise = Templates.render(templateName, templateContext)
141             .then(function(html) {
142                 var modalElement = $(html);
143                 return createFromElement(registryConf, modalElement);
144             })
145             .fail(Notification.exception);
147         return modalPromise;
148     };
150     /**
151      * Create a Modal instance.
152      *
153      * @method create
154      * @param {object} modalConfig The configuration to create the modal instance
155      * @param {object} triggerElement The trigger HTML jQuery object
156      * @return {promise} Resolved with a Modal instance
157      */
158     var create = function(modalConfig, triggerElement) {
159         var type = modalConfig.type || TYPES.DEFAULT;
160         var isLarge = modalConfig.large ? true : false;
161         var registryConf = null;
162         var templateContext = {};
164         registryConf = ModalRegistry.get(type);
166         if (!registryConf) {
167             Notification.exception({message: 'Unable to find modal of type: ' + type});
168         }
170         if (typeof modalConfig.templateContext != 'undefined') {
171             templateContext = modalConfig.templateContext;
172         }
174         var modalPromise = createFromType(registryConf, templateContext)
175             .then(function(modal) {
176                 if (typeof modalConfig.title != 'undefined') {
177                     modal.setTitle(modalConfig.title);
178                 }
180                 if (typeof modalConfig.body != 'undefined') {
181                     modal.setBody(modalConfig.body);
182                 }
184                 if (typeof modalConfig.footer != 'undefined') {
185                     modal.setFooter(modalConfig.footer);
186                 }
188                 if (isLarge) {
189                     modal.setLarge();
190                 }
192                 if (typeof modalConfig.removeOnClose !== 'undefined') {
193                     // If configured remove the modal when hiding it.
194                     modal.setRemoveOnClose(modalConfig.removeOnClose);
195                 }
197                 return modal;
198             });
200         if (typeof triggerElement != 'undefined') {
201             setUpTrigger(modalPromise, triggerElement, modalConfig);
202         }
204         return modalPromise;
205     };
207     return {
208         create: create,
209         types: TYPES,
210     };
211 });