add onControlOpen callback

nobleclem · Mar 15, 2022 · f3c0d86 · f3c0d86
1 parent 3065cc6
commit f3c0d86
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -2,6 +2,7 @@
 ===================
 resolves pr#183
 resolves pr#186
+add onControlOpen callback
 
 2.4.20 (2021-12-07)
 ===================

diff --git a/README.md b/README.md
@@ -79,6 +79,7 @@ $('select[multiple]').multiselect( 'loadOptions', [{
 | checkboxAutoFit     | bool     | false          | auto calc space requirements for checkbox instead of css padding on label |
 | onLoad              | function |                | fires at end of initial loading, hides native select list |
 | onOptionClick       | function |                | fires after on option is clicked |
+| onControlOpen       | function |                | fires when the options list is open |
 | onControlClose      | function |                | fires when the options list is closed |
 | onSelectAll         | function |                | fires when (un)select all is clicked |
 | onPlaceholder       | function |                | fires when the placeholder txt is updated |
@@ -168,6 +169,15 @@ element: select list element object
 option:  option element object
 
 
+**onControlOpen**
+
+Fires when the options list is opened
+
+`onControlOpen( element )`
+
+element: select list element object
+
+
 **onControlClose**
 
 Fires when the options list is closed

diff --git a/jquery.multiselect.js b/jquery.multiselect.js
@@ -70,6 +70,7 @@
         // Callbacks
         onLoad        : function( element ){},           // fires at end of list initialization
         onOptionClick : function( element, option ){},   // fires when an option is clicked
+        onControlOpen : function( element ){},           // fires when the options list is opened
         onControlClose: function( element ){},           // fires when the options list is closed
         onSelectAll   : function( element, selected ){}, // fires when (un)select all is clicked
         onPlaceholder : function( element, placeholder, selectedOpts ){}, // fires when the placeholder txt is updated
@@ -258,6 +259,11 @@
 
                 // recalculate height
                 if( optionsWrap.closest('.ms-options-wrap').hasClass('ms-active') ) {
+                    // USER CALLBACK
+                    if( typeof instance.options.onControlOpen == 'function' ) {
+                        instance.options.onControlOpen( instance.element );
+                    }
+
                     optionsWrap.css( 'maxHeight', '' );
 
                     // override with user defined maxHeight