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

package/documentation/jsdocs/dom/index.html

@@ -33,7 +33,7 @@
 			<li class="dropdown">
 				<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
 				<ul class="dropdown-menu ">
-					<li><a href="global.html#aClass">aClass</a></li><li><a href="global.html#append">append</a></li><li><a href="global.html#children">children</a></li><li><a href="global.html#clone">clone</a></li><li><a href="global.html#documentSize">documentSize</a></li><li><a href="global.html#filter">filter</a></li><li><a href="global.html#getMatrix">getMatrix</a></li><li><a href="global.html#getStyle">getStyle</a></li><li><a href="global.html#getTransform">getTransform</a></li><li><a href="global.html#getTranslate">getTranslate</a></li><li><a href="global.html#hClass">hClass</a></li><li><a href="global.html#height">height</a></li><li><a href="global.html#index">index</a></li><li><a href="global.html#insertAfter">insertAfter</a></li><li><a href="global.html#insertBefore">insertBefore</a></li><li><a href="global.html#next">next</a></li><li><a href="global.html#offset">offset</a></li><li><a href="global.html#outerHeight">outerHeight</a></li><li><a href="global.html#outerSize">outerSize</a></li><li><a href="global.html#outerWidth">outerWidth</a></li><li><a href="global.html#pageToDOM">pageToDOM</a></li><li><a href="global.html#position">position</a></li><li><a href="global.html#prepend">prepend</a></li><li><a href="global.html#previous">previous</a></li><li><a href="global.html#prop">prop</a></li><li><a href="global.html#rClass">rClass</a></li><li><a href="global.html#remove">remove</a></li><li><a href="global.html#sClass">sClass</a></li><li><a href="global.html#size">size</a></li><li><a href="global.html#strToDOM">strToDOM</a></li><li><a href="global.html#tClass">tClass</a></li><li><a href="global.html#width">width</a></li><li><a href="global.html#windowScroll">windowScroll</a></li><li><a href="global.html#windowSize">windowSize</a></li><li><a href="global.html#wrap">wrap</a></li>
+					<li><a href="global.html#aClass">aClass</a></li><li><a href="global.html#append">append</a></li><li><a href="global.html#children">children</a></li><li><a href="global.html#clone">clone</a></li><li><a href="global.html#documentSize">documentSize</a></li><li><a href="global.html#filter">filter</a></li><li><a href="global.html#getCssProperty">getCssProperty</a></li><li><a href="global.html#getMatrix">getMatrix</a></li><li><a href="global.html#getStyle">getStyle</a></li><li><a href="global.html#getTransform">getTransform</a></li><li><a href="global.html#getTranslate">getTranslate</a></li><li><a href="global.html#hClass">hClass</a></li><li><a href="global.html#height">height</a></li><li><a href="global.html#index">index</a></li><li><a href="global.html#insertAfter">insertAfter</a></li><li><a href="global.html#insertBefore">insertBefore</a></li><li><a href="global.html#next">next</a></li><li><a href="global.html#offset">offset</a></li><li><a href="global.html#outerHeight">outerHeight</a></li><li><a href="global.html#outerSize">outerSize</a></li><li><a href="global.html#outerWidth">outerWidth</a></li><li><a href="global.html#pageToDOM">pageToDOM</a></li><li><a href="global.html#position">position</a></li><li><a href="global.html#prepend">prepend</a></li><li><a href="global.html#previous">previous</a></li><li><a href="global.html#prop">prop</a></li><li><a href="global.html#rClass">rClass</a></li><li><a href="global.html#remove">remove</a></li><li><a href="global.html#sClass">sClass</a></li><li><a href="global.html#setCssProperty">setCssProperty</a></li><li><a href="global.html#size">size</a></li><li><a href="global.html#strToDOM">strToDOM</a></li><li><a href="global.html#tClass">tClass</a></li><li><a href="global.html#width">width</a></li><li><a href="global.html#windowScroll">windowScroll</a></li><li><a href="global.html#windowSize">windowSize</a></li><li><a href="global.html#wrap">wrap</a></li>
 				</ul>
 			</li>
 			
