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

package/documentation/jsdocs/modules/media-preloader/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 MediaPreloader Classes Classes MediaPreloader × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:07+02:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes MediaPreloader × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:08+02:00 using the DocStrap template. "},"MediaPreloader.html":{"id":"MediaPreloader.html","title":"Class: MediaPreloader","body":" Documentation Classes MediaPreloader Class: MediaPreloader MediaPreloader new MediaPreloader(options) Preload audio and video Parameters: Name Type Description options Object Properties Name Type Argument Description $media HTMLElement onProgress mediaPreloader_Callback &lt;optional&gt; Example let mp = new MediaPreloader( { \"$media\": $myVideo, \"onProgress\": percent =&gt; { } } ) .then( handler ) .catch( handler ); // Must start the load manually mp.startLoad(); // Browser capability allowMP4 = MediaPreloader.videoCanPlayType.mp4; allowWEBM = MediaPreloader.videoCanPlayType.WEBM; allowMP3 = MediaPreloader.videoCanPlayType.mp3; MediaPreloader.getUrl( '/path/my-video' ) // =&gt; '/path/my-video.mp4' if the browser use mp4 Members &lt;static&gt; videoCanPlayType :MediaPreloader_PlayType Browser play capabilities Type: MediaPreloader_PlayType Methods &lt;static&gt; getUrl(url) Add the correct extention depending on the browser capability Parameters: Name Type Description url String File name without extention Returns: Type String startLoad() Start the preload of the media Returns: Type Promise Type Definitions mediaPreloader_Callback(percent) Parameters: Name Type Description percent Number MediaPreloader_PlayType Properties: Name Type Description mp4 Boolean webm Boolean mp3 Boolean × 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 MediaPreloader Classes Classes MediaPreloader × 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 Classes MediaPreloader × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"MediaPreloader.html":{"id":"MediaPreloader.html","title":"Class: MediaPreloader","body":" Documentation Classes MediaPreloader Class: MediaPreloader MediaPreloader new MediaPreloader(options) Preload audio and video Parameters: Name Type Description options Object Properties Name Type Argument Description $media HTMLElement onProgress mediaPreloader_Callback &lt;optional&gt; Example let mp = new MediaPreloader( { \"$media\": $myVideo, \"onProgress\": percent =&gt; { } } ) .then( handler ) .catch( handler ); // Must start the load manually mp.startLoad(); // Browser capability allowMP4 = MediaPreloader.videoCanPlayType.mp4; allowWEBM = MediaPreloader.videoCanPlayType.WEBM; allowMP3 = MediaPreloader.videoCanPlayType.mp3; MediaPreloader.getUrl( '/path/my-video' ) // =&gt; '/path/my-video.mp4' if the browser use mp4 Members &lt;static&gt; videoCanPlayType :MediaPreloader_PlayType Browser play capabilities Type: MediaPreloader_PlayType Methods &lt;static&gt; getUrl(url) Add the correct extention depending on the browser capability Parameters: Name Type Description url String File name without extention Returns: Type String startLoad() Start the preload of the media Returns: Type Promise Type Definitions mediaPreloader_Callback(percent) Parameters: Name Type Description percent Number MediaPreloader_PlayType Properties: Name Type Description mp4 Boolean webm Boolean mp3 Boolean × 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/notifications/Notifications.html

@@ -3012,7 +3012,7 @@ notifSys.add( &#x27;Here is a simple notification&#x27; );</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/notifications/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/notifications/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/notifications/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 Notifications Classes Classes Notifications × 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 Notifications × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:08+02:00 using the DocStrap template. "},"Notifications.html":{"id":"Notifications.html","title":"Class: Notifications","body":" Documentation Classes Notifications Class: Notifications Notifications new Notifications( [userOptions]) Manages a list of notifications Parameters: Name Type Argument Description userOptions Object &lt;optional&gt; Properties Name Type Argument Default Description $wrapper HTMLElement &lt;optional&gt; document.body onClick function &lt;optional&gt; autoCloseDelay Number &lt;optional&gt; 5 In second templates Object &lt;optional&gt; Properties Name Type Argument Default Description notifications String &lt;optional&gt; &lt;div class=\"notifications\"&gt;&lt;div class=\"list\"&gt;&lt;/div&gt;&lt;/div&gt; notification String &lt;optional&gt; &lt;div class=\"notification\"&gt;&lt;/div&gt; selectors Object &lt;optional&gt; Properties Name Type Argument Default Description notifications String &lt;optional&gt; .notifications list String &lt;optional&gt; .list notification String &lt;optional&gt; .notification cssClass Object &lt;optional&gt; Properties Name Type Argument Default Description open String &lt;optional&gt; open success String &lt;optional&gt; success danger String &lt;optional&gt; danger warning String &lt;optional&gt; warning info String &lt;optional&gt; info animations Object &lt;optional&gt; Properties Name Type Argument Description show function &lt;optional&gt; ($notification, options) =&gt; Promise hide function &lt;optional&gt; ($notification, options) =&gt; Promise Example let notifSys = new Notification(); notifSys.add( 'Here is a simple notification' ); Members &lt;static, readonly&gt; ERROR :String Notification error/danger type Type: String &lt;static, readonly&gt; INFO :String Notification information type Type: String &lt;static, readonly&gt; SUCCESS :String Notification success type Type: String &lt;static, readonly&gt; WARNING :String Notification warning type Type: String Methods add(html, type [, notificationOptions]) Add a new notification. Parameters: Name Type Argument Description html String type String notificationOptions Object &lt;optional&gt; Properties Name Type Argument Description closeDelay Number | false &lt;optional&gt; In second or False onClick function &lt;optional&gt; addDanger(html [, notificationOptions]) Add a new error/danger notification. Parameters: Name Type Argument Description html String notificationOptions Object &lt;optional&gt; Properties Name Type Argument Description closeDelay Number | false &lt;optional&gt; In second or False onClick function &lt;optional&gt; addInfo(html [, notificationOptions]) Add a new information notification. Parameters: Name Type Argument Description html String notificationOptions Object &lt;optional&gt; Properties Name Type Argument Description closeDelay Number | false &lt;optional&gt; In second or False onClick function &lt;optional&gt; addSuccess(html [, notificationOptions]) Add a new success notification. Parameters: Name Type Argument Description html String notificationOptions Object &lt;optional&gt; Properties Name Type Argument Description closeDelay Number | false &lt;optional&gt; In second or False onClick function &lt;optional&gt; addWarning(html [, notificationOptions]) Add a new warning notification. Parameters: Name Type Argument Description html String notificationOptions Object &lt;optional&gt; Properties Name Type Argument Description closeDelay Number | false &lt;optional&gt; In second or False onClick function &lt;optional&gt; clean() Close all notifications and remove all containers closeAll() Close all notifications × 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 Notifications Classes Classes Notifications × 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 Notifications × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"Notifications.html":{"id":"Notifications.html","title":"Class: Notifications","body":" Documentation Classes Notifications Class: Notifications Notifications new Notifications( [userOptions]) Manages a list of notifications Parameters: Name Type Argument Description userOptions Object &lt;optional&gt; Properties Name Type Argument Default Description $wrapper HTMLElement &lt;optional&gt; document.body onClick function &lt;optional&gt; autoCloseDelay Number &lt;optional&gt; 5 In second templates Object &lt;optional&gt; Properties Name Type Argument Default Description notifications String &lt;optional&gt; &lt;div class=\"notifications\"&gt;&lt;div class=\"list\"&gt;&lt;/div&gt;&lt;/div&gt; notification String &lt;optional&gt; &lt;div class=\"notification\"&gt;&lt;/div&gt; selectors Object &lt;optional&gt; Properties Name Type Argument Default Description notifications String &lt;optional&gt; .notifications list String &lt;optional&gt; .list notification String &lt;optional&gt; .notification cssClass Object &lt;optional&gt; Properties Name Type Argument Default Description open String &lt;optional&gt; open success String &lt;optional&gt; success danger String &lt;optional&gt; danger warning String &lt;optional&gt; warning info String &lt;optional&gt; info animations Object &lt;optional&gt; Properties Name Type Argument Description show function &lt;optional&gt; ($notification, options) =&gt; Promise hide function &lt;optional&gt; ($notification, options) =&gt; Promise Example let notifSys = new Notification(); notifSys.add( 'Here is a simple notification' ); Members &lt;static, readonly&gt; ERROR :String Notification error/danger type Type: String &lt;static, readonly&gt; INFO :String Notification information type Type: String &lt;static, readonly&gt; SUCCESS :String Notification success type Type: String &lt;static, readonly&gt; WARNING :String Notification warning type Type: String Methods add(html, type [, notificationOptions]) Add a new notification. Parameters: Name Type Argument Description html String type String notificationOptions Object &lt;optional&gt; Properties Name Type Argument Description closeDelay Number | false &lt;optional&gt; In second or False onClick function &lt;optional&gt; addDanger(html [, notificationOptions]) Add a new error/danger notification. Parameters: Name Type Argument Description html String notificationOptions Object &lt;optional&gt; Properties Name Type Argument Description closeDelay Number | false &lt;optional&gt; In second or False onClick function &lt;optional&gt; addInfo(html [, notificationOptions]) Add a new information notification. Parameters: Name Type Argument Description html String notificationOptions Object &lt;optional&gt; Properties Name Type Argument Description closeDelay Number | false &lt;optional&gt; In second or False onClick function &lt;optional&gt; addSuccess(html [, notificationOptions]) Add a new success notification. Parameters: Name Type Argument Description html String notificationOptions Object &lt;optional&gt; Properties Name Type Argument Description closeDelay Number | false &lt;optional&gt; In second or False onClick function &lt;optional&gt; addWarning(html [, notificationOptions]) Add a new warning notification. Parameters: Name Type Argument Description html String notificationOptions Object &lt;optional&gt; Properties Name Type Argument Description closeDelay Number | false &lt;optional&gt; In second or False onClick function &lt;optional&gt; clean() Close all notifications and remove all containers closeAll() Close all notifications × 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/popin/Popin.html

@@ -3000,7 +3000,7 @@ popin.load( &#x27;my-url.html&#x27;, {method: &#x27;post&#x27;} );</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: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/popin/PopinController.html

@@ -1370,7 +1370,7 @@ popin.loadForm( $form );</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:09+02:00
+		on 2021-02-03T15:24:32+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

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

@@ -198,7 +198,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/popin/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/popin/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 PopinPopinController Classes Classes Popin PopinController × 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 PopinPopinController × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:09+02:00 using the DocStrap template. "},"Popin.html":{"id":"Popin.html","title":"Class: Popin","body":" Documentation Classes PopinPopinController Class: Popin Popin new Popin(userOptions) Create a simple popin Parameters: Name Type Description userOptions Object Properties Name Type Argument Default Description modal Boolean &lt;optional&gt; false marginHeight Number &lt;optional&gt; 20 autoResize Boolean &lt;optional&gt; false errorMessage String &lt;optional&gt; Error while loading... enableKeyboard Boolean &lt;optional&gt; true onOpen Callback &lt;optional&gt; $popin =&gt; {} onClose Callback &lt;optional&gt; $popin =&gt; {} onLoad Callback &lt;optional&gt; $popin =&gt; Promise.resolve() setLinkResponseType function &lt;optional&gt; ( url, $link ) =&gt; 'text' Must return one of these values: arrayBuffer | blob | json | text | formData setFormResponseType function &lt;optional&gt; $form =&gt; 'text' Must return one of these values: arrayBuffer | blob | json | text | formData checkValidity function &lt;optional&gt; $form =&gt; true Must return true, false or a promise normalize function &lt;optional&gt; (body, response, isHttpError) =&gt; { return { success: true, data: body } } autoHandleAjaxError function &lt;optional&gt; true If false, ajax http error (404, 500, ...) should be handled in the normalize function templates Object &lt;optional&gt; Properties Name Type Argument Default Description popinLoader String &lt;optional&gt; &lt;div class=\\\"popin-loader\\\"&gt;&lt;/div&gt; popin String &lt;optional&gt; &lt;div class=\\\"popin\\\"&gt;&lt;div class=\\\"popin-content\\\"&gt;&lt;/div&gt;&lt;/div&gt; bgLayer String &lt;optional&gt; &lt;div class=\\\"bg-popin\\\"&gt;&lt;/div&gt; errorMessage String &lt;optional&gt; &lt;div class=\\\"error\\\"&gt;&lt;%= message %&gt;&lt;/div&gt; selectors Object &lt;optional&gt; Properties Name Type Argument Default Description popin String &lt;optional&gt; .popin popinContent String &lt;optional&gt; .popin-content links String &lt;optional&gt; a[data-popin] forms String &lt;optional&gt; form[data-popin] btClosePopin String &lt;optional&gt; button[data-close-popin] openOnLoadAttribute String &lt;optional&gt; data-onload-popin\" animations Object &lt;optional&gt; All functions return a promise Properties Name Type Argument Default Description openBg function &lt;optional&gt; $bg =&gt; { $bg.style.display = 'block'; return Promise.resolve(); } closeBg function &lt;optional&gt; $bg =&gt; { $bg.style.display = 'none'; return Promise.resolve(); } initOpenPopin function &lt;optional&gt; $popin =&gt; { $popin.style.display = 'block'; $popin.style.opacity = 0; return Promise.resolve(); } openPopin function &lt;optional&gt; $popin =&gt; { $popin.style.opacity = 1; return Promise.resolve(); } closePopin function &lt;optional&gt; $popin =&gt; { $popin.style.display = 'none'; return Promise.resolve(); } openLoader function &lt;optional&gt; $loader =&gt; { $loader.style.display = 'block'; return Promise.resolve(); } closeLoader function &lt;optional&gt; $loader =&gt; { $loader.style.display = 'none'; return Promise.resolve(); } See: extra/modules/popin.md for details. Example let popin = new Popin( popinOptions ); popin.load( 'my-url.html', {method: 'post'} ); Methods clear() Remove the content of the popin Returns: Type Promise close() Close the popin Returns: Type Promise closeLoading() Close the popin loading Returns: Type Promise destroy() Remove all events, css class or inline styles load(url, data [, type]) Load a file and display it in the popin Parameters: Name Type Argument Default Description url String data Object All parameters available for window.fetch type String &lt;optional&gt; text Returns: Type Promise loadForm($form) Send a form and display the result it in the popin Parameters: Name Type Description $form HTMLElement Returns: Type Promise loadLink($link) Load a page from a link and display the result it in the popin Parameters: Name Type Description $link HTMLElement Returns: Type Promise open() Open the popin Returns: Type Promise openLoading() Open the popin loading Returns: Type Promise set(html, openFirst) Insert some html in the popin and open it Parameters: Name Type Description html String openFirst Boolean Open the popin THEN insert the html Returns: Type Promise × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:09+02:00 using the DocStrap template. "},"PopinController.html":{"id":"PopinController.html","title":"Class: PopinController","body":" Documentation Classes PopinPopinController Class: PopinController PopinController new PopinController(userOptions) Create a controller tha manage all popin in the page Parameters: Name Type Description userOptions Object Same options like the Popin class See: extra/modules/popin.md for details. Example let controller = new PopinController( popinOptions ); popin.loadForm( $form ); Methods clear() Remove the content of the popin Returns: Type Promise close() Close the popin Returns: Type Promise destroy() Remove all events, css class or inline styles load(url, data [, type]) Load a file and display it in the popin Parameters: Name Type Argument Default Description url String data Object All parameters available for window.fetch type String &lt;optional&gt; text Returns: Type Promise loadForm($form) Send a form and display the result it in the popin Parameters: Name Type Description $form HTMLElement Returns: Type Promise loadLink($link) Load a page from a link and display the result it in the popin Parameters: Name Type Description $link HTMLElement Returns: Type Promise open() Open the popin Returns: Type Promise set(html, openFirst) Insert some html in the popin and open it Parameters: Name Type Description html String openFirst Boolean Open the popin THEN insert the html Returns: Type Promise × 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 PopinPopinController Classes Classes Popin PopinController × 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 PopinPopinController × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"Popin.html":{"id":"Popin.html","title":"Class: Popin","body":" Documentation Classes PopinPopinController Class: Popin Popin new Popin(userOptions) Create a simple popin Parameters: Name Type Description userOptions Object Properties Name Type Argument Default Description modal Boolean &lt;optional&gt; false marginHeight Number &lt;optional&gt; 20 autoResize Boolean &lt;optional&gt; false errorMessage String &lt;optional&gt; Error while loading... enableKeyboard Boolean &lt;optional&gt; true onOpen Callback &lt;optional&gt; $popin =&gt; {} onClose Callback &lt;optional&gt; $popin =&gt; {} onLoad Callback &lt;optional&gt; $popin =&gt; Promise.resolve() setLinkResponseType function &lt;optional&gt; ( url, $link ) =&gt; 'text' Must return one of these values: arrayBuffer | blob | json | text | formData setFormResponseType function &lt;optional&gt; $form =&gt; 'text' Must return one of these values: arrayBuffer | blob | json | text | formData checkValidity function &lt;optional&gt; $form =&gt; true Must return true, false or a promise normalize function &lt;optional&gt; (body, response, isHttpError) =&gt; { return { success: true, data: body } } autoHandleAjaxError function &lt;optional&gt; true If false, ajax http error (404, 500, ...) should be handled in the normalize function templates Object &lt;optional&gt; Properties Name Type Argument Default Description popinLoader String &lt;optional&gt; &lt;div class=\\\"popin-loader\\\"&gt;&lt;/div&gt; popin String &lt;optional&gt; &lt;div class=\\\"popin\\\"&gt;&lt;div class=\\\"popin-content\\\"&gt;&lt;/div&gt;&lt;/div&gt; bgLayer String &lt;optional&gt; &lt;div class=\\\"bg-popin\\\"&gt;&lt;/div&gt; errorMessage String &lt;optional&gt; &lt;div class=\\\"error\\\"&gt;&lt;%= message %&gt;&lt;/div&gt; selectors Object &lt;optional&gt; Properties Name Type Argument Default Description popin String &lt;optional&gt; .popin popinContent String &lt;optional&gt; .popin-content links String &lt;optional&gt; a[data-popin] forms String &lt;optional&gt; form[data-popin] btClosePopin String &lt;optional&gt; button[data-close-popin] openOnLoadAttribute String &lt;optional&gt; data-onload-popin\" animations Object &lt;optional&gt; All functions return a promise Properties Name Type Argument Default Description openBg function &lt;optional&gt; $bg =&gt; { $bg.style.display = 'block'; return Promise.resolve(); } closeBg function &lt;optional&gt; $bg =&gt; { $bg.style.display = 'none'; return Promise.resolve(); } initOpenPopin function &lt;optional&gt; $popin =&gt; { $popin.style.display = 'block'; $popin.style.opacity = 0; return Promise.resolve(); } openPopin function &lt;optional&gt; $popin =&gt; { $popin.style.opacity = 1; return Promise.resolve(); } closePopin function &lt;optional&gt; $popin =&gt; { $popin.style.display = 'none'; return Promise.resolve(); } openLoader function &lt;optional&gt; $loader =&gt; { $loader.style.display = 'block'; return Promise.resolve(); } closeLoader function &lt;optional&gt; $loader =&gt; { $loader.style.display = 'none'; return Promise.resolve(); } See: extra/modules/popin.md for details. Example let popin = new Popin( popinOptions ); popin.load( 'my-url.html', {method: 'post'} ); Methods clear() Remove the content of the popin Returns: Type Promise close() Close the popin Returns: Type Promise closeLoading() Close the popin loading Returns: Type Promise destroy() Remove all events, css class or inline styles load(url, data [, type]) Load a file and display it in the popin Parameters: Name Type Argument Default Description url String data Object All parameters available for window.fetch type String &lt;optional&gt; text Returns: Type Promise loadForm($form) Send a form and display the result it in the popin Parameters: Name Type Description $form HTMLElement Returns: Type Promise loadLink($link) Load a page from a link and display the result it in the popin Parameters: Name Type Description $link HTMLElement Returns: Type Promise open() Open the popin Returns: Type Promise openLoading() Open the popin loading Returns: Type Promise set(html, openFirst) Insert some html in the popin and open it Parameters: Name Type Description html String openFirst Boolean Open the popin THEN insert the html Returns: Type Promise × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"PopinController.html":{"id":"PopinController.html","title":"Class: PopinController","body":" Documentation Classes PopinPopinController Class: PopinController PopinController new PopinController(userOptions) Create a controller tha manage all popin in the page Parameters: Name Type Description userOptions Object Same options like the Popin class See: extra/modules/popin.md for details. Example let controller = new PopinController( popinOptions ); popin.loadForm( $form ); Methods clear() Remove the content of the popin Returns: Type Promise close() Close the popin Returns: Type Promise destroy() Remove all events, css class or inline styles load(url, data [, type]) Load a file and display it in the popin Parameters: Name Type Argument Default Description url String data Object All parameters available for window.fetch type String &lt;optional&gt; text Returns: Type Promise loadForm($form) Send a form and display the result it in the popin Parameters: Name Type Description $form HTMLElement Returns: Type Promise loadLink($link) Load a page from a link and display the result it in the popin Parameters: Name Type Description $link HTMLElement Returns: Type Promise open() Open the popin Returns: Type Promise set(html, openFirst) Insert some html in the popin and open it Parameters: Name Type Description html String openFirst Boolean Open the popin THEN insert the html Returns: Type Promise × 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/modules/scroll-snap/ScrollSnap.html

@@ -2380,7 +2380,7 @@ sn.clean()</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: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/scroll-snap/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/scroll-snap/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/scroll-snap/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 ScrollSnap Classes Classes ScrollSnap × 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 ScrollSnap × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:09+02:00 using the DocStrap template. "},"ScrollSnap.html":{"id":"ScrollSnap.html","title":"Class: ScrollSnap","body":" Documentation Classes ScrollSnap Class: ScrollSnap ScrollSnap new ScrollSnap($scroller, options) Allow to snap to items when using a native scroll Parameters: Name Type Description $scroller Object options Object Properties Name Type Argument Default Description lockedClass String &lt;optional&gt; locked direction String &lt;optional&gt; h Values: 'h' | 'v' snapTo String | Array.&lt;HTMLElement&gt; &lt;optional&gt; minItemsToActivate number &lt;optional&gt; 2 $offsetElement HTMLElement &lt;optional&gt; offset Object &lt;optional&gt; Properties Name Type Argument Description top Number &lt;optional&gt; left Number &lt;optional&gt; onSnapStart ScrollSnap_Handler &lt;optional&gt; onSnapEnd ScrollSnap_Handler &lt;optional&gt; onReachStart ScrollSnap_Handler &lt;optional&gt; onReachEnd ScrollSnap_Handler &lt;optional&gt; _setScroll function &lt;optional&gt; Internal function using GSAP and scrollTo plugin to set the scroll. Can be override to use another library Example let sn = new ScrollSnap($scroller, options); // To refresh sn.refresh( [options] ) // To navigate sn.previous( [duration] ) sn.next( [duration] ) sn.scrollToItem( $item [, duration] ) sn.scrollToIndex( index [, duration] ) // To remove sn.clean() Methods clean() Remove all events, css class or inline styles next( [duration]) Scroll to the next item Parameters: Name Type Argument Description duration Number &lt;optional&gt; In ms previous( [duration]) Scroll to the previous item Parameters: Name Type Argument Description duration Number &lt;optional&gt; In ms refresh( [options]) Refresh the scroller and snap to the asked item Parameters: Name Type Argument Description options Object &lt;optional&gt; Properties Name Type Argument Description snapTo Array.&lt;HTMLElement&gt; | string Selector or DOMList of the items $itemToSnapOn HTMLElement &lt;optional&gt; Item to put on the left $offsetElement HTMLElement &lt;optional&gt; offset Object &lt;optional&gt; Properties Name Type Argument Description top Number &lt;optional&gt; left Number &lt;optional&gt; direction String &lt;optional&gt; Values: 'h' | 'v' scrollToIndex(index [, duration]) Scroll to a specific index Parameters: Name Type Argument Description index Number duration Number &lt;optional&gt; In ms scrollToItem($item [, duration]) Scroll to a specific item Parameters: Name Type Argument Description $item HTMLElement duration Number &lt;optional&gt; In ms Type Definitions ScrollSnap_Handler(data) Parameters: Name Type Description data Object Properties Name Type Description $scroller HTMLElement item Object Properties Name Type Description index number $item HTMLElement coords number type string If the event comes after a scroll: scroll. If it comes after a function call (like next, previous, ...): api. scrollerSize number offsetSize number × 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 ScrollSnap Classes Classes ScrollSnap × 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 ScrollSnap × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"ScrollSnap.html":{"id":"ScrollSnap.html","title":"Class: ScrollSnap","body":" Documentation Classes ScrollSnap Class: ScrollSnap ScrollSnap new ScrollSnap($scroller, options) Allow to snap to items when using a native scroll Parameters: Name Type Description $scroller Object options Object Properties Name Type Argument Default Description lockedClass String &lt;optional&gt; locked direction String &lt;optional&gt; h Values: 'h' | 'v' snapTo String | Array.&lt;HTMLElement&gt; &lt;optional&gt; minItemsToActivate number &lt;optional&gt; 2 $offsetElement HTMLElement &lt;optional&gt; offset Object &lt;optional&gt; Properties Name Type Argument Description top Number &lt;optional&gt; left Number &lt;optional&gt; onSnapStart ScrollSnap_Handler &lt;optional&gt; onSnapEnd ScrollSnap_Handler &lt;optional&gt; onReachStart ScrollSnap_Handler &lt;optional&gt; onReachEnd ScrollSnap_Handler &lt;optional&gt; _setScroll function &lt;optional&gt; Internal function using GSAP and scrollTo plugin to set the scroll. Can be override to use another library Example let sn = new ScrollSnap($scroller, options); // To refresh sn.refresh( [options] ) // To navigate sn.previous( [duration] ) sn.next( [duration] ) sn.scrollToItem( $item [, duration] ) sn.scrollToIndex( index [, duration] ) // To remove sn.clean() Methods clean() Remove all events, css class or inline styles next( [duration]) Scroll to the next item Parameters: Name Type Argument Description duration Number &lt;optional&gt; In ms previous( [duration]) Scroll to the previous item Parameters: Name Type Argument Description duration Number &lt;optional&gt; In ms refresh( [options]) Refresh the scroller and snap to the asked item Parameters: Name Type Argument Description options Object &lt;optional&gt; Properties Name Type Argument Description snapTo Array.&lt;HTMLElement&gt; | string Selector or DOMList of the items $itemToSnapOn HTMLElement &lt;optional&gt; Item to put on the left $offsetElement HTMLElement &lt;optional&gt; offset Object &lt;optional&gt; Properties Name Type Argument Description top Number &lt;optional&gt; left Number &lt;optional&gt; direction String &lt;optional&gt; Values: 'h' | 'v' scrollToIndex(index [, duration]) Scroll to a specific index Parameters: Name Type Argument Description index Number duration Number &lt;optional&gt; In ms scrollToItem($item [, duration]) Scroll to a specific item Parameters: Name Type Argument Description $item HTMLElement duration Number &lt;optional&gt; In ms Type Definitions ScrollSnap_Handler(data) Parameters: Name Type Description data Object Properties Name Type Description $scroller HTMLElement item Object Properties Name Type Description index number $item HTMLElement coords number type string If the event comes after a scroll: scroll. If it comes after a function call (like next, previous, ...): api. scrollerSize number offsetSize number × 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/slider/Slider.html

@@ -3684,7 +3684,7 @@ promise = slider.previous();</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:09+02:00
+		on 2021-02-03T15:24:32+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/slider/SliderControls.html

@@ -593,7 +593,8 @@
      "paginationItems": '.item',
      "autoslide": 10, // in second
      "swipe": false,
-     "enableKeyboard": true
+     "enableKeyboard": true,
+     "gestureOptions": Object
  }
 );</pre>
 
@@ -1380,6 +1381,162 @@
         
 
     
+</dd>
+
+        
+            
+<hr>
+<dt>
+    <h4 class="name" id="startAutoslide"><span class="type-signature"></span>startAutoslide()</h4>
+    
+    
+</dt>
+<dd>
+
+    
+    <div class="description">
+        Start the autoslide
+    </div>
+    
+
+    
+
+    
+
+    
+    
+
+    
+<dl class="details">
+    
+
+	
+
+	
+
+	
+
+    
+
+    
+
+    
+
+    
+
+	
+
+	
+
+	
+
+	
+
+	
+
+
+
+	
+
+	
+
+	
+
+	
+</dl>
+
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+</dd>
+
+        
+            
+<hr>
+<dt>
+    <h4 class="name" id="startAutoslide"><span class="type-signature"></span>startAutoslide()</h4>
+    
+    
+</dt>
+<dd>
+
+    
+    <div class="description">
+        Stop the autoslide
+    </div>
+    
+
+    
+
+    
+
+    
+    
+
+    
+<dl class="details">
+    
+
+	
+
+	
+
+	
+
+    
+
+    
+
+    
+
+    
+
+	
+
+	
+
+	
+
+	
+
+	
+
+
+
+	
+
+	
+
+	
+
+	
+</dl>
+
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
 </dd>
 
         </dl>
@@ -1432,7 +1589,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:32+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

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

@@ -894,7 +894,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:32+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/slider/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:09+02:00
+		on 2021-02-03T15:24:32+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/slider/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 SliderSliderControls Events Slider#event:afterSlider#event:afterEachSlider#event:beforeSlider#event:beforeEachSlider#event:start Classes Classes Slider SliderControls Events after After starting to move. Only one time for the whole animation. Type: Object Properties: Name Type Description data SlideEventData_Params afterEach After each slide move. If moving for 3 slides, it will be called 3 times. Type: Object Properties: Name Type Description data SlideEventData_Params before Before starting to move. Only one time for the whole animation. Type: Object Properties: Name Type Description data SlideEventData_Params beforeEach Before each slide move. If moving for 3 slides, it will be called 3 times. Type: Object Properties: Name Type Description data SlideEventData_Params start On the initialization of the slider Type: Object Properties: Name Type Description data SlideEventData_Params Only currentSlide property × 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 SliderSliderControls Events Slider#event:afterSlider#event:afterEachSlider#event:beforeSlider#event:beforeEachSlider#event:start × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:09+02:00 using the DocStrap template. "},"Slider.html":{"id":"Slider.html","title":"Class: Slider","body":" Documentation Classes SliderSliderControls Events Slider#event:afterSlider#event:afterEachSlider#event:beforeSlider#event:beforeEachSlider#event:start Class: Slider Slider new Slider($slider [, userOptions]) Slider Parameters: Name Type Argument Description $slider HTMLElement userOptions Object &lt;optional&gt; Properties Name Type Argument Default Description startSlide Number &lt;optional&gt; 0 nbSlideVisibleBefore Number &lt;optional&gt; 0 nbSlideVisibleAfter Number &lt;optional&gt; 0 slidePerPage Number &lt;optional&gt; 1 moveByPage Boolean &lt;optional&gt; true speed Number &lt;optional&gt; 0.5 In second listSelector String &lt;optional&gt; .list itemsSelector String &lt;optional&gt; .item activeClass String &lt;optional&gt; active-slide loop Boolean &lt;optional&gt; true smoothHeight Boolean &lt;optional&gt; true onBefore Callback &lt;optional&gt; data =&gt; {} Called one time at the begining of the animation onBeforeEach Callback &lt;optional&gt; data =&gt; {} Called for every slide that will come in the 1st position during the animation onAfter Callback &lt;optional&gt; data =&gt; {} Called one time at the end of the animation onAfterEach Callback &lt;optional&gt; data =&gt; {} Called for every slide that is came in the 1st position during the animation onStart Callback &lt;optional&gt; data =&gt; {} Called one time at the initialisation of the slider options._setStyle function &lt;optional&gt; Internal function using GSAP to set CSS styles. Can be override to use another library options._tweenTo function &lt;optional&gt; Internal function using GSAP to tween element. Can be override to use another library options._tweenFromTo function &lt;optional&gt; Internal function using GSAP to initialize and tween element. Can be override to use another library options._killTweens function &lt;optional&gt; Internal function using GSAP to remove tweens from element. Can be override to use another library See: extra/modules/slider.md Example let slider = new Slider( $slider, options ); promise = slider.previous(); Members $list :HTMLElement Wrapper of the slides Type: HTMLElement $slider :HTMLElement The DOM element of the slider Type: HTMLElement $slides :Array.&lt;HTMLElement&gt; All slides Type: Array.&lt;HTMLElement&gt; bulletCount :Number Number of bullet needed in a pager Type: Number pageCount :Number Number of pages (can have several slides by page) Type: Number slideCount :Number Number of slides Type: Number Methods destroy() Remove all events, css class or inline styles getCurrentSlide() Get the current active slide Returns: Type Slide getSlide(index) Get a slide in function of an index Parameters: Name Type Description index Number Returns: Type Slide goTo(page [, $button]) Go to the asked slide or page Parameters: Name Type Argument Description page Number $button HTMLElement &lt;optional&gt; Internal use only Returns: Type Promise isEnabled() Check if the slider is enable or not Returns: Type Boolean next( [$button]) Go to the next slide or page Parameters: Name Type Argument Description $button HTMLElement &lt;optional&gt; Internal use only Returns: Type Promise previous( [$button]) Go to the previous slide or page Parameters: Name Type Argument Description $button HTMLElement &lt;optional&gt; Internal use only Returns: Type Promise Type Definitions Slide Type: object Properties: Name Type Description $slide HTMLElement id String delay Number In seconds index Number position Number (= index + 1) isFirst Boolean isLast Boolean isVisible Boolean isActive Boolean SlideEventData_Params Type: Object Properties: Name Type Description targetSlide Slide currentSlide Slide direction Number 1 = next, -1 = previous Events after After starting to move. Only one time for the whole animation. Type: Object Properties: Name Type Description data SlideEventData_Params afterEach After each slide move. If moving for 3 slides, it will be called 3 times. Type: Object Properties: Name Type Description data SlideEventData_Params before Before starting to move. Only one time for the whole animation. Type: Object Properties: Name Type Description data SlideEventData_Params beforeEach Before each slide move. If moving for 3 slides, it will be called 3 times. Type: Object Properties: Name Type Description data SlideEventData_Params start On the initialization of the slider Type: Object Properties: Name Type Description data SlideEventData_Params Only currentSlide property × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:09+02:00 using the DocStrap template. "},"SliderControls.html":{"id":"SliderControls.html","title":"Class: SliderControls","body":" Documentation Classes SliderSliderControls Events Slider#event:afterSlider#event:afterEachSlider#event:beforeSlider#event:beforeEachSlider#event:start Class: SliderControls SliderControls new SliderControls(slider, userOptions) Controls of a slider Parameters: Name Type Description slider Slider userOptions Object Properties Name Type Argument Default Description $btPrev HTMLElement &lt;optional&gt; $btNext HTMLElement &lt;optional&gt; $pagination HTMLElement &lt;optional&gt; paginationItems String &lt;optional&gt; autoslide Number &lt;optional&gt; In second swipe Boolean &lt;optional&gt; false enableKeyboard Boolean &lt;optional&gt; false gestureOptions Object &lt;optional&gt; See gesture module options See: extra/modules/slider.md Example let controls = new SliderControls( slider, { \"$btPrev\": $previousButtton, \"$btNext\": $nextButton, \"$pagination\": $pagination, \"paginationItems\": '.item', \"autoslide\": 10, // in second \"swipe\": false, \"enableKeyboard\": true } ); Members slider :Slider Controlled slider Type: Slider Methods destroy() Destroy the slider and its controls goTo(index [, $button]) Go to the asked slide or page Parameters: Name Type Argument Description index Number $button DOMElement &lt;optional&gt; Internal use Returns: Type Promise isEnabled() Check if the slider is enable or not Returns: Type Boolean next( [$button]) Go to the next slide or page Parameters: Name Type Argument Description $button DOMElement &lt;optional&gt; Internal use Returns: Type Promise previous( [$button]) Go to the previous slide or page Parameters: Name Type Argument Description $button DOMElement &lt;optional&gt; Internal use Returns: Type Promise × 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 SliderSliderControls Events Slider#event:afterSlider#event:afterEachSlider#event:beforeSlider#event:beforeEachSlider#event:start Classes Classes Slider SliderControls Events after After starting to move. Only one time for the whole animation. Type: Object Properties: Name Type Description data SlideEventData_Params afterEach After each slide move. If moving for 3 slides, it will be called 3 times. Type: Object Properties: Name Type Description data SlideEventData_Params before Before starting to move. Only one time for the whole animation. Type: Object Properties: Name Type Description data SlideEventData_Params beforeEach Before each slide move. If moving for 3 slides, it will be called 3 times. Type: Object Properties: Name Type Description data SlideEventData_Params start On the initialization of the slider Type: Object Properties: Name Type Description data SlideEventData_Params Only currentSlide property × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes SliderSliderControls Events Slider#event:afterSlider#event:afterEachSlider#event:beforeSlider#event:beforeEachSlider#event:start × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"Slider.html":{"id":"Slider.html","title":"Class: Slider","body":" Documentation Classes SliderSliderControls Events Slider#event:afterSlider#event:afterEachSlider#event:beforeSlider#event:beforeEachSlider#event:start Class: Slider Slider new Slider($slider [, userOptions]) Slider Parameters: Name Type Argument Description $slider HTMLElement userOptions Object &lt;optional&gt; Properties Name Type Argument Default Description startSlide Number &lt;optional&gt; 0 nbSlideVisibleBefore Number &lt;optional&gt; 0 nbSlideVisibleAfter Number &lt;optional&gt; 0 slidePerPage Number &lt;optional&gt; 1 moveByPage Boolean &lt;optional&gt; true speed Number &lt;optional&gt; 0.5 In second listSelector String &lt;optional&gt; .list itemsSelector String &lt;optional&gt; .item activeClass String &lt;optional&gt; active-slide loop Boolean &lt;optional&gt; true smoothHeight Boolean &lt;optional&gt; true onBefore Callback &lt;optional&gt; data =&gt; {} Called one time at the begining of the animation onBeforeEach Callback &lt;optional&gt; data =&gt; {} Called for every slide that will come in the 1st position during the animation onAfter Callback &lt;optional&gt; data =&gt; {} Called one time at the end of the animation onAfterEach Callback &lt;optional&gt; data =&gt; {} Called for every slide that is came in the 1st position during the animation onStart Callback &lt;optional&gt; data =&gt; {} Called one time at the initialisation of the slider options._setStyle function &lt;optional&gt; Internal function using GSAP to set CSS styles. Can be override to use another library options._tweenTo function &lt;optional&gt; Internal function using GSAP to tween element. Can be override to use another library options._tweenFromTo function &lt;optional&gt; Internal function using GSAP to initialize and tween element. Can be override to use another library options._killTweens function &lt;optional&gt; Internal function using GSAP to remove tweens from element. Can be override to use another library See: extra/modules/slider.md Example let slider = new Slider( $slider, options ); promise = slider.previous(); Members $list :HTMLElement Wrapper of the slides Type: HTMLElement $slider :HTMLElement The DOM element of the slider Type: HTMLElement $slides :Array.&lt;HTMLElement&gt; All slides Type: Array.&lt;HTMLElement&gt; bulletCount :Number Number of bullet needed in a pager Type: Number pageCount :Number Number of pages (can have several slides by page) Type: Number slideCount :Number Number of slides Type: Number Methods destroy() Remove all events, css class or inline styles getCurrentSlide() Get the current active slide Returns: Type Slide getSlide(index) Get a slide in function of an index Parameters: Name Type Description index Number Returns: Type Slide goTo(page [, $button]) Go to the asked slide or page Parameters: Name Type Argument Description page Number $button HTMLElement &lt;optional&gt; Internal use only Returns: Type Promise isEnabled() Check if the slider is enable or not Returns: Type Boolean next( [$button]) Go to the next slide or page Parameters: Name Type Argument Description $button HTMLElement &lt;optional&gt; Internal use only Returns: Type Promise previous( [$button]) Go to the previous slide or page Parameters: Name Type Argument Description $button HTMLElement &lt;optional&gt; Internal use only Returns: Type Promise Type Definitions Slide Type: object Properties: Name Type Description $slide HTMLElement id String delay Number In seconds index Number position Number (= index + 1) isFirst Boolean isLast Boolean isVisible Boolean isActive Boolean SlideEventData_Params Type: Object Properties: Name Type Description targetSlide Slide currentSlide Slide direction Number 1 = next, -1 = previous Events after After starting to move. Only one time for the whole animation. Type: Object Properties: Name Type Description data SlideEventData_Params afterEach After each slide move. If moving for 3 slides, it will be called 3 times. Type: Object Properties: Name Type Description data SlideEventData_Params before Before starting to move. Only one time for the whole animation. Type: Object Properties: Name Type Description data SlideEventData_Params beforeEach Before each slide move. If moving for 3 slides, it will be called 3 times. Type: Object Properties: Name Type Description data SlideEventData_Params start On the initialization of the slider Type: Object Properties: Name Type Description data SlideEventData_Params Only currentSlide property × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"SliderControls.html":{"id":"SliderControls.html","title":"Class: SliderControls","body":" Documentation Classes SliderSliderControls Events Slider#event:afterSlider#event:afterEachSlider#event:beforeSlider#event:beforeEachSlider#event:start Class: SliderControls SliderControls new SliderControls(slider, userOptions) Controls of a slider Parameters: Name Type Description slider Slider userOptions Object Properties Name Type Argument Default Description $btPrev HTMLElement &lt;optional&gt; $btNext HTMLElement &lt;optional&gt; $pagination HTMLElement &lt;optional&gt; paginationItems String &lt;optional&gt; autoslide Number &lt;optional&gt; In second swipe Boolean &lt;optional&gt; false enableKeyboard Boolean &lt;optional&gt; false gestureOptions Object &lt;optional&gt; See gesture module options See: extra/modules/slider.md Example let controls = new SliderControls( slider, { \"$btPrev\": $previousButtton, \"$btNext\": $nextButton, \"$pagination\": $pagination, \"paginationItems\": '.item', \"autoslide\": 10, // in second \"swipe\": false, \"enableKeyboard\": true, \"gestureOptions\": Object } ); Members slider :Slider Controlled slider Type: Slider Methods destroy() Destroy the slider and its controls goTo(index [, $button]) Go to the asked slide or page Parameters: Name Type Argument Description index Number $button DOMElement &lt;optional&gt; Internal use Returns: Type Promise isEnabled() Check if the slider is enable or not Returns: Type Boolean next( [$button]) Go to the next slide or page Parameters: Name Type Argument Description $button DOMElement &lt;optional&gt; Internal use Returns: Type Promise previous( [$button]) Go to the previous slide or page Parameters: Name Type Argument Description $button DOMElement &lt;optional&gt; Internal use Returns: Type Promise startAutoslide() Start the autoslide startAutoslide() Stop the autoslide × 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/modules/tabs/Tabs.html

@@ -1208,7 +1208,7 @@ If the tabs are displayed vertically, add aria-orientation="vertical"
 <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/tabs/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/tabs/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/tabs/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 Tabs Classes Classes Tabs × 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 Tabs × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:09+02:00 using the DocStrap template. "},"Tabs.html":{"id":"Tabs.html","title":"Class: Tabs","body":" Documentation Classes Tabs Class: Tabs Tabs new Tabs($tabsWrapper [, userOptions]) Tabs Parameters: Name Type Argument Description $tabsWrapper HTMLElement userOptions Object &lt;optional&gt; Properties Name Type Argument Default Description tabSelector String &lt;optional&gt; 'li[aria-selected]' onOpenAtStart Tabs_callback &lt;optional&gt; onOpen Tabs_callback &lt;optional&gt; onClose Tabs_callback &lt;optional&gt; animations Object &lt;optional&gt; Properties Name Type Argument Description open Tabs_animation &lt;optional&gt; close Tabs_animation &lt;optional&gt; destroy Tabs_animation &lt;optional&gt; Example new Tabs( document.querySelector( '.tabs' ), { \"tabSelector\": \".tab\", \"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=\"tabs\"&gt; &lt;ul role=\"tablist\"&gt; &lt;li role=\"tab\" id=\"tab-1\" tabindex=\"-1\" aria-selected=\"false\" aria-controls=\"panel-1\"&gt;Tab 1&lt;/li&gt; &lt;li role=\"tab\" id=\"tab-2\" tabindex=\"0\" aria-selected=\"true\" aria-controls=\"panel-2\"&gt;Tab 2&lt;/li&gt; &lt;li role=\"tab\" id=\"tab-3\" tabindex=\"-1\" aria-selected=\"false\" aria-controls=\"panel-3\"&gt;Tab 3&lt;/li&gt; &lt;li role=\"tab\" id=\"tab-4\" tabindex=\"-1\" aria-selected=\"false\" aria-controls=\"panel-4\"&gt;Tab 4&lt;/li&gt; &lt;/ul&gt; &lt;div role=\"tabpanel\" id=\"panel-1\" aria-labelledby=\"tab-1\" tabindex=\"0\"&gt; [Content 1] &lt;/div&gt; &lt;div role=\"tabpanel\" id=\"panel-2\" aria-labelledby=\"tab-2\" tabindex=\"0\"&gt; [Content 2 (displayed at start)] &lt;/div&gt; &lt;div role=\"tabpanel\" id=\"panel-3\" aria-labelledby=\"tab-3\" tabindex=\"0\"&gt; [Content 3] &lt;/div&gt; &lt;div role=\"tabpanel\" id=\"panel-4\" aria-labelledby=\"tab-4\" tabindex=\"0\"&gt; [Content 4] &lt;/div&gt; &lt;/div&gt; Set aria-selected to \"true\" and tabindex=\"0\" on the tab you want open at start. If the tabs are displayed vertically, add aria-orientation=\"vertical\" on the role=\"tablist\" element Methods destroy() Remove all events, css class, ... update() Restart the module Type Definitions Tabs_animation($tab, $panel) Parameters: Name Type Description $tab HTMLElement $panel HTMLElement Returns: Type Promise Tabs_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:09+02:00 using the DocStrap template. "}}
+    {"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes Tabs Classes Classes Tabs × 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 Tabs × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:31+01:00 using the DocStrap template. "},"Tabs.html":{"id":"Tabs.html","title":"Class: Tabs","body":" Documentation Classes Tabs Class: Tabs Tabs new Tabs($tabsWrapper [, userOptions]) Tabs Parameters: Name Type Argument Description $tabsWrapper HTMLElement userOptions Object &lt;optional&gt; Properties Name Type Argument Default Description tabSelector String &lt;optional&gt; 'li[aria-selected]' onOpenAtStart Tabs_callback &lt;optional&gt; onOpen Tabs_callback &lt;optional&gt; onClose Tabs_callback &lt;optional&gt; animations Object &lt;optional&gt; Properties Name Type Argument Description open Tabs_animation &lt;optional&gt; close Tabs_animation &lt;optional&gt; destroy Tabs_animation &lt;optional&gt; Example new Tabs( document.querySelector( '.tabs' ), { \"tabSelector\": \".tab\", \"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=\"tabs\"&gt; &lt;ul role=\"tablist\"&gt; &lt;li role=\"tab\" id=\"tab-1\" tabindex=\"-1\" aria-selected=\"false\" aria-controls=\"panel-1\"&gt;Tab 1&lt;/li&gt; &lt;li role=\"tab\" id=\"tab-2\" tabindex=\"0\" aria-selected=\"true\" aria-controls=\"panel-2\"&gt;Tab 2&lt;/li&gt; &lt;li role=\"tab\" id=\"tab-3\" tabindex=\"-1\" aria-selected=\"false\" aria-controls=\"panel-3\"&gt;Tab 3&lt;/li&gt; &lt;li role=\"tab\" id=\"tab-4\" tabindex=\"-1\" aria-selected=\"false\" aria-controls=\"panel-4\"&gt;Tab 4&lt;/li&gt; &lt;/ul&gt; &lt;div role=\"tabpanel\" id=\"panel-1\" aria-labelledby=\"tab-1\" tabindex=\"0\"&gt; [Content 1] &lt;/div&gt; &lt;div role=\"tabpanel\" id=\"panel-2\" aria-labelledby=\"tab-2\" tabindex=\"0\"&gt; [Content 2 (displayed at start)] &lt;/div&gt; &lt;div role=\"tabpanel\" id=\"panel-3\" aria-labelledby=\"tab-3\" tabindex=\"0\"&gt; [Content 3] &lt;/div&gt; &lt;div role=\"tabpanel\" id=\"panel-4\" aria-labelledby=\"tab-4\" tabindex=\"0\"&gt; [Content 4] &lt;/div&gt; &lt;/div&gt; Set aria-selected to \"true\" and tabindex=\"0\" on the tab you want open at start. If the tabs are displayed vertically, add aria-orientation=\"vertical\" on the role=\"tablist\" element Methods destroy() Remove all events, css class, ... update() Restart the module Type Definitions Tabs_animation($tab, $panel) Parameters: Name Type Description $tab HTMLElement $panel HTMLElement Returns: Type Promise Tabs_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/validator/Validator.html

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

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

@@ -202,7 +202,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:32+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/validator/global.html

@@ -2955,7 +2955,7 @@ Use a fallback for browser that doesn't support new URLSearchParams( formData ).
 <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:32+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/modules/validator/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:11+02:00
+		on 2021-02-03T15:24:32+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>