From 198d72913f58e20c4eabbd3f8f6797847d409d23 Mon Sep 17 00:00:00 2001
From: Jun Pataleta <jun@moodle.com>
Date: Thu, 20 Jul 2017 13:32:50 +0800
Subject: [PATCH] MDL-59366 core_amd: Modifications for form-autocomplete

* New optional parameter 'closeSuggestionsOnSelect' for the enhance()
function for form-autocomplete. Setting this to true will close the
suggestions popup immediately after an option has been selected. If not
specified, it defaults to true for single-select elements and false
for multiple-select elements.

Part of MDL-59290.
---
 lib/amd/build/form-autocomplete.min.js | Bin 8538 -> 8646 bytes
 lib/amd/src/form-autocomplete.js       |  13 +++++++++++--
 lib/upgrade.txt                        |   3 +++
 3 files changed, 14 insertions(+), 2 deletions(-)

diff --git a/lib/amd/build/form-autocomplete.min.js b/lib/amd/build/form-autocomplete.min.js
index 5e301a0b296c1453be899aeebf3e06068774b5af..233e46e18dcda816df9e62c66c8329f1ad885c12 100644
GIT binary patch
delta 560
zcmaJ;!D<vi6l4iOjVop&#6u?TOdpc&q_^2ig6z-)5)g6{$#DrX*?AL3Cfz+fJ+r&6
zLm+=3ee@5!DEI;1JW4LP_!E9Y>>XWl(o0di*Tt)<{(1QQ=*#Wu&M1=woRsJ1P?%JT
z;-xr&3`XVv1FND8BSfgeBSHrDe#iT|*Lkt>fC@6JBJE3iweh|s?d?Y3F!1Jh<n1^V
z-fM?Hyk1-J2qz>=6C5aeZ?o4@_S4F<wQ#P_`K)M;9mfM@Ve{rvvWqe^smg#W78#>4
zS`3^IREijqR6vXZZl(%k;)?^x{*{4?!GD&)-Lb}v=1~`;VInn0yE$7p+eN4Dbis$G
zp|amP+e^jp%zk*t_G{9}DjqSI7!Wa@)l|~ljhR$UnY^GCOATB!@_FR3ZFk9XMd*av
zM{PD|Q*L`pbiE>>22*O`M{N8C1Rm1~o!Zacr-!bJ#DI3cKo|7vj>d%Qzg;=+h~_L6
zsx-%LUSj8mDiYfM6Tg+)UyrvPzVe^1Nfy10CR<w?@-o$chthuZ`^(L9d+onl{UfA7
Kzb19<qW%V#O1xqK

delta 492
zcmYL_F-rq67=|fDM6KBBB%adC&?cG&!9np1f;!mE#i@u~?{aw3CTT9$7VDvZLE^7)
z5}aLKom`y!2mS=jwHB9`moGfu_r7^M{ycjADbID&j*exA9U4?|mi8edeZK<%Kv=@y
z<+yS>KZ{0vUsbtzT)QoBQ*m6YJ7Ya}Hm$#RF0Fn!jgp`~jF1;c&=qENy-^V6X?|nb
z%Xvvh3G1*xH^Y5l2J0UuoJ@~XL42(h1k(XPW2R^KfmS3G1zVC#@hxy+<0;y@@Pv7<
z)QhUsHV+GAH=9ri^$8nl#zQ#DFvk*k2@z7qf+tkrgv6S4lN`@;^{HtT-BQeDssT<A
z9#FGbA~V(v^Cx_lAWt!!Dqi);;EHkB#{)b>MCU$Ad5~|0Z5-ebjck)hGX(>Lr?&lX
zLxg*ORc$MPB^lps+Ib3XQY<DFm@OWPAnh`)&Dl!1AkFtu-Rf&~Z<!PS+8@?xiuKZ1
bG1%f}*4>^N<L1D<DNhz*cRNE_W<TW@E*7B7

diff --git a/lib/amd/src/form-autocomplete.js b/lib/amd/src/form-autocomplete.js
index b43080a131f..17e7adf23ea 100644
--- a/lib/amd/src/form-autocomplete.js
+++ b/lib/amd/src/form-autocomplete.js
@@ -451,7 +451,7 @@ define(['jquery', 'core/log', 'core/str', 'core/templates', 'core/notification']
         // Notifiy that the selection changed.
         notifyChange(originalSelect);
 
-        if (!options.multiple) {
+        if (options.closeSuggestionsOnSelect) {
             // Clear the input element.
             inputElement.val('');
             // Close the list of suggestions.
@@ -718,9 +718,11 @@ define(['jquery', 'core/log', 'core/str', 'core/templates', 'core/notification']
          * @param {Boolean} caseSensitive - If search has to be made case sensitive.
          * @param {Boolean} showSuggestions - If suggestions should be shown
          * @param {String} noSelectionString - Text to display when there is no selection
+         * @param {Boolean} closeSuggestionsOnSelect - Whether to close the suggestions immediately after making a selection.
          * @return {Promise}
          */
-        enhance: function(selector, tags, ajax, placeholder, caseSensitive, showSuggestions, noSelectionString) {
+        enhance: function(selector, tags, ajax, placeholder, caseSensitive, showSuggestions, noSelectionString,
+                          closeSuggestionsOnSelect) {
             // Set some default values.
             var options = {
                 selector: selector,
@@ -769,6 +771,13 @@ define(['jquery', 'core/log', 'core/str', 'core/templates', 'core/notification']
             };
             options.multiple = originalSelect.attr('multiple');
 
+            if (typeof closeSuggestionsOnSelect !== "undefined") {
+                options.closeSuggestionsOnSelect = closeSuggestionsOnSelect;
+            } else {
+                // If not specified, this will close suggestions by default for single-select elements only.
+                options.closeSuggestionsOnSelect = !options.multiple;
+            }
+
             var originalLabel = $('[for=' + state.selectId + ']');
             // Create the new markup and insert it after the select.
             var suggestions = [];
diff --git a/lib/upgrade.txt b/lib/upgrade.txt
index ff6000822b4..bf81ed52863 100644
--- a/lib/upgrade.txt
+++ b/lib/upgrade.txt
@@ -38,6 +38,9 @@ information provided here is intended especially for developers.
   - get_enrolled_with_capabilities_join()
   Setting this parameter to a non-zero value will add a condition to the query such that only users that were enrolled
   with this enrolment method will be returned.
+* New optional parameter 'closeSuggestionsOnSelect' for the enhance() function for form-autocomplete. Setting this to true will
+  close the suggestions popup immediately after an option has been selected. If not specified, it defaults to true for single-select
+  elements and false for multiple-select elements.
 
 === 3.3.1 ===
 
-- 
2.17.1