@@ -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: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/dom/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 aClassappendchildrenclonedocumentSizefiltergetMatrixgetStylegetTransformgetTranslatehClassheightindexinsertAfterinsertBeforenextoffsetouterHeightouterSizeouterWidthpageToDOMpositionprependpreviousproprClassremovesClasssizestrToDOMtClasswidthwindowScrollwindowSizewrap Global Methods aClass($elements, cssClass) Add a class on an element or a list of elements Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; DOM element or array of DOM element cssClass String | Array.&lt;string&gt; Class name, class names separated by space or array of class Returns: Type HTMLElement | Array.&lt;HTMLElement&gt; Example aClass( $elements, cssClass ) append($what, $where) Append a DOM element to an other. Require a polyfill. Parameters: Name Type Description $what HTMLElement $where HTMLElement Returns: - Appened element Type HTMLElement Example append( $what, $where ) children($element) Return all the children of a DOM element Parameters: Name Type Description $element HTMLElement Returns: Type Array.&lt;HTMLElement&gt; Example $elements = children($element) clone($element) Clone a DOM element Parameters: Name Type Description $element HTMLElement Returns: - Cloned element Type HTMLElement Example $clonedElement = clone( $element ) documentSize() Get the current document size Returns: the width and height of the element Type documentSize_Object Example { width, height } = documentSize() filter($elements, selector) Filter a DOM list depending on a selector Parameters: Name Type Description $elements Array.&lt;HTMLElement&gt; selector String Returns: - Filtered list Type Array.&lt;HTMLElement&gt; Example filteredArray = filter( $elements, selector ); getMatrix($elem) Get the matrix of a DOM element Parameters: Name Type Description $elem HTMLElement Returns: - the matrix object Type matrix_Object Example { m11, m21, m31, m41, m12, m22, m32, m42, m13, m23, m33, m43, m14, m24, m34, m44 } = getMatrix ( $elem ) getStyle($element) Return the style of a DOM element Parameters: Name Type Description $element HTMLElement Returns: Type Object Example styles = getStyle($element) getTransform($elem) Get the transform values of a DOM element Parameters: Name Type Description $elem HTMLElement Returns: - the transform properties Type transform_Object Example { tx, ty, tz, rx, ry, rz } = getTransform ( $elem ) getTranslate($elem) Get the translation values of a DOM element Parameters: Name Type Description $elem HTMLElement Returns: - the translate properties Type translate_Object Example { tx, ty, tz } = getTranslate ( $elem ) hClass($element, cssClass) Check if a class is present on a DOM element Parameters: Name Type Description $element HTMLElement DOM element cssClass String Returns: - true if a class is present on a DOM element Type boolean Example boolean = hClass( $element, cssClass ) height($element) Compute the height of an element Parameters: Name Type Description $element HTMLElement Returns: the height of an element Type Number Example elementHeight = height( $element ) index($element) Return the index of a DOM element Parameters: Name Type Description $element HTMLElement Returns: - Position (starting at 0) of the element in the DOM list is belong to. Type Number Example elementIndex = index( $element ); insertAfter($what, $where) Insert a DOM element after an other Parameters: Name Type Description $what HTMLElement $where HTMLElement Returns: - Inserted element Type HTMLElement Example insertAfter( $what, $where ) insertBefore($what, $where) Insert a DOM element before an other Parameters: Name Type Description $what HTMLElement $where HTMLElement Returns: - Inserted element Type HTMLElement Example insertBefore( $what, $where ) next($element) Return the next element in the DOM Parameters: Name Type Description $element HTMLElement Returns: Type HTMLElement Example $nextElement = next($element) offset($element, isRelativeToViewport, $relativeTo) Get the transform values of a DOM element Parameters: Name Type Description $element HTMLElement isRelativeToViewport Boolean If true, the position is computed relatively to the viewport (top/left of the browser) and not the top/left of the document. This mean, it doesn't take the scroll in count. $relativeTo HTMLElement Optional, compute top and left relatively to another Element Returns: - the offset properties Type offset_Object Example // Get offset from the top/left of the document { width, height, top, left, bottom, right } = offset( $element ) // Same without taking the scroll position in count (top/left of the browser). result = offset( $element, true ) // Get offset relatively from another element result = offset( $element, false, $target ) outerHeight($element, border, margin) Get the outside height of a DOM element Parameters: Name Type Description $element HTMLElement border Boolean border Include border width? margin Boolean margin Include margin width? Returns: - the height of the object Type Number Example // height including padding elementHeight = outerHeight($element) // height including padding, border and margin elementHeight = outerHeight($element, true, true) outerSize($element, border, margin) Get the outside size of a DOM element Parameters: Name Type Description $element HTMLElement border Boolean Include border width? margin Boolean Include margin width? Returns: - the width and height of the object Type outerSize_Object Example // size including padding {width, height} = outerSize($element) // height including padding, border and margin size = outerSize($element, true, true) outerWidth($element, border, margin) Get the outside width of a DOM element Parameters: Name Type Description $element HTMLElement border Boolean Include border width? margin Boolean Include margin width? Returns: - the width of the object Type Number Example // width including padding elementWidth = outerWidth($element) // width including padding, border and margin elementWidth = outerWidth($element, true, true) pageToDOM(html) Convert a whole HTML page string in a document Parameters: Name Type Description html String Returns: - a Promise with the converted document in parameter Type Promise Example pageToDOM( html ).then( $document =&gt; {} ) position($element [, $target]) Return the position of an element or The position relative to another element Parameters: Name Type Argument Description $element HTMLElement $target HTMLElement &lt;optional&gt; Returns: - the coordinate of the object Type position_Object Examples { top, left } = position( $element ) { top, left } = position( $element, $target ) prepend($what, $where) Prepend a DOM element to an other. Require a polyfill. Parameters: Name Type Description $what HTMLElement $where HTMLElement Returns: - Prepened element Type HTMLElement Example prepend( $what, $where ) previous($element) Return the previous element in the DOM Parameters: Name Type Description $element HTMLElement Returns: Type HTMLElement Example $previousElement = previous($element) prop($element, property) Return the value of a style property of a DOM element Parameters: Name Type Description $element HTMLElement property String Returns: Type String Example styles = prop($element, 'marginTop') rClass($elements, cssClass) Remove a class on an element or a list of elements Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; DOM element or array of DOM element cssClass String | Array.&lt;String&gt; Class name, class names separated by space or array of class Returns: Type HTMLElement | Array.&lt;HTMLElement&gt; Example rClass( $elements, cssClass ) remove($element, $parent) Remove an element from the DOM Parameters: Name Type Description $element HTMLElement $parent HTMLElement If undefined the parentNode will be used Returns: - Removed element Type HTMLElement Example remove( $element ) remove( $element, $parent ) sClass($elements, oldCssClass, newCssClass) Replace classes. Remove oldCssClass and add newCssClass only if oldCssClass exists Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; oldCssClass String newCssClass String Returns: Type HTMLElement | Array.&lt;HTMLElement&gt; Example sClass( $elements, oldCssClass, newCssClass ) size($element) Compute the size of an element Parameters: Name Type Description $element HTMLElement Returns: - the width and height of an element Type size_Object Example {width, height} = size( $element ) strToDOM(html [, tag]) Convert an html string into a DOM object Parameters: Name Type Argument Default Description html String tag String &lt;optional&gt; \"DIV\" Used to create an element to convert html inside. 'DIV' by default Returns: - The created DOM element Type HTMLElement Example $element = strToDOM( html ); // Use of tag parameter $li = strToDOM( '&lt;li&gt;&lt;/li&gt;', 'UL' ); tClass($elements, cssClass [, forceAdd]) Toggle a class on an element or a list of elements Parameters: Name Type Argument Description $elements HTMLElement | Array.&lt;HTMLElement&gt; DOM element or array of DOM element cssClass String | Array.&lt;String&gt; Class name, class names separated by space or array of class forceAdd Boolean &lt;optional&gt; Returns: Type HTMLElement | Array.&lt;HTMLElement&gt; Example tClass( $elements, cssClass ) tClass( $elements, cssClass, forceAdd ) width($element) Compute the width of an element Parameters: Name Type Description $element HTMLElement Returns: the width of an element Type Number Example elementWidth = width( $element ) windowScroll() Get the scroll position of the window Returns: - the position of the scroll Type windowScroll_Object Example {top, left} = scroll() windowSize() Get the size of the window Returns: - the width and height of the window Type windowSizeObject Example {width, height} = windowSize() wrap($element, tag) Wrap a DOM element in another Parameters: Name Type Description $element HTMLElement tag String | HTMLElement String example: Returns: - The wrap element Type HTMLElement Example $wrapper = wrap( $element, '&lt;span class=\"abc\"&gt;&lt;/span&gt;' ); Type Definitions documentSize_Object Type: Object Properties: Name Type Description width Number height Number matrix_Object Type: Object Properties: Name Type Description m11 Number m21 Number m31 Number m41 Number m12 Number m22 Number m32 Number m42 Number m13 Number m23 Number m33 Number m43 Number m14 Number m24 Number m34 Number m44 Number offset_Object Type: object Properties: Name Type Description top Number left Number right Number bottom Number width Number height Number outerSize_Object Type: Object Properties: Name Type Description width Number height Number position_Object Type: Object Properties: Name Type Description top Number left Number size_Object Type: Object Properties: Name Type Description width Number height Number transform_Object Type: Object Properties: Name Type Description tx Number ty Number tz Number rx Number ry Number rz Number translate_Object Type: Object Properties: Name Type Description tx Number ty Number tz Number windowScroll_Object Type: Object Properties: Name Type Description top Number left Number windowSizeObject Type: Object Properties: Name Type Description width Number height Number × 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 Global aClassappendchildrenclonedocumentSizefiltergetMatrixgetStylegetTransformgetTranslatehClassheightindexinsertAfterinsertBeforenextoffsetouterHeightouterSizeouterWidthpageToDOMpositionprependpreviousproprClassremovesClasssizestrToDOMtClasswidthwindowScrollwindowSizewrap × 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 Global aClassappendchildrenclonedocumentSizefiltergetCssPropertygetMatrixgetStylegetTransformgetTranslatehClassheightindexinsertAfterinsertBeforenextoffsetouterHeightouterSizeouterWidthpageToDOMpositionprependpreviousproprClassremovesClasssetCssPropertysizestrToDOMtClasswidthwindowScrollwindowSizewrap Global Methods aClass($elements, cssClass) Add a class on an element or a list of elements Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; DOM element or array of DOM element cssClass String | Array.&lt;string&gt; Class name, class names separated by space or array of class Returns: Type HTMLElement | Array.&lt;HTMLElement&gt; Example aClass( $elements, cssClass ) append($what, $where) Append a DOM element to an other. Require a polyfill. Parameters: Name Type Description $what HTMLElement $where HTMLElement Returns: - Appened element Type HTMLElement Example append( $what, $where ) children($element) Return all the children of a DOM element Parameters: Name Type Description $element HTMLElement Returns: Type Array.&lt;HTMLElement&gt; Example $elements = children($element) clone($element) Clone a DOM element Parameters: Name Type Description $element HTMLElement Returns: - Cloned element Type HTMLElement Example $clonedElement = clone( $element ) documentSize() Get the current document size Returns: the width and height of the element Type documentSize_Object Example { width, height } = documentSize() filter($elements, selector) Filter a DOM list depending on a selector Parameters: Name Type Description $elements Array.&lt;HTMLElement&gt; selector String Returns: - Filtered list Type Array.&lt;HTMLElement&gt; Example filteredArray = filter( $elements, selector ); getCssProperty($element, property) Get a CSS property of an element Parameters: Name Type Description $element HTMLElement property String Returns: Type String Example value = getCssProperty($element, '--my-var') getMatrix($elem) Get the matrix of a DOM element Parameters: Name Type Description $elem HTMLElement Returns: - the matrix object Type matrix_Object Example { m11, m21, m31, m41, m12, m22, m32, m42, m13, m23, m33, m43, m14, m24, m34, m44 } = getMatrix ( $elem ) getStyle($element) Return the style of a DOM element Parameters: Name Type Description $element HTMLElement Returns: Type Object Example styles = getStyle($element) getTransform($elem) Get the transform values of a DOM element Parameters: Name Type Description $elem HTMLElement Returns: - the transform properties Type transform_Object Example { tx, ty, tz, rx, ry, rz } = getTransform ( $elem ) getTranslate($elem) Get the translation values of a DOM element Parameters: Name Type Description $elem HTMLElement Returns: - the translate properties Type translate_Object Example { tx, ty, tz } = getTranslate ( $elem ) hClass($element, cssClass) Check if a class is present on a DOM element Parameters: Name Type Description $element HTMLElement DOM element cssClass String Returns: - true if a class is present on a DOM element Type boolean Example boolean = hClass( $element, cssClass ) height($element) Compute the height of an element Parameters: Name Type Description $element HTMLElement Returns: the height of an element Type Number Example elementHeight = height( $element ) index($element) Return the index of a DOM element Parameters: Name Type Description $element HTMLElement Returns: - Position (starting at 0) of the element in the DOM list is belong to. Type Number Example elementIndex = index( $element ); insertAfter($what, $where) Insert a DOM element after an other Parameters: Name Type Description $what HTMLElement $where HTMLElement Returns: - Inserted element Type HTMLElement Example insertAfter( $what, $where ) insertBefore($what, $where) Insert a DOM element before an other Parameters: Name Type Description $what HTMLElement $where HTMLElement Returns: - Inserted element Type HTMLElement Example insertBefore( $what, $where ) next($element) Return the next element in the DOM Parameters: Name Type Description $element HTMLElement Returns: Type HTMLElement Example $nextElement = next($element) offset($element, isRelativeToViewport, $relativeTo) Get the transform values of a DOM element Parameters: Name Type Description $element HTMLElement isRelativeToViewport Boolean If true, the position is computed relatively to the viewport (top/left of the browser) and not the top/left of the document. This mean, it doesn't take the scroll in count. $relativeTo HTMLElement Optional, compute top and left relatively to another Element Returns: - the offset properties Type offset_Object Example // Get offset from the top/left of the document { width, height, top, left, bottom, right } = offset( $element ) // Same without taking the scroll position in count (top/left of the browser). result = offset( $element, true ) // Get offset relatively from another element result = offset( $element, false, $target ) outerHeight($element, border, margin) Get the outside height of a DOM element Parameters: Name Type Description $element HTMLElement border Boolean border Include border width? margin Boolean margin Include margin width? Returns: - the height of the object Type Number Example // height including padding elementHeight = outerHeight($element) // height including padding, border and margin elementHeight = outerHeight($element, true, true) outerSize($element, border, margin) Get the outside size of a DOM element Parameters: Name Type Description $element HTMLElement border Boolean Include border width? margin Boolean Include margin width? Returns: - the width and height of the object Type outerSize_Object Example // size including padding {width, height} = outerSize($element) // height including padding, border and margin size = outerSize($element, true, true) outerWidth($element, border, margin) Get the outside width of a DOM element Parameters: Name Type Description $element HTMLElement border Boolean Include border width? margin Boolean Include margin width? Returns: - the width of the object Type Number Example // width including padding elementWidth = outerWidth($element) // width including padding, border and margin elementWidth = outerWidth($element, true, true) pageToDOM(html) Convert a whole HTML page string in a document Parameters: Name Type Description html String Returns: - a Promise with the converted document in parameter Type Promise Example pageToDOM( html ).then( $document =&gt; {} ) position($element [, $target]) Return the position of an element or The position relative to another element Parameters: Name Type Argument Description $element HTMLElement $target HTMLElement &lt;optional&gt; Returns: - the coordinate of the object Type position_Object Examples { top, left } = position( $element ) { top, left } = position( $element, $target ) prepend($what, $where) Prepend a DOM element to an other. Require a polyfill. Parameters: Name Type Description $what HTMLElement $where HTMLElement Returns: - Prepened element Type HTMLElement Example prepend( $what, $where ) previous($element) Return the previous element in the DOM Parameters: Name Type Description $element HTMLElement Returns: Type HTMLElement Example $previousElement = previous($element) prop($element, property) Return the value of a style property of a DOM element Parameters: Name Type Description $element HTMLElement property String Returns: Type String Example styles = prop($element, 'marginTop') rClass($elements, cssClass) Remove a class on an element or a list of elements Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; DOM element or array of DOM element cssClass String | Array.&lt;String&gt; Class name, class names separated by space or array of class Returns: Type HTMLElement | Array.&lt;HTMLElement&gt; Example rClass( $elements, cssClass ) remove($element, $parent) Remove an element from the DOM Parameters: Name Type Description $element HTMLElement $parent HTMLElement If undefined the parentNode will be used Returns: - Removed element Type HTMLElement Example remove( $element ) remove( $element, $parent ) sClass($elements, oldCssClass, newCssClass) Replace classes. Remove oldCssClass and add newCssClass only if oldCssClass exists Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; oldCssClass String newCssClass String Returns: Type HTMLElement | Array.&lt;HTMLElement&gt; Example sClass( $elements, oldCssClass, newCssClass ) setCssProperty($element, property, value) Set a CSS property on an element Parameters: Name Type Description $element HTMLElement property String | Object value String Returns: Type HTMLElement Example $element = setCssVar($element, '--my-var', '12px') $element = setCssVar($element, { \"--my-var\": \"12px\", \"--my-var-2\": \"100%\" }) size($element) Compute the size of an element Parameters: Name Type Description $element HTMLElement Returns: - the width and height of an element Type size_Object Example {width, height} = size( $element ) strToDOM(html [, tag]) Convert an html string into a DOM object Parameters: Name Type Argument Default Description html String tag String &lt;optional&gt; \"DIV\" Used to create an element to convert html inside. 'DIV' by default Returns: - The created DOM element Type HTMLElement Example $element = strToDOM( html ); // Use of tag parameter $li = strToDOM( '&lt;li&gt;&lt;/li&gt;', 'UL' ); tClass($elements, cssClass [, forceAdd]) Toggle a class on an element or a list of elements Parameters: Name Type Argument Description $elements HTMLElement | Array.&lt;HTMLElement&gt; DOM element or array of DOM element cssClass String | Array.&lt;String&gt; Class name, class names separated by space or array of class forceAdd Boolean &lt;optional&gt; Returns: Type HTMLElement | Array.&lt;HTMLElement&gt; Example tClass( $elements, cssClass ) tClass( $elements, cssClass, forceAdd ) width($element) Compute the width of an element Parameters: Name Type Description $element HTMLElement Returns: the width of an element Type Number Example elementWidth = width( $element ) windowScroll() Get the scroll position of the window Returns: - the position of the scroll Type windowScroll_Object Example {top, left} = scroll() windowSize() Get the size of the window Returns: - the width and height of the window Type windowSizeObject Example {width, height} = windowSize() wrap($element, tag) Wrap a DOM element in another Parameters: Name Type Description $element HTMLElement tag String | HTMLElement String example: Returns: - The wrap element Type HTMLElement Example $wrapper = wrap( $element, '&lt;span class=\"abc\"&gt;&lt;/span&gt;' ); Type Definitions documentSize_Object Type: Object Properties: Name Type Description width Number height Number matrix_Object Type: Object Properties: Name Type Description m11 Number m21 Number m31 Number m41 Number m12 Number m22 Number m32 Number m42 Number m13 Number m23 Number m33 Number m43 Number m14 Number m24 Number m34 Number m44 Number offset_Object Type: object Properties: Name Type Description top Number left Number right Number bottom Number width Number height Number outerSize_Object Type: Object Properties: Name Type Description width Number height Number position_Object Type: Object Properties: Name Type Description top Number left Number size_Object Type: Object Properties: Name Type Description width Number height Number transform_Object Type: Object Properties: Name Type Description tx Number ty Number tz Number rx Number ry Number rz Number translate_Object Type: Object Properties: Name Type Description tx Number ty Number tz Number windowScroll_Object Type: Object Properties: Name Type Description top Number left Number windowSizeObject Type: Object Properties: Name Type Description width Number height Number × 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 Global aClassappendchildrenclonedocumentSizefiltergetCssPropertygetMatrixgetStylegetTransformgetTranslatehClassheightindexinsertAfterinsertBeforenextoffsetouterHeightouterSizeouterWidthpageToDOMpositionprependpreviousproprClassremovesClasssetCssPropertysizestrToDOMtClasswidthwindowScrollwindowSizewrap × 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/events/common/DeviceOrientation.html

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

