@creative-web-solution/front-library 6.1.3 → 6.2.9

package/documentation/jsdocs/helpers/common/global.html

@@ -1850,6 +1850,9 @@ If 'waitFor' < 0 => wait for an animation frame
             
                 
 <span class="param-type">Number</span>
+|
+
+<span class="param-type">String</span>
 
 
 
@@ -1876,7 +1879,7 @@ If 'waitFor' < 0 => wait for an animation frame
                 </td>
             
 
-            <td class="description last">In ms</td>
+            <td class="description last">Number in ms or 'idle'</td>
         </tr>
 
     
@@ -1970,6 +1973,9 @@ wait().then( ... )
 // Wait for 500ms
 wait( 500 ).then( ... )
 
+// Wait for an idle state
+wait( &#x27;idle&#x27; ).then( ... )
+
 // To be able to cancel the waiting, don&#x27;t chain .then() directly on wait()
 promise = wait( 500 )
 promise.then( ... )
@@ -2029,7 +2035,7 @@ promise.kill()</pre>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
 	
-		on 2020-07-28T16:49:10+02:00
+		on 2021-02-03T15:24:31+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/helpers/common/index.html

@@ -135,7 +135,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
 	
-		on 2020-07-28T16:49:10+02:00
+		on 2021-02-03T15:24:31+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/helpers/common/quicksearch.html

@@ -7,7 +7,7 @@
     <script src="scripts/fulltext-search.js"></script>
 
     <script type="text/x-docstrap-searchdb">
-    {"global.html":{"id":"global.html","title":"Global","body":" Documentation Classes CookieUrlParser Global _extendcopydebouncedeferdistanceextendgetValuehasLocalStoragesequencethrottlewait Global Methods _extend() Extend function from jQuery 3 copy(target) Clone the properties of an object and its children (deep copy) Parameters: Name Type Description target Object Object to copy Returns: Type Object Example clonedObject = copy(target) debounce(callback [, threshold] [, immediate]) Debounce Parameters: Name Type Argument Default Description callback function threshold Number &lt;optional&gt; 100 immediate Boolean &lt;optional&gt; Returns: Type function Example debouncedFunction = debounce( myFunction, 200 ) defer() Deferred promise Returns: - a promise with a resolve and reject function Type Promise Example let dfd = defer() // To resolve: dfd.resolve() // To reject: dfd.reject() distance(latitude1, longitude1, latitude2, longitude2) Compute the distance (in km) between 2 coordinates Parameters: Name Type Description latitude1 Number longitude1 Number latitude2 Number longitude2 Number Returns: Type Number extend(target, sources) Merge the properties of an object and its children (deep merge) with others objects. It doesn't modify the target object. Parameters: Name Type Argument Description target Object Object to merge sources Object &lt;repeatable&gt; All other arguments are objects Returns: Type Object Example extendedObject = extend(target, obj1, obj2) getValue($input) Get the value of a form field (get from jQuery) Parameters: Name Type Description $input HTMLElement Returns: - the value of the form field Type String | Number Example value = getValue( $input ) hasLocalStorage() Check if the localstorage is available. Returns: Type Boolean Example hasStorage = hasLocalStorage(); sequence(promisesArray) Create a sequential list of promises (which resolves one after another) Parameters: Name Type Description promisesArray Array.&lt;Promise&gt; Returns: Type Promise Example prom = sequence( arrayOfPromise ) throttle(callback [, limit]) Throttle Parameters: Name Type Argument Default Description callback function limit Number &lt;optional&gt; 100 Returns: Type function Example throttledFunction = throttle( cbFunction, 200 ) wait( [waitFor]) Return a promise and wait for 'waitFor' millisecond to resolve it. If 'waitFor' &lt; 0 =&gt; wait for an animation frame Parameters: Name Type Argument Default Description waitFor Number &lt;optional&gt; -1 In ms Returns: - a promise with a .kill() function to cancel the waiting Type Promise Example // Wait for an animation frame (using requestAnimationFrame) wait().then( ... ) // Wait for 500ms wait( 500 ).then( ... ) // To be able to cancel the waiting, don't chain .then() directly on wait() promise = wait( 500 ) promise.then( ... ) promise.kill() × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:10+02:00 using the DocStrap template. "},"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes CookieUrlParser Global _extendcopydebouncedeferdistanceextendgetValuehasLocalStoragesequencethrottlewait Classes Classes Cookie UrlParser × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:10+02:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes CookieUrlParser Global _extendcopydebouncedeferdistanceextendgetValuehasLocalStoragesequencethrottlewait × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:10+02:00 using the DocStrap template. "},"Cookie.html":{"id":"Cookie.html","title":"Class: Cookie","body":" Documentation Classes CookieUrlParser Global _extendcopydebouncedeferdistanceextendgetValuehasLocalStoragesequencethrottlewait Class: Cookie Cookie new Cookie() Manage cookie Example cookie.create( 'cookieName', 'cookieValue' ) cookie.read( 'cookieName' ) cookie.erase( 'cookieName' ) // All parameters cookie.create( 'cookieName', 'cookieValue', { \"days\": 10, \"secure\": true, \"domain\": \"test.com\", \"path\": \"/myDir\" } ); Methods read(name) Read a cookie Parameters: Name Type Description name String Returns: Type String × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:10+02:00 using the DocStrap template. "},"UrlParser.html":{"id":"UrlParser.html","title":"Class: UrlParser","body":" Documentation Classes CookieUrlParser Global _extendcopydebouncedeferdistanceextendgetValuehasLocalStoragesequencethrottlewait Class: UrlParser UrlParser new UrlParser(url) Parse an URL Parameters: Name Type Description url String Returns: the parsed url Type urlParser_Object Example let url = new UrlParser( 'https://username:password@demo.domain.com:1337/section/page.html?param=1&amp;param=2#anchor' ); // Update the anchor and regenerate url url.setAnchor( 'anchor' ) // Get a query param url.getParam( 'key' ) // Get all query params url.getParam() // or this.queryKey // Add/modify a query param url.setParam( 'key', value ) // Add/modify several query param url.setParam( { \"key1\": \"value1\", \"key2\": \"value2\" } ) // Remove a query param url.removeParam( 'key' ) url.removeParam( [ 'key1', 'key2', ... ] ) // Remove all query param url.removeAll() Methods getParam( [key]) Get the value of a query param Parameters: Name Type Argument Description key String &lt;optional&gt; Returns: Type String | Object removeAll() Delete all query param Returns: Type UrlParser removeParam(keys) Remove one or several query param Parameters: Name Type Description keys String | Array.&lt;String&gt; Returns: Type UrlParser setAnchor(anchor) Change anchor and recreate all values Parameters: Name Type Description anchor String Returns: Type UrlParser setParam(keys, value) Add/modify one or several query param Parameters: Name Type Description keys String | Object value String Returns: Type UrlParser Type Definitions urlParser_Object Type: Object Properties: Name Type Description absolute String https://demo.domain.com:1337/section/page.html?param=2 absolute2 String https://demo.domain.com:1337/section/page.html?param=2#anchor anchor String anchor authority String username:password@demo.domain.com:1337 directory String /section/ file String page.html full String https://username:password@demo.domain.com:1337/section/page.html?param=2 full2 String https://username:password@demo.domain.com:1337/section/page.html?param=2#anchor host String demo.domain.com location String new UrlParser(window.location) password String password path String /section/page.html port String 1337 protocol String https query String param=2 queryKey Object { param: \"2\" } relative String Url without host, credential and anchor relative2 String Url without host, credential but with anchor source String Original Url, never change: https://username:password@demo.domain.com:1337/section/page.html?param=1&amp;param=2#anchor user String username userInfo String username:password isAnchor Boolean false isSameDomain Boolean false setAnchor function setParam function removeParam function removeAll function × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:10+02:00 using the DocStrap template. "}}
+    {"global.html":{"id":"global.html","title":"Global","body":" Documentation Classes CookieUrlParser Global _extendcopydebouncedeferdistanceextendgetValuehasLocalStoragesequencethrottlewait Global Methods _extend() Extend function from jQuery 3 copy(target) Clone the properties of an object and its children (deep copy) Parameters: Name Type Description target Object Object to copy Returns: Type Object Example clonedObject = copy(target) debounce(callback [, threshold] [, immediate]) Debounce Parameters: Name Type Argument Default Description callback function threshold Number &lt;optional&gt; 100 immediate Boolean &lt;optional&gt; Returns: Type function Example debouncedFunction = debounce( myFunction, 200 ) defer() Deferred promise Returns: - a promise with a resolve and reject function Type Promise Example let dfd = defer() // To resolve: dfd.resolve() // To reject: dfd.reject() distance(latitude1, longitude1, latitude2, longitude2) Compute the distance (in km) between 2 coordinates Parameters: Name Type Description latitude1 Number longitude1 Number latitude2 Number longitude2 Number Returns: Type Number extend(target, sources) Merge the properties of an object and its children (deep merge) with others objects. It doesn't modify the target object. Parameters: Name Type Argument Description target Object Object to merge sources Object &lt;repeatable&gt; All other arguments are objects Returns: Type Object Example extendedObject = extend(target, obj1, obj2) getValue($input) Get the value of a form field (get from jQuery) Parameters: Name Type Description $input HTMLElement Returns: - the value of the form field Type String | Number Example value = getValue( $input ) hasLocalStorage() Check if the localstorage is available. Returns: Type Boolean Example hasStorage = hasLocalStorage(); sequence(promisesArray) Create a sequential list of promises (which resolves one after another) Parameters: Name Type Description promisesArray Array.&lt;Promise&gt; Returns: Type Promise Example prom = sequence( arrayOfPromise ) throttle(callback [, limit]) Throttle Parameters: Name Type Argument Default Description callback function limit Number &lt;optional&gt; 100 Returns: Type function Example throttledFunction = throttle( cbFunction, 200 ) wait( [waitFor]) Return a promise and wait for 'waitFor' millisecond to resolve it. If 'waitFor' &lt; 0 =&gt; wait for an animation frame Parameters: Name Type Argument Default Description waitFor Number | String &lt;optional&gt; -1 Number in ms or 'idle' Returns: - a promise with a .kill() function to cancel the waiting Type Promise Example // Wait for an animation frame (using requestAnimationFrame) wait().then( ... ) // Wait for 500ms wait( 500 ).then( ... ) // Wait for an idle state wait( 'idle' ).then( ... ) // To be able to cancel the waiting, don't chain .then() directly on wait() promise = wait( 500 ) promise.then( ... ) promise.kill() × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes CookieUrlParser Global _extendcopydebouncedeferdistanceextendgetValuehasLocalStoragesequencethrottlewait Classes Classes Cookie UrlParser × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes CookieUrlParser Global _extendcopydebouncedeferdistanceextendgetValuehasLocalStoragesequencethrottlewait × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"Cookie.html":{"id":"Cookie.html","title":"Class: Cookie","body":" Documentation Classes CookieUrlParser Global _extendcopydebouncedeferdistanceextendgetValuehasLocalStoragesequencethrottlewait Class: Cookie Cookie new Cookie() Manage cookie Example cookie.create( 'cookieName', 'cookieValue' ) cookie.read( 'cookieName' ) cookie.delete( 'cookieName' ) // All parameters cookie.create( 'cookieName', 'cookieValue', { \"days\": 10, \"secure\": true, \"domain\": \"test.com\", \"path\": \"/myDir\" } ); Methods read(name) Read a cookie Parameters: Name Type Description name String Returns: Type String × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"UrlParser.html":{"id":"UrlParser.html","title":"Class: UrlParser","body":" Documentation Classes CookieUrlParser Global _extendcopydebouncedeferdistanceextendgetValuehasLocalStoragesequencethrottlewait Class: UrlParser UrlParser new UrlParser(url) Parse an URL Parameters: Name Type Description url String Returns: the parsed url Type urlParser_Object Example let url = new UrlParser( 'https://username:password@demo.domain.com:1337/section/page.html?param=1&amp;param=2#anchor' ); // Update the anchor and regenerate url url.setAnchor( 'anchor' ) // Get a query param url.getParam( 'key' ) // Get all query params url.getParam() // or this.queryKey // Add/modify a query param url.setParam( 'key', value ) // Add/modify several query param url.setParam( { \"key1\": \"value1\", \"key2\": \"value2\" } ) // Remove a query param url.removeParam( 'key' ) url.removeParam( [ 'key1', 'key2', ... ] ) // Remove all query param url.removeAll() Methods getParam( [key]) Get the value of a query param Parameters: Name Type Argument Description key String &lt;optional&gt; Returns: Type String | Object removeAll() Delete all query param Returns: Type UrlParser removeParam(keys) Remove one or several query param Parameters: Name Type Description keys String | Array.&lt;String&gt; Returns: Type UrlParser setAnchor(anchor) Change anchor and recreate all values Parameters: Name Type Description anchor String Returns: Type UrlParser setParam(keys, value) Add/modify one or several query param Parameters: Name Type Description keys String | Object value String Returns: Type UrlParser Type Definitions urlParser_Object Type: Object Properties: Name Type Description absolute String https://demo.domain.com:1337/section/page.html?param=2 absolute2 String https://demo.domain.com:1337/section/page.html?param=2#anchor anchor String anchor authority String username:password@demo.domain.com:1337 directory String /section/ file String page.html full String https://username:password@demo.domain.com:1337/section/page.html?param=2 full2 String https://username:password@demo.domain.com:1337/section/page.html?param=2#anchor host String demo.domain.com location String new UrlParser(window.location) password String password path String /section/page.html port String 1337 protocol String https query String param=2 queryKey Object { param: \"2\" } relative String Url without host, credential and anchor relative2 String Url without host, credential but with anchor source String Original Url, never change: https://username:password@demo.domain.com:1337/section/page.html?param=1&amp;param=2#anchor user String username userInfo String username:password isAnchor Boolean false isSameDomain Boolean false setAnchor function setParam function removeParam function removeAll function × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "}}
     </script>
 
     <script type="text/javascript">

package/documentation/jsdocs/helpers/types/global.html

@@ -1138,7 +1138,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
 	
-		on 2020-07-28T16:49:08+02:00
+		on 2021-02-03T15:24:30+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/helpers/types/index.html

@@ -128,7 +128,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
 	
-		on 2020-07-28T16:49:08+02:00
+		on 2021-02-03T15:24:30+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/helpers/types/quicksearch.html

@@ -7,7 +7,7 @@
     <script src="scripts/fulltext-search.js"></script>
 
     <script type="text/x-docstrap-searchdb">
-    {"global.html":{"id":"global.html","title":"Global","body":" Documentation Global isArrayisFunctionisNumberisPlainObjectisStringisType Global Methods isArray(obj) Return true if the objec is an Array Parameters: Name Type Description obj * Returns: Type Boolean Example boolean = isArray( obj ) isFunction(obj) Return true if the object is a Function Parameters: Name Type Description obj * Returns: Type Boolean Example boolean = isFunction( obj ) isNumber(obj) Return true if the object is a Number Parameters: Name Type Description obj * Returns: Type Boolean Example boolean = isNumber( obj ) isPlainObject(obj) Return true if obj is {} or an object created with \"new Object\" Parameters: Name Type Description obj * Returns: Type Boolean isString(obj) Return true if the object is a String Parameters: Name Type Description obj * Returns: Type Boolean Example boolean = isString( obj ) isType(obj, type) Check the type of an object Parameters: Name Type Description obj * type String Returns: - true if the object is in the asked type Type Boolean Example boolean = isType( obj, 'String' ) × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:08+02:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Global isArrayisFunctionisNumberisPlainObjectisStringisType × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:08+02:00 using the DocStrap template. "}}
+    {"global.html":{"id":"global.html","title":"Global","body":" Documentation Global isArrayisFunctionisNumberisPlainObjectisStringisType Global Methods isArray(obj) Return true if the objec is an Array Parameters: Name Type Description obj * Returns: Type Boolean Example boolean = isArray( obj ) isFunction(obj) Return true if the object is a Function Parameters: Name Type Description obj * Returns: Type Boolean Example boolean = isFunction( obj ) isNumber(obj) Return true if the object is a Number Parameters: Name Type Description obj * Returns: Type Boolean Example boolean = isNumber( obj ) isPlainObject(obj) Return true if obj is {} or an object created with \"new Object\" Parameters: Name Type Description obj * Returns: Type Boolean isString(obj) Return true if the object is a String Parameters: Name Type Description obj * Returns: Type Boolean Example boolean = isString( obj ) isType(obj, type) Check the type of an object Parameters: Name Type Description obj * type String Returns: - true if the object is in the asked type Type Boolean Example boolean = isType( obj, 'String' ) × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:30+01:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Global isArrayisFunctionisNumberisPlainObjectisStringisType × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:30+01:00 using the DocStrap template. "}}
     </script>
 
     <script type="text/javascript">

package/documentation/jsdocs/modules/accordion/Accordion.html

@@ -1239,7 +1239,7 @@ Set aria-expanded to &quot;true&quot; on the tab you want open at start</pre>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
 	
-		on 2020-07-28T16:49:08+02:00
+		on 2021-02-03T15:24:31+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/accordion/classes.list.html

@@ -195,7 +195,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
 	
-		on 2020-07-28T16:49:08+02:00
+		on 2021-02-03T15:24:31+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/accordion/index.html

@@ -128,7 +128,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
 	
-		on 2020-07-28T16:49:08+02:00
+		on 2021-02-03T15:24:31+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/accordion/quicksearch.html

@@ -7,7 +7,7 @@
     <script src="scripts/fulltext-search.js"></script>
 
     <script type="text/x-docstrap-searchdb">
-    {"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes Accordion Classes Classes Accordion × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:08+02:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes Accordion × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:08+02:00 using the DocStrap template. "},"Accordion.html":{"id":"Accordion.html","title":"Class: Accordion","body":" Documentation Classes Accordion Class: Accordion Accordion new Accordion($accordionWrapper [, userOptions]) Accordion Parameters: Name Type Argument Description $accordionWrapper HTMLElement userOptions Object &lt;optional&gt; Properties Name Type Argument Default Description tabSelector String &lt;optional&gt; 'button[aria-expanded]' allowMultipleTab Boolean &lt;optional&gt; false onOpenAtStart Accordion_callback &lt;optional&gt; onOpen Accordion_callback &lt;optional&gt; onClose Accordion_callback &lt;optional&gt; animations Object &lt;optional&gt; Properties Name Type Argument Description open Accordion_animation &lt;optional&gt; close Accordion_animation &lt;optional&gt; destroy Accordion_animation &lt;optional&gt; Example new Accordion( document.querySelector( '.accordion' ), { \"tabSelector\": \".tab\", \"allowMultipleTab\": false, \"animations\": { \"open\": function( $tab, $panel ) { aClass( [ $tab, $panel ], 'on' ); return Promise.resolve(); }, \"close\": function( $tab, $panel ) { rClass( [ $tab, $panel ], 'on' ); return Promise.resolve(); }, \"destroy\": function( $tab, $panel ) { rClass( [ $tab, $panel ], 'on' ); return Promise.resolve(); } }, \"onOpenAtStart\": function( $tab, $panel ) { console.log( 'open: ', $tab, $panel ); }, \"onOpen\": function( $tab, $panel ) { console.log( 'open: ', $tab, $panel ); }, \"onClose\": function( $tab, $panel ) { console.log( 'close: ', $tab, $panel ); } } ); HTML: &lt;div class=\"accordion\"&gt; &lt;button aria-expanded=\"true\" class=\"tab\" aria-controls=\"panel-1\"&gt;Button name&lt;/button&gt; &lt;div id=\"panel-1\" class=\"panel\"&gt; &lt;p&gt;Content&lt;/p&gt; &lt;/div&gt; &lt;button aria-expanded=\"false\" class=\"tab\" aria-controls=\"panel-2\"&gt;Button name&lt;/button&gt; &lt;div id=\"panel-2\" class=\"panel\"&gt; &lt;p&gt;Content&lt;/p&gt; &lt;/div&gt; &lt;/div&gt; Set aria-expanded to \"true\" on the tab you want open at start Methods destroy() Remove all events, css class, ... update() Restart the module Type Definitions Accordion_animation($tab, $panel) Parameters: Name Type Description $tab HTMLElement $panel HTMLElement Returns: Type Promise Accordion_callback($tab, $panel) Parameters: Name Type Description $tab HTMLElement $panel HTMLElement × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:08+02:00 using the DocStrap template. "}}
+    {"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes Accordion Classes Classes Accordion × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes Accordion × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"Accordion.html":{"id":"Accordion.html","title":"Class: Accordion","body":" Documentation Classes Accordion Class: Accordion Accordion new Accordion($accordionWrapper [, userOptions]) Accordion Parameters: Name Type Argument Description $accordionWrapper HTMLElement userOptions Object &lt;optional&gt; Properties Name Type Argument Default Description tabSelector String &lt;optional&gt; 'button[aria-expanded]' allowMultipleTab Boolean &lt;optional&gt; false onOpenAtStart Accordion_callback &lt;optional&gt; onOpen Accordion_callback &lt;optional&gt; onClose Accordion_callback &lt;optional&gt; animations Object &lt;optional&gt; Properties Name Type Argument Description open Accordion_animation &lt;optional&gt; close Accordion_animation &lt;optional&gt; destroy Accordion_animation &lt;optional&gt; Example new Accordion( document.querySelector( '.accordion' ), { \"tabSelector\": \".tab\", \"allowMultipleTab\": false, \"animations\": { \"open\": function( $tab, $panel ) { aClass( [ $tab, $panel ], 'on' ); return Promise.resolve(); }, \"close\": function( $tab, $panel ) { rClass( [ $tab, $panel ], 'on' ); return Promise.resolve(); }, \"destroy\": function( $tab, $panel ) { rClass( [ $tab, $panel ], 'on' ); return Promise.resolve(); } }, \"onOpenAtStart\": function( $tab, $panel ) { console.log( 'open: ', $tab, $panel ); }, \"onOpen\": function( $tab, $panel ) { console.log( 'open: ', $tab, $panel ); }, \"onClose\": function( $tab, $panel ) { console.log( 'close: ', $tab, $panel ); } } ); HTML: &lt;div class=\"accordion\"&gt; &lt;button aria-expanded=\"true\" class=\"tab\" aria-controls=\"panel-1\"&gt;Button name&lt;/button&gt; &lt;div id=\"panel-1\" class=\"panel\"&gt; &lt;p&gt;Content&lt;/p&gt; &lt;/div&gt; &lt;button aria-expanded=\"false\" class=\"tab\" aria-controls=\"panel-2\"&gt;Button name&lt;/button&gt; &lt;div id=\"panel-2\" class=\"panel\"&gt; &lt;p&gt;Content&lt;/p&gt; &lt;/div&gt; &lt;/div&gt; Set aria-expanded to \"true\" on the tab you want open at start Methods destroy() Remove all events, css class, ... update() Restart the module Type Definitions Accordion_animation($tab, $panel) Parameters: Name Type Description $tab HTMLElement $panel HTMLElement Returns: Type Promise Accordion_callback($tab, $panel) Parameters: Name Type Description $tab HTMLElement $panel HTMLElement × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "}}
     </script>
 
     <script type="text/javascript">

package/documentation/jsdocs/modules/autocomplete/Autocomplete.html

@@ -2243,7 +2243,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
 	
-		on 2020-07-28T16:49:09+02:00
+		on 2021-02-03T15:24:31+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/autocomplete/classes.list.html

@@ -195,7 +195,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
 	
-		on 2020-07-28T16:49:09+02:00
+		on 2021-02-03T15:24:31+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/autocomplete/index.html

@@ -128,7 +128,7 @@
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a>
 	
-		on 2020-07-28T16:49:09+02:00
+		on 2021-02-03T15:24:31+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/autocomplete/quicksearch.html

@@ -7,7 +7,7 @@
     <script src="scripts/fulltext-search.js"></script>
 
     <script type="text/x-docstrap-searchdb">
-    {"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes Autocomplete Classes Classes Autocomplete × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:09+02:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes Autocomplete × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:09+02:00 using the DocStrap template. "},"Autocomplete.html":{"id":"Autocomplete.html","title":"Class: Autocomplete","body":" Documentation Classes Autocomplete Class: Autocomplete Autocomplete new Autocomplete(userOptions) Autocomplete Parameters: Name Type Description userOptions Object Properties Name Type Argument Default Description $searchField HTMLElement $panelWrapper HTMLElement &lt;optional&gt; document.body maxHeight number &lt;optional&gt; 200 useCache Boolean &lt;optional&gt; false minchar Number &lt;optional&gt; 3 source &lt;optional&gt; url String cssPositionning String &lt;optional&gt; false Use CSS or Javascript for the position of the layer updateOnSelect boolean &lt;optional&gt; true Update or not the text field with the selected value onSelect Callback &lt;optional&gt; ({ item, query, resultsList }) =&gt; {} queryParams Callback &lt;optional&gt; query =&gt; { return { \"search\": query } } normalize function &lt;optional&gt; data =&gt; data Conver the ajax response in the good JSON format =&gt; {success, results} renderFieldValue function &lt;optional&gt; ({item, query, resultList}) =&gt; item.name Allow to manipulate the displayed value of items render function &lt;optional&gt; ({resultItem, query, index, itemsList, cssClass}) =&gt; `&lt;li role=\"option\" data-idx=\"${index}\" class=\"${cssClass.item}\"&gt;&lt;a class=\"${cssClass.link}\"&gt;${resultItem.markedName}&lt;/a&gt;&lt;/li&gt;` renderList function &lt;optional&gt; ({resultList, query, cssClass}) =&gt; `&lt;ul role=\"listbox\" class=\"${cssClass.list}\"&gt;${resultList.join('')}&lt;/ul&gt;` renderError function &lt;optional&gt; ({errorMsg, query, cssClass}) =&gt; `&lt;li class=\"${cssClass.error}\"&gt;${errorMsg}&lt;/li&gt;` renderMark function &lt;optional&gt; Allow to wrap the query with a tag in the result item name ({resultItem, reQuery, query, index, resultList, cssClass}) =&gt; {resultItem.name &amp;&amp; (resultItem.markedName = resultItem.name.replace(reQuery,`$1`));} l10n Object &lt;optional&gt; Properties Name Type Argument Default Description noResult String &lt;optional&gt; No result error String &lt;optional&gt; Server error className Object &lt;optional&gt; Properties Name Type Argument Default Description layer String &lt;optional&gt; ac-layer list String &lt;optional&gt; ac-list item String &lt;optional&gt; acl-itm mark String &lt;optional&gt; acl-mrk error String &lt;optional&gt; acl-error hover String &lt;optional&gt; hover disable String &lt;optional&gt; disable See: extra/modules/autocomplete.md for details. Methods clean() Destroy the Autocomplete Returns: Type Autocomplete disable() Disable the autocomplete Returns: Type Autocomplete enable() Enable the autocomplete Returns: Type Autocomplete reset() Reset the input field and the results resetField() Reset the input field resetResults() Reset the results setOptions(newOption) Update the current options Parameters: Name Type Description newOption Object Same options as constructor Returns: Type Autocomplete showAll() When 'source' is used, display the list with all items Returns: Type Autocomplete × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:09+02:00 using the DocStrap template. "}}
+    {"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes Autocomplete Classes Classes Autocomplete × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes Autocomplete × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"Autocomplete.html":{"id":"Autocomplete.html","title":"Class: Autocomplete","body":" Documentation Classes Autocomplete Class: Autocomplete Autocomplete new Autocomplete(userOptions) Autocomplete Parameters: Name Type Description userOptions Object Properties Name Type Argument Default Description $searchField HTMLElement $panelWrapper HTMLElement &lt;optional&gt; document.body maxHeight number &lt;optional&gt; 200 useCache Boolean &lt;optional&gt; false minchar Number &lt;optional&gt; 3 source &lt;optional&gt; url String cssPositionning String &lt;optional&gt; false Use CSS or Javascript for the position of the layer updateOnSelect boolean &lt;optional&gt; true Update or not the text field with the selected value onSelect Callback &lt;optional&gt; ({ item, query, resultsList }) =&gt; {} queryParams Callback &lt;optional&gt; query =&gt; { return { \"search\": query } } normalize function &lt;optional&gt; data =&gt; data Conver the ajax response in the good JSON format =&gt; {success, results} renderFieldValue function &lt;optional&gt; ({item, query, resultList}) =&gt; item.name Allow to manipulate the displayed value of items render function &lt;optional&gt; ({resultItem, query, index, itemsList, cssClass}) =&gt; `&lt;li role=\"option\" data-idx=\"${index}\" class=\"${cssClass.item}\"&gt;&lt;a class=\"${cssClass.link}\"&gt;${resultItem.markedName}&lt;/a&gt;&lt;/li&gt;` renderList function &lt;optional&gt; ({resultList, query, cssClass}) =&gt; `&lt;ul role=\"listbox\" class=\"${cssClass.list}\"&gt;${resultList.join('')}&lt;/ul&gt;` renderError function &lt;optional&gt; ({errorMsg, query, cssClass}) =&gt; `&lt;li class=\"${cssClass.error}\"&gt;${errorMsg}&lt;/li&gt;` renderMark function &lt;optional&gt; Allow to wrap the query with a tag in the result item name ({resultItem, reQuery, query, index, resultList, cssClass}) =&gt; {resultItem.name &amp;&amp; (resultItem.markedName = resultItem.name.replace(reQuery,`$1`));} l10n Object &lt;optional&gt; Properties Name Type Argument Default Description noResult String &lt;optional&gt; No result error String &lt;optional&gt; Server error className Object &lt;optional&gt; Properties Name Type Argument Default Description layer String &lt;optional&gt; ac-layer list String &lt;optional&gt; ac-list item String &lt;optional&gt; acl-itm mark String &lt;optional&gt; acl-mrk error String &lt;optional&gt; acl-error hover String &lt;optional&gt; hover disable String &lt;optional&gt; disable See: extra/modules/autocomplete.md for details. Methods clean() Destroy the Autocomplete Returns: Type Autocomplete disable() Disable the autocomplete Returns: Type Autocomplete enable() Enable the autocomplete Returns: Type Autocomplete reset() Reset the input field and the results resetField() Reset the input field resetResults() Reset the results setOptions(newOption) Update the current options Parameters: Name Type Description newOption Object Same options as constructor Returns: Type Autocomplete showAll() When 'source' is used, display the list with all items Returns: Type Autocomplete × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "}}
     </script>
 
     <script type="text/javascript">