package/documentation/jsdocs/events/common/HistoryController.html

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

package/documentation/jsdocs/events/common/IntersectObserver.html

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

package/documentation/jsdocs/events/common/KeyboardHandler.html

@@ -1360,7 +1360,7 @@ keyboardControls.off();</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: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/events/common/MediaQueriesEvents.html

@@ -3033,7 +3033,7 @@ Ih the current breakpoint name is "small", it will return "val1&q
 <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/events/common/TouchHover.html

@@ -496,7 +496,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>

package/documentation/jsdocs/events/common/WindowEvents.html

@@ -2173,7 +2173,7 @@ So, its top and left are the scroll position and its width and height are the wi
 <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/events/common/classes.list.html

@@ -234,7 +234,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/events/common/global.html

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

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

@@ -142,7 +142,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/events/common/namespaces.list.html

@@ -234,7 +234,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/events/common/pubSub.html

@@ -1075,7 +1075,7 @@ pubSub.fire( pubSub.MY_EVENT_2, {myProp: &#x27;test&#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: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/events/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 Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Global Methods onAllImagesLoad($elements, manageError, callback) Preload a list of images Parameters: Name Type Description $elements Array.&lt;HTMLElement&gt; Array of images to preload manageError Boolean If true reject the promise on error (false) callback onImageLoad_Callback Function called on each image load ($element, eventType:string) =&gt; {} Returns: - Return a standard Promise + an .off() function to cancel event Type Promise Example onAllImagesLoad( $images, partialCallback, manageError ).then( () =&gt; {} ) // To allow event cancelation, don't chain .then() directly after onAllImagesLoad let preload = onAllImagesLoad( $images, manageError, callback ); preload.then( () =&gt; {} ); ... preload.off(); onAnimationEnd($elem) Bind a one time animationend event on a DOM object Parameters: Name Type Description $elem HTMLElement Returns: - Return a standard Promise + an .off() function to cancel event Type Promise Example onAnimationEnd( $elem ).then( () =&gt; {} ); // To remove the event binding, don't chain .then() directly after onAnimationEnd: let animationEnd = onAnimationEnd( $element ); animationEnd.then( () =&gt; {} ); animationEnd.off() onImageLoad($element, manageError, callback) Preload an image Parameters: Name Type Description $element HTMLElement DOM image to preload manageError Boolean If true reject the promise on error (false) callback onImageLoad_Callback Function called on image load Returns: - Return a standard Promise + an .off() function to cancel event Type Promise Example onImageLoad( $image, manageError, callback ).then( () =&gt; {} ) // To allow event cancelation, don't chain .then() directly after onImageLoad let preload = onImageLoad( $image, callback, manageError ); preload.then( () =&gt; {} ); ... preload.off(); onTransitionEnd($element) Bind a one time transitionend event on a DOM object Parameters: Name Type Description $element HTMLElement Returns: - Return a standard Promise + an .off() function to cancel event Type Promise Example onTransitionEnd( $elem ).then( () =&gt; {} ); // To remove the event binding, don't chain .then() directly after onTransitionEnd: let transitionEnd = onTransitionEnd( $element ); transitionEnd.then( () =&gt; {} ); transitionEnd.off() × 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 Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Classes Classes DeviceOrientation HistoryController IntersectObserver KeyboardHandler MediaQueriesEvents TouchHover WindowEvents Namespaces pubSub × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:10+02:00 using the DocStrap template. "},"namespaces.list.html":{"id":"namespaces.list.html","title":"Namespaces","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Namespaces Classes DeviceOrientation HistoryController IntersectObserver KeyboardHandler MediaQueriesEvents TouchHover WindowEvents Namespaces pubSub × 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 Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:10+02:00 using the DocStrap template. "},"DeviceOrientation.html":{"id":"DeviceOrientation.html","title":"Class: DeviceOrientation","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: DeviceOrientation DeviceOrientation new DeviceOrientation(options) Handle device orientation change Parameters: Name Type Description options Object Properties Name Type Description onOrientationChange DeviceOrientation_Callback Example let ori = new DeviceOrientation({ onOrientationChange: orientationName =&gt; { console.log(orientationName) } }) // Get current orientation let orientationName = ori.getOrientation() // Remove event binding ori.off() Methods getOrientation() Return the current normalized orientation Returns: landscape-primary, portrait-primary, landscape-secondary, portrait-secondary Type String off() Remove all binding Returns: Type DeviceOrientation Type Definitions DeviceOrientation_Callback(type) Called when the orientation of the device change Parameters: Name Type Description type String Name of the orientation: landscape-primary | portrait-primary | landscape-secondary | portrait-secondary × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:10+02:00 using the DocStrap template. "},"HistoryController.html":{"id":"HistoryController.html","title":"Class: HistoryController","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: HistoryController HistoryController new HistoryController(defaultTitle) Manage history pushState and popstate event Parameters: Name Type Description defaultTitle string Default page title Example let h = new HistoryController( 'The default page title' ) // Push a new state in the history h.pushState( {data: 1}, 'The page title', '/path/page.html' ) // Return the current page state h.getState() // Update the anchor of the current url h.updateAnchor( anchor ) // Register an handler for popState h.register( handler ) =&gt; ( url, state ) // remove a registered handler for popState h.remove( handler ) Members state :state_Object Get the current page state Type: state_Object Methods pushState(state, title, url) Push a new state in the history Parameters: Name Type Description state Object Native browser state object title String url String Returns: Type HistoryController register(handler) Register an handler for popState Parameters: Name Type Description handler HistoryController_Callback Returns: Type HistoryController remove(handler) Remove a registered handler for popState Parameters: Name Type Description handler function Returns: Type HistoryController updateAnchor(anchor) Update the anchor of the current url Parameters: Name Type Description anchor String Returns: Type HistoryController Type Definitions HistoryController_Callback(url, state) Parameters: Name Type Description url String state oOject Native browser state object state_Object Type: object Properties: Name Type Description url String state Object Native browser state object title String × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:10+02:00 using the DocStrap template. "},"IntersectObserver.html":{"id":"IntersectObserver.html","title":"Class: IntersectObserver","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: IntersectObserver IntersectObserver new IntersectObserver(options) Wrapper for the IntersectionObserver API Parameters: Name Type Description options Object Properties Name Type Argument Default Description onIntersecting IntersectObserver_Handler Callback function onlyOnce Boolean &lt;optional&gt; false Execute the callback only once per $elements the first time it intersect the viewport ioOptions Object &lt;optional&gt; Native options to create to IntersectionObserver API Properties Name Type Argument Default Description root HTMLElement &lt;optional&gt; null Element used as display. If null, use the screen viewport rootMargin String &lt;optional&gt; \"0px\" Margin around the viewport. Can be defined as margin css property: \"10px 20px 30px 40px\" (top, right, bottom, left) threshold Float | Array.&lt;Float&gt; &lt;optional&gt; 0 Percentage (0.0 to 1.0) of visibility needed to execute the callback function. To call the function when the visibility is at least 50%: threshold = 0.5. To call the function every 25%: threshold=[0, 0.25, 0.5, 0.75, 1] Example let io = new IntersectObserver( { \"onIntersecting\": callback } ); function callback( $target, entry ) { console.log( `${ $target } enter the screen viemport` ); console.log( `${ $target } is intersecting the viewport: ${ entry.isintersecting }` ); } // To add an HTMLElement, a NodeList or an array of HTMLElement to the observer io.add( $someHTMLElement ); io.add( [ $someHTMLElement2, $someHTMLElement3 ] ); io.add( $someNodList ); // To remove an HTMLElement, a NodeList or an array of HTMLElement from the observer io.remove( $someHTMLElement2 ); io.remove( $someNodList ); // To remove all elements from the observer io.clear(); Methods add($elements) Add elements to be observed Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; Returns: Type IntersectObserver clear() Stop all elements to be observed Returns: Type IntersectObserver remove($elements) Stop some elements to be observed Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; Returns: Type IntersectObserver Type Definitions IntersectObserver_Handler($target, entry) Parameters: Name Type Description $target HTMLElement entry IntersectionObserverEntry Native IntersectionObserver callback parameter Properties Name Type Description boundingClientRect DOMRectReadOnly { x, y, width, height, top, right, bottom, left } intersectionRatio Number intersectionRect DOMRectReadOnly isIntersecting Boolean rootBounds DOMRectReadOnly target HTMLElement time DOMHighResTimeStamp × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:10+02:00 using the DocStrap template. "},"KeyboardHandler.html":{"id":"KeyboardHandler.html","title":"Class: KeyboardHandler","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: KeyboardHandler KeyboardHandler new KeyboardHandler($element, userOptions) Handle keyboard typing on an elements Parameters: Name Type Description $element HTMLElement userOptions Object Properties Name Type Argument Default Description selector String &lt;optional&gt; Used for event delegation preventDefault Boolean &lt;optional&gt; false Prevent default on all key pressed, except TAB onEnter KeyboardHandler_Callback &lt;optional&gt; onSpace KeyboardHandler_Callback &lt;optional&gt; onSelect KeyboardHandler_Callback &lt;optional&gt; Called when pressing ENTER or SPACE onEscape KeyboardHandler_Callback &lt;optional&gt; onTab KeyboardHandler_Callback &lt;optional&gt; onTabReverse KeyboardHandler_Callback &lt;optional&gt; onRight KeyboardHandler_Callback &lt;optional&gt; Called when pressing RIGHT ARROW KEYS onLeft KeyboardHandler_Callback &lt;optional&gt; Called when pressing LEFT ARROW KEYS onUp KeyboardHandler_Callback &lt;optional&gt; Called when pressing UP ARROW KEYS onDown KeyboardHandler_Callback &lt;optional&gt; Called when pressing DOWN ARROW KEYS onPageUp KeyboardHandler_Callback &lt;optional&gt; onPageDown KeyboardHandler_Callback &lt;optional&gt; onPrevious KeyboardHandler_Callback &lt;optional&gt; Called when pressing LEFT or DOWN arrow keys onNext KeyboardHandler_Callback &lt;optional&gt; Called when pressing RIGHT or UP arrow keys onKey KeyboardHandler_Callback &lt;optional&gt; Called on every key See: For more details, see extra/events.md Example let keyboardControls = new KeyboardHandler( $domElement, options ); // To cancel events watching keyboardControls.off(); Methods off() Remove the binding Returns: Type KeyboardHandler on() Add the binding Returns: Type KeyboardHandler Type Definitions KeyboardHandler_Callback(event, $context) Called when a key is pressed Parameters: Name Type Description event Event $context HTMLElement Targeted DOM element × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:11+02:00 using the DocStrap template. "},"MediaQueriesEvents.html":{"id":"MediaQueriesEvents.html","title":"Class: MediaQueriesEvents","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: MediaQueriesEvents MediaQueriesEvents new MediaQueriesEvents(breakpointsList [, userOptions]) Manage media queries events Parameters: Name Type Argument Description breakpointsList Array.&lt;Breakpoint&gt; userOptions Object &lt;optional&gt; Properties Name Type Argument Default Description unit String &lt;optional&gt; \"px\" Example let mquery = new MediaQueriesEvents( [ \"name\" : \"mob\", \"query\": window.matchMedia( '(max-width:767px)' ) }, { \"name\" : \"tab\", \"query\": window.matchMedia( '(min-width:768px) and (max-width:959px)' ) }, { \"name\" : \"desk\", \"query\": window.matchMedia( '(min-width:960px)' ) } ] ); or let mquery = new MediaQueriesEvents( [ \"name\" : \"mob\", \"max\": 767 }, { \"name\" : \"tab\", \"min\": 768, \"max\": 956 }, { \"name\" : \"desk\", \"max\": 960 } ], { \"unit\": \"px\" // Default value } ); // Register a function to be call when leaving any breakpoint mquery.register( callback, MediaQueriesEvents.TYPE_ON_LEAVE ); // Remove a function to be called mquery.remove( callback ); // Bind a function to be call when entering the \"small\" breakpoint mquery.on( callback, 'small' ); // Same as mquery.on( callback, 'small', MediaQueriesEvents.TYPE_ON_ENTER ); // Unbind the function mquery.off( callback, 'small' ); // Refresh all registered function for the current breakpoint mquery.refresh(); // Call a function with the current breakpoint in parameters. mquery.get( callback ); // Return true if `breakpointName` is the name of the current breakpoint boolean = mquery.is( 'desk' ); // Current active breakpoint myBreakpoint = mquery.currentBreakpoint; // =&gt; {name, query, ...} or false myBreakpoint.is( 'mob' ); // =&gt; true|false myBreakpoint.in( ['mob', 'tab'] ); // =&gt; true|false // List of all breakpoints array = mquery.list; // Check if the current breakpoint is in a list. boolean = mquery.in(['mob', 'tab']); // Pause media queries watch mquery.suspend(); // Resume media queries watch mquery.resume(); Members &lt;static, readonly&gt; TYPE_ON_BOTH :Number Mediaquery both callback type Type: Number &lt;static, readonly&gt; TYPE_ON_ENTER :Number Mediaquery entering callback type Type: Number &lt;static, readonly&gt; TYPE_ON_LEAVE :Number Mediaquery leaving callback type Type: Number &lt;readonly&gt; currentBreakpoint :False|Breakpoint Current active breakpoint Type: False | Breakpoint &lt;readonly&gt; list :Array.&lt;Breakpoint&gt; List of all breakpoints Type: Array.&lt;Breakpoint&gt; Methods get(callback) Call a function with the current breakpoint Parameters: Name Type Description callback function Function to call Returns: Type MediaQueriesEvents getValue(obj) Return the value of the property with the name of the current breakpoint of an object Parameters: Name Type Description obj Object Returns: Type * Example mediaQueryEvent.getValue( { \"small\": \"val1\", \"medium\": \"val2\", ... } ); Ih the current breakpoint name is \"small\", it will return \"val1\" in(breakpointNameList) Check if the current breakpoint is in a list Parameters: Name Type Description breakpointNameList Array.&lt;String&gt; Array of breakpoint name Returns: Type Boolean is(breakpointName) Check if we are in a specific range Parameters: Name Type Description breakpointName String Name of a breakpoint Returns: Type Boolean off(callback, breakpointName) Unbind a function to be called on a specific breakpoint Parameters: Name Type Description callback function Function to remove from the registered function list breakpointName String Name of the breakpoint Returns: Type MediaQueriesEvents on(callback, breakpointName [, type]) Bind a function to be called on a specific breakpoint Parameters: Name Type Argument Default Description callback MediaQueriesEvents_Handler Callback breakpointName String Name of the breakpoint type String &lt;optional&gt; MediaQueriesEvents.TYPE_ON_ENTER Select when the function will be called: when entering the query, when leaving it, or on both Returns: Type MediaQueriesEvents refresh() Force the refresh of all registered function Returns: Type MediaQueriesEvents register(callback [, type]) Register a function to be called on all media queries change Parameters: Name Type Argument Default Description callback MediaQueriesEvents_Handler Function to call on mediaquery change type String &lt;optional&gt; MediaQueriesEvents.TYPE_ON_ENTER Select when the function will be called: when entering the query, when leaving it, or on both Returns: Type MediaQueriesEvents remove(callback) Unregister a function Parameters: Name Type Description callback function Function to remove from the registered function list Returns: Type MediaQueriesEvents resume() Active media queries callback Returns: Type MediaQueriesEvents suspend() Stop media queries callback Returns: Type MediaQueriesEvents which() Return the currentbreakpointsList breakpoint Deprecated: - Use mediaquerisEvent.currentBreakpoint instead Returns: Type False | Breakpoint Type Definitions Breakpoint Properties: Name Type Argument Description name String query Object Object buid with the window.matchMedia() function min Number &lt;optional&gt; mediaquery lower bound max Number &lt;optional&gt; mediaquery upper bound in function Return true if the breakpoint is in the list: breakpoint.in(['bp1', 'bp2']) is function Return true if the name passed to the function is the name of the breakpoint: breakpoint.is('bp1') MediaQueriesEvents_Handler(breakpoint, isMatching) Parameters: Name Type Description breakpoint Breakpoint isMatching Boolean True if we enter the query, false if we leave × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:11+02:00 using the DocStrap template. "},"pubSub.html":{"id":"pubSub.html","title":"Namespace: pubSub","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Namespace: pubSub pubSub Publish / Suscribe event system Example pubSub.init( { \"MY_EVENT_1\": \"myevent1\", \"MY_EVENT_2\": \"myevent2\" } ); pubSub.on( pubSub.MY_EVENT_1, callback ); pubSub.off( pubSub.MY_EVENT_1, callback ); pubSub.fire( pubSub.MY_EVENT_1 ); // You can send data along with the event: pubSub.on( pubSub.MY_EVENT_2, data =&gt; { console.log(data.myProp) } ); pubSub.fire( pubSub.MY_EVENT_2, {myProp: 'test'} ); Methods &lt;static&gt; add(eventsNames) Add events name Parameters: Name Type Description eventsNames Object | String [ \"name1\", \"name2\" ] or \"name1\" Returns: Type PubSub &lt;static&gt; fire(eventName [, data]) Fire an event Parameters: Name Type Argument Description eventName String data Object &lt;optional&gt; Data to be send to the callback functions Returns: Type PubSub &lt;static&gt; init(eventsNames) Initialize all events name Parameters: Name Type Description eventsNames Object { \"name1\": val, \"name2\": val2, ... } Deprecated: Use pubSub.add( [] ) instead Returns: Type PubSub &lt;static&gt; off(eventName, callback) Unbind an event Parameters: Name Type Description eventName String callback function Returns: Type PubSub &lt;static&gt; on(eventName, callback) Bind an event Parameters: Name Type Description eventName String callback function (data) =&gt; {} Returns: Type PubSub × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:11+02:00 using the DocStrap template. "},"TouchHover.html":{"id":"TouchHover.html","title":"Class: TouchHover","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: TouchHover TouchHover new TouchHover(options) Simulate hover (on touch) on mobile device. Touch a second time to follow the link. Parameters: Name Type Description options Object Properties Name Type Description cssClass String selector String $wrapper HTMLEvent Example new TouchHover( { \"cssClass\": 'hover', \"selector\": '.link', \"$wrapper\": $myWrapper } ); Methods destroy() Remove all binded events Returns: Type TouchHover × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:11+02:00 using the DocStrap template. "},"WindowEvents.html":{"id":"WindowEvents.html","title":"Class: WindowEvents","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: WindowEvents WindowEvents new WindowEvents($window [, throttleDelay]) Window events handler Parameters: Name Type Argument Default Description $window HTMLElement DOM object on which the events will be checked throttleDelay Number &lt;optional&gt; -1 Throttle delay in ms. If &lt; 0, it use requestAnimationFrame Example let w = new WindowEvents( window ); or to change throttle delay : let w = new WindowEvents( window, 150 ); let callback = ( { windowInfo, scrollInfo, documentInfo, viewportInfo }, type, event ) =&gt; {}; w.register( callback, 'resize' ); // type = 'resize', 'scroll' or undefined for both w.remove( callback, 'resize' ); // Force refresh of all registered function w.refresh( 'scroll' ); // Force the computing scroll position window and document size w.update(); // Call the function w.get( callback ); // Tools { top, left } = w.scrollInfo; { width, height } = w.windowInfo; { width, height } = w.documentInfo; { top, left, bottom, right, width, height } = w.viewportInfo; Members documentInfo :Object { width, height } Type: Object scrollInfo :Object { top, left } Type: Object viewportInfo :Object The viewport is the displayed part of the document. So, its top and left are the scroll position and its width and height are the window size. { top, left, bottom, right, width, height } Type: Object windowInfo :Object { width, height } Type: Object Methods get(callback) Call a function with the last stored positions and sizes Parameters: Name Type Description callback WindowEvents_Handler Returns: Type WindowEvents refresh(type) Refresh all the registered functions Parameters: Name Type Description type String resize | scroll | undefined (both) Returns: Type WindowEvents register(callback, type) Register a function on a type of event Parameters: Name Type Description callback WindowEvents_Handler type String resize | scroll | undefined (both) Returns: Type WindowEvents remove(callback, type) Unregister a function for a type of event Parameters: Name Type Description callback WindowEvents_Handler type String resize | scroll | undefined (both) Returns: Type WindowEvents update(type) Update all the stored data (window size, scroll position, ...) Parameters: Name Type Description type String resize | scroll | undefined (both) Returns: Type WindowEvents Type Definitions WindowEvents_Handler(info, eventType [, originalEvent]) Parameters: Name Type Argument Description info Object Properties Name Type Description windowInfo Object Properties Name Type Description width Number height Number scrollInfo Object Properties Name Type Description top Number left Number documentInfo Object Properties Name Type Description width Number height Number viewportInfo Object Properties Name Type Description top Number left Number bottom Number right Number width Number height Number eventType String resize | scroll | force originalEvent Event &lt;optional&gt; if available × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:11+02:00 using the DocStrap template. "}}
+    {"global.html":{"id":"global.html","title":"Global","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Global Methods onAllImagesLoad($elements, manageError, callback) Preload a list of images Parameters: Name Type Description $elements Array.&lt;HTMLElement&gt; Array of images to preload manageError Boolean If true reject the promise on error (false) callback onImageLoad_Callback Function called on each image load ($element, eventType:string) =&gt; {} Returns: - Return a standard Promise + an .off() function to cancel event Type Promise Example onAllImagesLoad( $images, partialCallback, manageError ).then( () =&gt; {} ) // To allow event cancelation, don't chain .then() directly after onAllImagesLoad let preload = onAllImagesLoad( $images, manageError, callback ); preload.then( () =&gt; {} ); ... preload.off(); onAnimationEnd($elem) Bind a one time animationend event on a DOM object Parameters: Name Type Description $elem HTMLElement Returns: - Return a standard Promise + an .off() function to cancel event Type Promise Example onAnimationEnd( $elem ).then( () =&gt; {} ); // To remove the event binding, don't chain .then() directly after onAnimationEnd: let animationEnd = onAnimationEnd( $element ); animationEnd.then( () =&gt; {} ); animationEnd.off() onImageLoad($element, manageError, callback) Preload an image Parameters: Name Type Description $element HTMLElement DOM image to preload manageError Boolean If true reject the promise on error (false) callback onImageLoad_Callback Function called on image load Returns: - Return a standard Promise + an .off() function to cancel event Type Promise Example onImageLoad( $image, manageError, callback ).then( () =&gt; {} ) // To allow event cancelation, don't chain .then() directly after onImageLoad let preload = onImageLoad( $image, callback, manageError ); preload.then( () =&gt; {} ); ... preload.off(); onTransitionEnd($element) Bind a one time transitionend event on a DOM object Parameters: Name Type Description $element HTMLElement Returns: - Return a standard Promise + an .off() function to cancel event Type Promise Example onTransitionEnd( $elem ).then( () =&gt; {} ); // To remove the event binding, don't chain .then() directly after onTransitionEnd: let transitionEnd = onTransitionEnd( $element ); transitionEnd.then( () =&gt; {} ); transitionEnd.off() × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Classes Classes DeviceOrientation HistoryController IntersectObserver KeyboardHandler MediaQueriesEvents TouchHover WindowEvents Namespaces pubSub × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"namespaces.list.html":{"id":"namespaces.list.html","title":"Namespaces","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Namespaces Classes DeviceOrientation HistoryController IntersectObserver KeyboardHandler MediaQueriesEvents TouchHover WindowEvents Namespaces pubSub × 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 Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"DeviceOrientation.html":{"id":"DeviceOrientation.html","title":"Class: DeviceOrientation","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: DeviceOrientation DeviceOrientation new DeviceOrientation(options) Handle device orientation change Parameters: Name Type Description options Object Properties Name Type Description onOrientationChange DeviceOrientation_Callback Example let ori = new DeviceOrientation({ onOrientationChange: orientationName =&gt; { console.log(orientationName) } }) // Get current orientation let orientationName = ori.getOrientation() // Remove event binding ori.off() Methods getOrientation() Return the current normalized orientation Returns: landscape-primary, portrait-primary, landscape-secondary, portrait-secondary Type String off() Remove all binding Returns: Type DeviceOrientation Type Definitions DeviceOrientation_Callback(type) Called when the orientation of the device change Parameters: Name Type Description type String Name of the orientation: landscape-primary | portrait-primary | landscape-secondary | portrait-secondary × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"HistoryController.html":{"id":"HistoryController.html","title":"Class: HistoryController","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: HistoryController HistoryController new HistoryController(defaultTitle) Manage history pushState and popstate event Parameters: Name Type Description defaultTitle string Default page title Example let h = new HistoryController( 'The default page title' ) // Push a new state in the history h.pushState( {data: 1}, 'The page title', '/path/page.html' ) // Return the current page state h.getState() // Update the anchor of the current url h.updateAnchor( anchor ) // Register an handler for popState h.register( handler ) =&gt; ( url, state ) // remove a registered handler for popState h.remove( handler ) Members state :state_Object Get the current page state Type: state_Object Methods pushState(state, title, url) Push a new state in the history Parameters: Name Type Description state Object Native browser state object title String url String Returns: Type HistoryController register(handler) Register an handler for popState Parameters: Name Type Description handler HistoryController_Callback Returns: Type HistoryController remove(handler) Remove a registered handler for popState Parameters: Name Type Description handler function Returns: Type HistoryController updateAnchor(anchor) Update the anchor of the current url Parameters: Name Type Description anchor String Returns: Type HistoryController Type Definitions HistoryController_Callback(url, state) Parameters: Name Type Description url String state oOject Native browser state object state_Object Type: object Properties: Name Type Description url String state Object Native browser state object title String × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"IntersectObserver.html":{"id":"IntersectObserver.html","title":"Class: IntersectObserver","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: IntersectObserver IntersectObserver new IntersectObserver(options) Wrapper for the IntersectionObserver API Parameters: Name Type Description options Object Properties Name Type Argument Default Description onIntersecting IntersectObserver_Handler Callback function onlyOnce Boolean &lt;optional&gt; false Execute the callback only once per $elements the first time it intersect the viewport ioOptions Object &lt;optional&gt; Native options to create to IntersectionObserver API Properties Name Type Argument Default Description root HTMLElement &lt;optional&gt; null Element used as display. If null, use the screen viewport rootMargin String &lt;optional&gt; \"0px\" Margin around the viewport. Can be defined as margin css property: \"10px 20px 30px 40px\" (top, right, bottom, left) threshold Float | Array.&lt;Float&gt; &lt;optional&gt; 0 Percentage (0.0 to 1.0) of visibility needed to execute the callback function. To call the function when the visibility is at least 50%: threshold = 0.5. To call the function every 25%: threshold=[0, 0.25, 0.5, 0.75, 1] Example let io = new IntersectObserver( { \"onIntersecting\": callback } ); function callback( $target, entry ) { console.log( `${ $target } enter the screen viemport` ); console.log( `${ $target } is intersecting the viewport: ${ entry.isintersecting }` ); } // To add an HTMLElement, a NodeList or an array of HTMLElement to the observer io.add( $someHTMLElement ); io.add( [ $someHTMLElement2, $someHTMLElement3 ] ); io.add( $someNodList ); // To remove an HTMLElement, a NodeList or an array of HTMLElement from the observer io.remove( $someHTMLElement2 ); io.remove( $someNodList ); // To remove all elements from the observer io.clear(); Methods add($elements) Add elements to be observed Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; Returns: Type IntersectObserver clear() Stop all elements to be observed Returns: Type IntersectObserver remove($elements) Stop some elements to be observed Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; Returns: Type IntersectObserver Type Definitions IntersectObserver_Handler($target, entry) Parameters: Name Type Description $target HTMLElement entry IntersectionObserverEntry Native IntersectionObserver callback parameter Properties Name Type Description boundingClientRect DOMRectReadOnly { x, y, width, height, top, right, bottom, left } intersectionRatio Number intersectionRect DOMRectReadOnly isIntersecting Boolean rootBounds DOMRectReadOnly target HTMLElement time DOMHighResTimeStamp × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"KeyboardHandler.html":{"id":"KeyboardHandler.html","title":"Class: KeyboardHandler","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: KeyboardHandler KeyboardHandler new KeyboardHandler($element, userOptions) Handle keyboard typing on an elements Parameters: Name Type Description $element HTMLElement userOptions Object Properties Name Type Argument Default Description selector String &lt;optional&gt; Used for event delegation preventDefault Boolean &lt;optional&gt; false Prevent default on all key pressed, except TAB onEnter KeyboardHandler_Callback &lt;optional&gt; onSpace KeyboardHandler_Callback &lt;optional&gt; onSelect KeyboardHandler_Callback &lt;optional&gt; Called when pressing ENTER or SPACE onEscape KeyboardHandler_Callback &lt;optional&gt; onTab KeyboardHandler_Callback &lt;optional&gt; onTabReverse KeyboardHandler_Callback &lt;optional&gt; onRight KeyboardHandler_Callback &lt;optional&gt; Called when pressing RIGHT ARROW KEYS onLeft KeyboardHandler_Callback &lt;optional&gt; Called when pressing LEFT ARROW KEYS onUp KeyboardHandler_Callback &lt;optional&gt; Called when pressing UP ARROW KEYS onDown KeyboardHandler_Callback &lt;optional&gt; Called when pressing DOWN ARROW KEYS onPageUp KeyboardHandler_Callback &lt;optional&gt; onPageDown KeyboardHandler_Callback &lt;optional&gt; onPrevious KeyboardHandler_Callback &lt;optional&gt; Called when pressing LEFT or DOWN arrow keys onNext KeyboardHandler_Callback &lt;optional&gt; Called when pressing RIGHT or UP arrow keys onKey KeyboardHandler_Callback &lt;optional&gt; Called on every key See: For more details, see extra/events.md Example let keyboardControls = new KeyboardHandler( $domElement, options ); // To cancel events watching keyboardControls.off(); Methods off() Remove the binding Returns: Type KeyboardHandler on() Add the binding Returns: Type KeyboardHandler Type Definitions KeyboardHandler_Callback(event, $context) Called when a key is pressed Parameters: Name Type Description event Event $context HTMLElement Targeted DOM element × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"MediaQueriesEvents.html":{"id":"MediaQueriesEvents.html","title":"Class: MediaQueriesEvents","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: MediaQueriesEvents MediaQueriesEvents new MediaQueriesEvents(breakpointsList [, userOptions]) Manage media queries events Parameters: Name Type Argument Description breakpointsList Array.&lt;Breakpoint&gt; userOptions Object &lt;optional&gt; Properties Name Type Argument Default Description unit String &lt;optional&gt; \"px\" Example let mquery = new MediaQueriesEvents( [ \"name\" : \"mob\", \"query\": window.matchMedia( '(max-width:767px)' ) }, { \"name\" : \"tab\", \"query\": window.matchMedia( '(min-width:768px) and (max-width:959px)' ) }, { \"name\" : \"desk\", \"query\": window.matchMedia( '(min-width:960px)' ) } ] ); or let mquery = new MediaQueriesEvents( [ \"name\" : \"mob\", \"max\": 767 }, { \"name\" : \"tab\", \"min\": 768, \"max\": 956 }, { \"name\" : \"desk\", \"max\": 960 } ], { \"unit\": \"px\" // Default value } ); // Register a function to be call when leaving any breakpoint mquery.register( callback, MediaQueriesEvents.TYPE_ON_LEAVE ); // Remove a function to be called mquery.remove( callback ); // Bind a function to be call when entering the \"small\" breakpoint mquery.on( callback, 'small' ); // Same as mquery.on( callback, 'small', MediaQueriesEvents.TYPE_ON_ENTER ); // Unbind the function mquery.off( callback, 'small' ); // Refresh all registered function for the current breakpoint mquery.refresh(); // Call a function with the current breakpoint in parameters. mquery.get( callback ); // Return true if `breakpointName` is the name of the current breakpoint boolean = mquery.is( 'desk' ); // Current active breakpoint myBreakpoint = mquery.currentBreakpoint; // =&gt; {name, query, ...} or false myBreakpoint.is( 'mob' ); // =&gt; true|false myBreakpoint.in( ['mob', 'tab'] ); // =&gt; true|false // List of all breakpoints array = mquery.list; // Check if the current breakpoint is in a list. boolean = mquery.in(['mob', 'tab']); // Pause media queries watch mquery.suspend(); // Resume media queries watch mquery.resume(); Members &lt;static, readonly&gt; TYPE_ON_BOTH :Number Mediaquery both callback type Type: Number &lt;static, readonly&gt; TYPE_ON_ENTER :Number Mediaquery entering callback type Type: Number &lt;static, readonly&gt; TYPE_ON_LEAVE :Number Mediaquery leaving callback type Type: Number &lt;readonly&gt; currentBreakpoint :False|Breakpoint Current active breakpoint Type: False | Breakpoint &lt;readonly&gt; list :Array.&lt;Breakpoint&gt; List of all breakpoints Type: Array.&lt;Breakpoint&gt; Methods get(callback) Call a function with the current breakpoint Parameters: Name Type Description callback function Function to call Returns: Type MediaQueriesEvents getValue(obj) Return the value of the property with the name of the current breakpoint of an object Parameters: Name Type Description obj Object Returns: Type * Example mediaQueryEvent.getValue( { \"small\": \"val1\", \"medium\": \"val2\", ... } ); Ih the current breakpoint name is \"small\", it will return \"val1\" in(breakpointNameList) Check if the current breakpoint is in a list Parameters: Name Type Description breakpointNameList Array.&lt;String&gt; Array of breakpoint name Returns: Type Boolean is(breakpointName) Check if we are in a specific range Parameters: Name Type Description breakpointName String Name of a breakpoint Returns: Type Boolean off(callback, breakpointName) Unbind a function to be called on a specific breakpoint Parameters: Name Type Description callback function Function to remove from the registered function list breakpointName String Name of the breakpoint Returns: Type MediaQueriesEvents on(callback, breakpointName [, type]) Bind a function to be called on a specific breakpoint Parameters: Name Type Argument Default Description callback MediaQueriesEvents_Handler Callback breakpointName String Name of the breakpoint type String &lt;optional&gt; MediaQueriesEvents.TYPE_ON_ENTER Select when the function will be called: when entering the query, when leaving it, or on both Returns: Type MediaQueriesEvents refresh() Force the refresh of all registered function Returns: Type MediaQueriesEvents register(callback [, type]) Register a function to be called on all media queries change Parameters: Name Type Argument Default Description callback MediaQueriesEvents_Handler Function to call on mediaquery change type String &lt;optional&gt; MediaQueriesEvents.TYPE_ON_ENTER Select when the function will be called: when entering the query, when leaving it, or on both Returns: Type MediaQueriesEvents remove(callback) Unregister a function Parameters: Name Type Description callback function Function to remove from the registered function list Returns: Type MediaQueriesEvents resume() Active media queries callback Returns: Type MediaQueriesEvents suspend() Stop media queries callback Returns: Type MediaQueriesEvents which() Return the currentbreakpointsList breakpoint Deprecated: - Use mediaquerisEvent.currentBreakpoint instead Returns: Type False | Breakpoint Type Definitions Breakpoint Properties: Name Type Argument Description name String query Object Object buid with the window.matchMedia() function min Number &lt;optional&gt; mediaquery lower bound max Number &lt;optional&gt; mediaquery upper bound in function Return true if the breakpoint is in the list: breakpoint.in(['bp1', 'bp2']) is function Return true if the name passed to the function is the name of the breakpoint: breakpoint.is('bp1') MediaQueriesEvents_Handler(breakpoint, isMatching) Parameters: Name Type Description breakpoint Breakpoint isMatching Boolean True if we enter the query, false if we leave × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"pubSub.html":{"id":"pubSub.html","title":"Namespace: pubSub","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Namespace: pubSub pubSub Publish / Suscribe event system Example pubSub.init( { \"MY_EVENT_1\": \"myevent1\", \"MY_EVENT_2\": \"myevent2\" } ); pubSub.on( pubSub.MY_EVENT_1, callback ); pubSub.off( pubSub.MY_EVENT_1, callback ); pubSub.fire( pubSub.MY_EVENT_1 ); // You can send data along with the event: pubSub.on( pubSub.MY_EVENT_2, data =&gt; { console.log(data.myProp) } ); pubSub.fire( pubSub.MY_EVENT_2, {myProp: 'test'} ); Methods &lt;static&gt; add(eventsNames) Add events name Parameters: Name Type Description eventsNames Object | String [ \"name1\", \"name2\" ] or \"name1\" Returns: Type PubSub &lt;static&gt; fire(eventName [, data]) Fire an event Parameters: Name Type Argument Description eventName String data Object &lt;optional&gt; Data to be send to the callback functions Returns: Type PubSub &lt;static&gt; init(eventsNames) Initialize all events name Parameters: Name Type Description eventsNames Object { \"name1\": val, \"name2\": val2, ... } Deprecated: Use pubSub.add( [] ) instead Returns: Type PubSub &lt;static&gt; off(eventName, callback) Unbind an event Parameters: Name Type Description eventName String callback function Returns: Type PubSub &lt;static&gt; on(eventName, callback) Bind an event Parameters: Name Type Description eventName String callback function (data) =&gt; {} Returns: Type PubSub × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"TouchHover.html":{"id":"TouchHover.html","title":"Class: TouchHover","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: TouchHover TouchHover new TouchHover(options) Simulate hover (on touch) on mobile device. Touch a second time to follow the link. Parameters: Name Type Description options Object Properties Name Type Description cssClass String selector String $wrapper HTMLEvent Example new TouchHover( { \"cssClass\": 'hover', \"selector\": '.link', \"$wrapper\": $myWrapper } ); Methods destroy() Remove all binded events Returns: Type TouchHover × Search results Close Documentation generated by JSDoc 3.6.4 on 2021-02-03T15:24:32+01:00 using the DocStrap template. "},"WindowEvents.html":{"id":"WindowEvents.html","title":"Class: WindowEvents","body":" Documentation Namespaces pubSub Classes DeviceOrientationHistoryControllerIntersectObserverKeyboardHandlerMediaQueriesEventsTouchHoverWindowEvents Global onAllImagesLoadonAnimationEndonImageLoadonTransitionEnd Class: WindowEvents WindowEvents new WindowEvents($window [, throttleDelay]) Window events handler Parameters: Name Type Argument Default Description $window HTMLElement DOM object on which the events will be checked throttleDelay Number &lt;optional&gt; -1 Throttle delay in ms. If &lt; 0, it use requestAnimationFrame Example let w = new WindowEvents( window ); or to change throttle delay : let w = new WindowEvents( window, 150 ); let callback = ( { windowInfo, scrollInfo, documentInfo, viewportInfo }, type, event ) =&gt; {}; w.register( callback, 'resize' ); // type = 'resize', 'scroll' or undefined for both w.remove( callback, 'resize' ); // Force refresh of all registered function w.refresh( 'scroll' ); // Force the computing scroll position window and document size w.update(); // Call the function w.get( callback ); // Tools { top, left } = w.scrollInfo; { width, height } = w.windowInfo; { width, height } = w.documentInfo; { top, left, bottom, right, width, height } = w.viewportInfo; Members documentInfo :Object { width, height } Type: Object scrollInfo :Object { top, left } Type: Object viewportInfo :Object The viewport is the displayed part of the document. So, its top and left are the scroll position and its width and height are the window size. { top, left, bottom, right, width, height } Type: Object windowInfo :Object { width, height } Type: Object Methods get(callback) Call a function with the last stored positions and sizes Parameters: Name Type Description callback WindowEvents_Handler Returns: Type WindowEvents refresh(type) Refresh all the registered functions Parameters: Name Type Description type String resize | scroll | undefined (both) Returns: Type WindowEvents register(callback, type) Register a function on a type of event Parameters: Name Type Description callback WindowEvents_Handler type String resize | scroll | undefined (both) Returns: Type WindowEvents remove(callback, type) Unregister a function for a type of event Parameters: Name Type Description callback WindowEvents_Handler type String resize | scroll | undefined (both) Returns: Type WindowEvents update(type) Update all the stored data (window size, scroll position, ...) Parameters: Name Type Description type String resize | scroll | undefined (both) Returns: Type WindowEvents Type Definitions WindowEvents_Handler(info, eventType [, originalEvent]) Parameters: Name Type Argument Description info Object Properties Name Type Description windowInfo Object Properties Name Type Description width Number height Number scrollInfo Object Properties Name Type Description top Number left Number documentInfo Object Properties Name Type Description width Number height Number viewportInfo Object Properties Name Type Description top Number left Number bottom Number right Number width Number height Number eventType String resize | scroll | force originalEvent Event &lt;optional&gt; if available × 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/events/events-manager/global.html

@@ -1837,7 +1837,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/events/events-manager/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/events/events-manager/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 firehandlePassiveEventsoffonone Global Members handlePassiveEvents :Boolean Indicate if the browser natively support passive event Type: Boolean Methods fire($elements, options) Fire an event Parameters: Name Type Description $elements HTMLElement | Object | Array.&lt;HTMLElement&gt; | Array.&lt;Object&gt; options Object Properties Name Type Argument Default Description eventsName String Name of events separate by space detail Object &lt;optional&gt; Object to send with the event bubbles Boolean &lt;optional&gt; true Only used for DOMM cancelable Boolean &lt;optional&gt; true Only used for DOMM off($elements, options) Remove an event Parameters: Name Type Description $elements HTMLElement | Object | Array.&lt;HTMLElement&gt; | Array.&lt;Object&gt; options Object Properties Name Type Argument Description eventsName String Name of events separate by space callback function &lt;optional&gt; Callback function on($elements, options) Add an event listener Parameters: Name Type Description $elements HTMLElement | Object | Array.&lt;HTMLElement&gt; | Array.&lt;Object&gt; options Object Properties Name Type Argument Description eventsName String Name of events separate by a space callback function Callback function selector String &lt;optional&gt; Css selector used for event delegation capture Boolean &lt;optional&gt; Active or not capture event. eventOptions Object &lt;optional&gt; Native addEventListener options. Priority to options.capture if it's present. Properties Name Type Argument Description capure Boolean &lt;optional&gt; once Boolean &lt;optional&gt; passive Boolean &lt;optional&gt; one($elements, options) Add an event listener fired only one time Parameters: Name Type Description $elements HTMLElement | Object | Array.&lt;HTMLElement&gt; | Array.&lt;Object&gt; options Object Properties Name Type Argument Description eventsName String Name of events separate by a space selector String &lt;optional&gt; Css selector used for event delegation callback Functio Callback function capture Boolean &lt;optional&gt; Active or not capture event. eventOptions Object &lt;optional&gt; Native addEventListener options. Priority to options.capture if it's present. Properties Name Type Argument Description capure Boolean &lt;optional&gt; once Boolean &lt;optional&gt; passive Boolean &lt;optional&gt; × 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 firehandlePassiveEventsoffonone × 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 firehandlePassiveEventsoffonone Global Members handlePassiveEvents :Boolean Indicate if the browser natively support passive event Type: Boolean Methods fire($elements, options) Fire an event Parameters: Name Type Description $elements HTMLElement | Object | Array.&lt;HTMLElement&gt; | Array.&lt;Object&gt; options Object Properties Name Type Argument Default Description eventsName String Name of events separate by space detail Object &lt;optional&gt; Object to send with the event bubbles Boolean &lt;optional&gt; true Only used for DOMM cancelable Boolean &lt;optional&gt; true Only used for DOMM off($elements, options) Remove an event Parameters: Name Type Description $elements HTMLElement | Object | Array.&lt;HTMLElement&gt; | Array.&lt;Object&gt; options Object Properties Name Type Argument Description eventsName String Name of events separate by space callback function &lt;optional&gt; Callback function on($elements, options) Add an event listener Parameters: Name Type Description $elements HTMLElement | Object | Array.&lt;HTMLElement&gt; | Array.&lt;Object&gt; options Object Properties Name Type Argument Description eventsName String Name of events separate by a space callback function Callback function selector String &lt;optional&gt; Css selector used for event delegation capture Boolean &lt;optional&gt; Active or not capture event. eventOptions Object &lt;optional&gt; Native addEventListener options. Priority to options.capture if it's present. Properties Name Type Argument Description capure Boolean &lt;optional&gt; once Boolean &lt;optional&gt; passive Boolean &lt;optional&gt; one($elements, options) Add an event listener fired only one time Parameters: Name Type Description $elements HTMLElement | Object | Array.&lt;HTMLElement&gt; | Array.&lt;Object&gt; options Object Properties Name Type Argument Description eventsName String Name of events separate by a space selector String &lt;optional&gt; Css selector used for event delegation callback Functio Callback function capture Boolean &lt;optional&gt; Active or not capture event. eventOptions Object &lt;optional&gt; Native addEventListener options. Priority to options.capture if it's present. Properties Name Type Argument Description capure Boolean &lt;optional&gt; once Boolean &lt;optional&gt; passive Boolean &lt;optional&gt; × 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 Global firehandlePassiveEventsoffonone × 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/events/gesture/global.html

@@ -2530,7 +2530,7 @@ gestureHanlder.off();</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/events/gesture/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:32+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/events/gesture/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 gesturegestureOff Global Methods gesture($elements, handlerName, userOptions) Handle touch and mouse event Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; DOM element or DOMList element handlerName String Name of the handler used to retrieve it and unbind events with gestureOff userOptions Object Properties Name Type Argument Default Description selector String &lt;optional&gt; Used for event delegation start gestureEvents_Callback &lt;optional&gt; touchstart, pointerdown, mousedown move gestureEvents_Callback &lt;optional&gt; touchmove, pointermove, mousemove end gestureEvents_Callback &lt;optional&gt; touchend, pointerup, mouseup click gestureEvents_Callback &lt;optional&gt; click tap gestureEvents_Callback &lt;optional&gt; touchend on touch device, click on other swipeLeft gestureCustomEvents_Callback &lt;optional&gt; swipeRight gestureCustomEvents_Callback &lt;optional&gt; swipeUp gestureCustomEvents_Callback &lt;optional&gt; swipeDown gestureCustomEvents_Callback &lt;optional&gt; swipe gestureSwipeEvent_Callback &lt;optional&gt; moveLeft gestureCustomEvents_Callback &lt;optional&gt; moveRight gestureCustomEvents_Callback &lt;optional&gt; moveUp gestureCustomEvents_Callback &lt;optional&gt; moveDown gestureCustomEvents_Callback &lt;optional&gt; threshold Number &lt;optional&gt; 20 In px, minimal distance to do to trigger events useTouch Boolean &lt;optional&gt; true Use all touch, pointer or mouse events, or only click event velocityMax Number &lt;optional&gt; -1 Cap valocity angleThreshold Number &lt;optional&gt; 2 In deg, sensitivity of angle detection preventClick Boolean | function &lt;optional&gt; false Prevent click stopPropagationClick Boolean | function &lt;optional&gt; false Stop propagation of click preventStart Boolean | function &lt;optional&gt; false Prevent touchstart, pointerdown, ... stopPropagationStart Boolean | function &lt;optional&gt; false Stop propagation of touchstart, pointerdown, ... preventMove Boolean | function &lt;optional&gt; false Prevent touchmove, pointermove, ... stopPropagationMove Boolean | function &lt;optional&gt; false Stop propagation of touchmove, pointermove, ... preventEnd Boolean | function &lt;optional&gt; false Prevent touchend, pointerup, ... stopPropagationEnd Boolean | function &lt;optional&gt; false Stop propagation of touchend, pointerup, ... See: For more details, see extra/events.md Returns: - The handler (or array of handlers) to unbind events Type object | Array Example let gestureHanlder = gesture( $element, 'handlerName', options ); // To cancel gestureOff( $element, 'handlerName' ); // or gestureHanlder.off(); gestureOff($elements, handlerName) Remove touch and mouse event Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; DOM element or DOMList element handlerName String Name of the handler to unbind events Example gestureOff( $element, 'handlerName' ); Type Definitions gestureCustomEvents_Callback(e, $target, type) Called when custom event (swipeLeft, swipeUp, moveUp, ... but not swipe) are fired Parameters: Name Type Description e Event Original events $target HTMLElement Targeted element (direct or by delegation) type String Name of the event gestureEvents_Callback(e, $target, coords, type) Called when original events (touchstart, mousedown, pointerdown, ...) are fired Parameters: Name Type Description e Event Original events. For move and end events, e.currentTarget point to document.body. Use the $target param instead. $target HTMLElement Targeted element (direct or by delegation) coords Object Coordinates of the pointer Properties Name Type Description pageX Number pageY Number clientX Number clientY Number mode String touch | mouse | pointer | click type String Name of the event gestureSwipeEvent_Callback(e, $target, type, velocityData) Called when the swipe event is fire Parameters: Name Type Description e Event Original events $target HTMLElement Targeted element (direct or by delegation) type String Name of the event velocityData Object Properties Name Type Description velocity Number Last computed velocity of the movement in px / seconds averageVelocity String Average velocity of the whole movment in px / seconds angle String In deg direction String up | down | left | right | up-right | down-right | up-left |down-left | none × 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 Global gesturegestureOff × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:09+02:00 using the DocStrap template. "}}
+    {"global.html":{"id":"global.html","title":"Global","body":" Documentation Global gesturegestureOff Global Methods gesture($elements, handlerName, userOptions) Handle touch and mouse event Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; DOM element or DOMList element handlerName String Name of the handler used to retrieve it and unbind events with gestureOff userOptions Object Properties Name Type Argument Default Description selector String &lt;optional&gt; Used for event delegation start gestureEvents_Callback &lt;optional&gt; touchstart, pointerdown, mousedown move gestureEvents_Callback &lt;optional&gt; touchmove, pointermove, mousemove end gestureEvents_Callback &lt;optional&gt; touchend, pointerup, mouseup click gestureEvents_Callback &lt;optional&gt; click tap gestureEvents_Callback &lt;optional&gt; touchend on touch device, click on other swipeLeft gestureCustomEvents_Callback &lt;optional&gt; swipeRight gestureCustomEvents_Callback &lt;optional&gt; swipeUp gestureCustomEvents_Callback &lt;optional&gt; swipeDown gestureCustomEvents_Callback &lt;optional&gt; swipe gestureSwipeEvent_Callback &lt;optional&gt; moveLeft gestureCustomEvents_Callback &lt;optional&gt; moveRight gestureCustomEvents_Callback &lt;optional&gt; moveUp gestureCustomEvents_Callback &lt;optional&gt; moveDown gestureCustomEvents_Callback &lt;optional&gt; threshold Number &lt;optional&gt; 20 In px, minimal distance to do to trigger events useTouch Boolean &lt;optional&gt; true Use all touch, pointer or mouse events, or only click event velocityMax Number &lt;optional&gt; -1 Cap valocity angleThreshold Number &lt;optional&gt; 2 In deg, sensitivity of angle detection preventClick Boolean | function &lt;optional&gt; false Prevent click stopPropagationClick Boolean | function &lt;optional&gt; false Stop propagation of click preventStart Boolean | function &lt;optional&gt; false Prevent touchstart, pointerdown, ... stopPropagationStart Boolean | function &lt;optional&gt; false Stop propagation of touchstart, pointerdown, ... preventMove Boolean | function &lt;optional&gt; false Prevent touchmove, pointermove, ... stopPropagationMove Boolean | function &lt;optional&gt; false Stop propagation of touchmove, pointermove, ... preventEnd Boolean | function &lt;optional&gt; false Prevent touchend, pointerup, ... stopPropagationEnd Boolean | function &lt;optional&gt; false Stop propagation of touchend, pointerup, ... See: For more details, see extra/events.md Returns: - The handler (or array of handlers) to unbind events Type object | Array Example let gestureHanlder = gesture( $element, 'handlerName', options ); // To cancel gestureOff( $element, 'handlerName' ); // or gestureHanlder.off(); gestureOff($elements, handlerName) Remove touch and mouse event Parameters: Name Type Description $elements HTMLElement | Array.&lt;HTMLElement&gt; DOM element or DOMList element handlerName String Name of the handler to unbind events Example gestureOff( $element, 'handlerName' ); Type Definitions gestureCustomEvents_Callback(e, $target, type) Called when custom event (swipeLeft, swipeUp, moveUp, ... but not swipe) are fired Parameters: Name Type Description e Event Original events $target HTMLElement Targeted element (direct or by delegation) type String Name of the event gestureEvents_Callback(e, $target, coords, type) Called when original events (touchstart, mousedown, pointerdown, ...) are fired Parameters: Name Type Description e Event Original events. For move and end events, e.currentTarget point to document.body. Use the $target param instead. $target HTMLElement Targeted element (direct or by delegation) coords Object Coordinates of the pointer Properties Name Type Description pageX Number pageY Number clientX Number clientY Number mode String touch | mouse | pointer | click type String Name of the event gestureSwipeEvent_Callback(e, $target, type, velocityData) Called when the swipe event is fire Parameters: Name Type Description e Event Original events $target HTMLElement Targeted element (direct or by delegation) type String Name of the event velocityData Object Properties Name Type Description velocity Number Last computed velocity of the movement in px / seconds averageVelocity String Average velocity of the whole movment in px / seconds angle String In deg direction String up | down | left | right | up-right | down-right | up-left |down-left | none × 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 Global gesturegestureOff × 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/array/global.html

@@ -782,7 +782,7 @@ modifiedArray = unique( array, (currentValue, returnArray) => { return !retur
 <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/helpers/array/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/helpers/array/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 insertsliceunique Global Methods insert(list, what, where) Insert a value or an object in a list Parameters: Name Type Description list Array what * where Number Index Returns: - Modified array Type Array Example modifiedArray = insert( array, obj, 2 ) slice(list, what) Remove an object from a list Parameters: Name Type Description list Array what * Returns: - Modified list Type Array Example modifiedArray = slice( list, obj ) unique(list [, filter]) Remove all duplicate from a list Parameters: Name Type Argument Description list Array filter function &lt;optional&gt; Optionnal, (currentItem, returnArray) =&gt; { should return true or false } Returns: Type Array Example // Using the native includes function modifiedArray = unique( array ) // With custom function (here, same as default behaviour) modifiedArray = unique( array, (currentValue, returnArray) =&gt; { return !returnArray.includes(currentValue) } ) × 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 Global insertsliceunique × Search results Close Documentation generated by JSDoc 3.6.4 on 2020-07-28T16:49:09+02:00 using the DocStrap template. "}}
+    {"global.html":{"id":"global.html","title":"Global","body":" Documentation Global insertsliceunique Global Methods insert(list, what, where) Insert a value or an object in a list Parameters: Name Type Description list Array what * where Number Index Returns: - Modified array Type Array Example modifiedArray = insert( array, obj, 2 ) slice(list, what) Remove an object from a list Parameters: Name Type Description list Array what * Returns: - Modified list Type Array Example modifiedArray = slice( list, obj ) unique(list [, filter]) Remove all duplicate from a list Parameters: Name Type Argument Description list Array filter function &lt;optional&gt; Optionnal, (currentItem, returnArray) =&gt; { should return true or false } Returns: Type Array Example // Using the native includes function modifiedArray = unique( array ) // With custom function (here, same as default behaviour) modifiedArray = unique( array, (currentValue, returnArray) =&gt; { return !returnArray.includes(currentValue) } ) × 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 Global insertsliceunique × 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/helpers/colors/global.html

@@ -2507,7 +2507,7 @@ splitRGBA( &#x27;rgba(125 ,233, 105, 0.75)&#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:30+01:00
 	
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

package/documentation/jsdocs/helpers/colors/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/colors/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 darkenformatHexColorformatRGBAColorhexToRgbaisHexColorisRGBAlightenrgbaToHexshadeBlendsplitHexColorsplitRGBA Global Methods darken(color, percent [, render]) Darken a color Parameters: Name Type Argument Default Description color String rgb or hex string percent Number Percent (between 0 and 1) render String &lt;optional&gt; obj render type: obj, hex or rgba Returns: Type Color_object formatHexColor(color) Format an object color to an hex color Parameters: Name Type Description color Color_Object Returns: Type String Example formatHexColor( color ); formatRGBAColor(color) Format an object color to an rgba color Parameters: Name Type Description color Color_Object Returns: Type String Example formatRGBAColor( color ); hexToRgba(hex) Convert a hex string to a rgba string Parameters: Name Type Description hex String Returns: Type String Example hexToRgba( '#F5C' ); hexToRgba( '#F5B3D8' ); isHexColor(hexColor) Return true if the string is an hexadecimal color Parameters: Name Type Description hexColor String Returns: Type Boolean Example isHexColor( '#FFF' ); isHexColor( '#55CC66' ); isHexColor( '#55CC66FF' ); isRGBA(rgba) Return true if the string is an rgb or rgba color Parameters: Name Type Description rgba String Returns: Type Boolean Example isRGBA( 'rgb(125 ,233, 105)' ); isRGBA( 'rgba(125 ,233, 105, 0.25)' ); lighten(color, percent [, render]) Lighten a color Parameters: Name Type Argument Default Description color String rgb or hex string percent Number Percent (between 0 and 1) render String &lt;optional&gt; obj render type: obj, hex or rgba Returns: Type Color_object rgbaToHex(rgba) Convert a rgba string to a hex string Parameters: Name Type Description rgba String Returns: Type String Example rgbaToHex( 'rgb(125 ,233, 105)' ); rgbaToHex( 'rgba(125 ,233, 105, 0.25)' ); shadeBlend(color1, color2, percent [, render]) Darken, lighten one color or blend 2 colors together Parameters: Name Type Argument Default Description color1 String rgb or hex string color2 String | null rgb or hex string percent Number Percent (between -1 and 1) render String &lt;optional&gt; obj render type: obj, hex or rgba Returns: Type Color_Object | String Example var color1 = \"#FF343B\"; var color2 = \"#343BFF\"; var color3 = \"rgb(234,47,120)\"; var color4 = \"rgb(120,99,248)\"; // Lighten color var shadedcolor1 = shadeBlend( color1, null, 0.75 ); // Darken color var shadedcolor3 = shadeBlend( color3, null, -0.5 ); // Blend 2 colors var blendedcolor1 = shadeBlend( color1, color2, 0.333 ); var blendedcolor34 = shadeBlend( color3, color4, -0.8 ); splitHexColor(hexColor) Split an hexadecimal color Parameters: Name Type Description hexColor String Returns: Type Color_Object Example splitHexColor( '#F5A' ); splitHexColor( '#FA58AC' ); // With alpha splitHexColor( '#FA58ACCC' ); splitRGBA(rgba) Split an rgb or rgba color Parameters: Name Type Description rgba String Returns: Type Color_Object Example splitRGBA( 'rgb(125 ,233, 105)' ); splitRGBA( 'rgba(125 ,233, 105, 0.75)' ); Type Definitions Color_Object Type: Object Properties: Name Type Description r Number g Number b Number a Number hr String hg String hb String ha 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 darkenformatHexColorformatRGBAColorhexToRgbaisHexColorisRGBAlightenrgbaToHexshadeBlendsplitHexColorsplitRGBA × 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 darkenformatHexColorformatRGBAColorhexToRgbaisHexColorisRGBAlightenrgbaToHexshadeBlendsplitHexColorsplitRGBA Global Methods darken(color, percent [, render]) Darken a color Parameters: Name Type Argument Default Description color String rgb or hex string percent Number Percent (between 0 and 1) render String &lt;optional&gt; obj render type: obj, hex or rgba Returns: Type Color_object formatHexColor(color) Format an object color to an hex color Parameters: Name Type Description color Color_Object Returns: Type String Example formatHexColor( color ); formatRGBAColor(color) Format an object color to an rgba color Parameters: Name Type Description color Color_Object Returns: Type String Example formatRGBAColor( color ); hexToRgba(hex) Convert a hex string to a rgba string Parameters: Name Type Description hex String Returns: Type String Example hexToRgba( '#F5C' ); hexToRgba( '#F5B3D8' ); isHexColor(hexColor) Return true if the string is an hexadecimal color Parameters: Name Type Description hexColor String Returns: Type Boolean Example isHexColor( '#FFF' ); isHexColor( '#55CC66' ); isHexColor( '#55CC66FF' ); isRGBA(rgba) Return true if the string is an rgb or rgba color Parameters: Name Type Description rgba String Returns: Type Boolean Example isRGBA( 'rgb(125 ,233, 105)' ); isRGBA( 'rgba(125 ,233, 105, 0.25)' ); lighten(color, percent [, render]) Lighten a color Parameters: Name Type Argument Default Description color String rgb or hex string percent Number Percent (between 0 and 1) render String &lt;optional&gt; obj render type: obj, hex or rgba Returns: Type Color_object rgbaToHex(rgba) Convert a rgba string to a hex string Parameters: Name Type Description rgba String Returns: Type String Example rgbaToHex( 'rgb(125 ,233, 105)' ); rgbaToHex( 'rgba(125 ,233, 105, 0.25)' ); shadeBlend(color1, color2, percent [, render]) Darken, lighten one color or blend 2 colors together Parameters: Name Type Argument Default Description color1 String rgb or hex string color2 String | null rgb or hex string percent Number Percent (between -1 and 1) render String &lt;optional&gt; obj render type: obj, hex or rgba Returns: Type Color_Object | String Example var color1 = \"#FF343B\"; var color2 = \"#343BFF\"; var color3 = \"rgb(234,47,120)\"; var color4 = \"rgb(120,99,248)\"; // Lighten color var shadedcolor1 = shadeBlend( color1, null, 0.75 ); // Darken color var shadedcolor3 = shadeBlend( color3, null, -0.5 ); // Blend 2 colors var blendedcolor1 = shadeBlend( color1, color2, 0.333 ); var blendedcolor34 = shadeBlend( color3, color4, -0.8 ); splitHexColor(hexColor) Split an hexadecimal color Parameters: Name Type Description hexColor String Returns: Type Color_Object Example splitHexColor( '#F5A' ); splitHexColor( '#FA58AC' ); // With alpha splitHexColor( '#FA58ACCC' ); splitRGBA(rgba) Split an rgb or rgba color Parameters: Name Type Description rgba String Returns: Type Color_Object Example splitRGBA( 'rgb(125 ,233, 105)' ); splitRGBA( 'rgba(125 ,233, 105, 0.75)' ); Type Definitions Color_Object Type: Object Properties: Name Type Description r Number g Number b Number a Number hr String hg String hb String ha 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 darkenformatHexColorformatRGBAColorhexToRgbaisHexColorisRGBAlightenrgbaToHexshadeBlendsplitHexColorsplitRGBA × 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/helpers/common/Cookie.html

@@ -167,7 +167,7 @@
         
     <pre class="sunlight-highlight-javascript">cookie.create( &#x27;cookieName&#x27;, &#x27;cookieValue&#x27; )
 cookie.read( &#x27;cookieName&#x27; )
-cookie.erase( &#x27;cookieName&#x27; )
+cookie.delete( &#x27;cookieName&#x27; )
 
 // All parameters
 cookie.create( &#x27;cookieName&#x27;, &#x27;cookieValue&#x27;, {
@@ -397,7 +397,7 @@ cookie.create( &#x27;cookieName&#x27;, &#x27;cookieValue&#x27;, {
 <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/UrlParser.html

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

package/documentation/jsdocs/helpers/common/classes.list.html

@@ -205,7 +205,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>