From 65824a6b6b190a69e8b89059335f7a29d302e1f9 Mon Sep 17 00:00:00 2001 From: IguhSoares Date: Wed, 23 Nov 2022 19:10:20 -0300 Subject: [PATCH 1/5] docs: update jsdoc documentation --- jsdoc/doc/animate.js.html | 88 +- jsdoc/doc/globals.js.html | 88 +- jsdoc/doc/index.html | 104 +- jsdoc/doc/js-css-animations.js.html | 88 +- jsdoc/doc/measurements.js.html | 88 +- jsdoc/doc/module-animate.html | 5999 +++++++---------------- jsdoc/doc/module-globals.html | 761 +-- jsdoc/doc/module-js-css-animations.html | 2815 ++++------- jsdoc/doc/module-resize-parent.html | 1635 ++---- jsdoc/doc/module-transitions.html | 1237 ++--- jsdoc/doc/resize-parent.js.html | 88 +- jsdoc/doc/transitions.js.html | 88 +- 12 files changed, 4090 insertions(+), 8989 deletions(-) diff --git a/jsdoc/doc/animate.js.html b/jsdoc/doc/animate.js.html index fd55d28..934733d 100644 --- a/jsdoc/doc/animate.js.html +++ b/jsdoc/doc/animate.js.html @@ -1,32 +1,29 @@ - - + + JSDoc: Source: animate.js - - + + - - - - - - -
- -

Source: animate.js

- - - - - - -
+ + + + + +
+

Source: animate.js

+ +
- 
/**
+          
/**
  * Handles all the animation process
  * @module animate
  */
@@ -674,24 +671,33 @@ 
Source: animate.js

 };
-
- - - - -
- - - -
- -
- Documentation generated by JSDoc 4.0.0 on Wed Nov 23 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) -
- - - - +
+
+ + + +
+ +
+ Documentation generated by + JSDoc 4.0.0 on Wed Nov 23 + 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) +
+ + + + diff --git a/jsdoc/doc/globals.js.html b/jsdoc/doc/globals.js.html index 1986313..4f0c41c 100644 --- a/jsdoc/doc/globals.js.html +++ b/jsdoc/doc/globals.js.html @@ -1,32 +1,29 @@ - - + + JSDoc: Source: globals.js - - + + - - - - - - -
- -

Source: globals.js

- - - - - - -
+ + + + + +
+

Source: globals.js

+ +
- 
/**
+          
/**
  * Global Objects
  * @module globals
  */
@@ -179,24 +176,33 @@ 
Source: globals.js

 );
-
- - - - -
- - - -
- -
- Documentation generated by JSDoc 4.0.0 on Wed Nov 23 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) -
- - - - +
+
+ + + +
+ +
+ Documentation generated by + JSDoc 4.0.0 on Wed Nov 23 + 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) +
+ + + + diff --git a/jsdoc/doc/index.html b/jsdoc/doc/index.html index aee39ac..6ae5f83 100644 --- a/jsdoc/doc/index.html +++ b/jsdoc/doc/index.html @@ -1,65 +1,53 @@ - - + + JSDoc: JS-CSS Animations - - + + - - - - - - -
- -

JS-CSS Animations

- - - - - - - - -

- - - - - - - - - - - - - - - - - - - - -
- - - -
- -
- Documentation generated by JSDoc 4.0.0 on Wed Nov 23 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) -
- - - - - \ No newline at end of file + + + + + +
+

JS-CSS Animations

+ +

+
+ + + +
+ +
+ Documentation generated by + JSDoc 4.0.0 on Wed Nov 23 + 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) +
+ + + + + diff --git a/jsdoc/doc/js-css-animations.js.html b/jsdoc/doc/js-css-animations.js.html index 63c445d..959d5e0 100644 --- a/jsdoc/doc/js-css-animations.js.html +++ b/jsdoc/doc/js-css-animations.js.html @@ -1,32 +1,29 @@ - - + + JSDoc: Source: js-css-animations.js - - + + - - - - - - -
- -

Source: js-css-animations.js

- - - - - - -
+ + + + + +
+

Source: js-css-animations.js

+ +
- 
/**
+          
/**
  * Builds the animation API that will be exported to the final user
  * @module js-css-animations
  */
@@ -389,24 +386,33 @@ 
Source: js-css-animations.js

 export default jsCssAnimations;
-
- - - - -
- - - -
- -
- Documentation generated by JSDoc 4.0.0 on Wed Nov 23 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) -
- - - - +
+
+ + + +
+ +
+ Documentation generated by + JSDoc 4.0.0 on Wed Nov 23 + 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) +
+ + + + diff --git a/jsdoc/doc/measurements.js.html b/jsdoc/doc/measurements.js.html index 99b7a79..21233bd 100644 --- a/jsdoc/doc/measurements.js.html +++ b/jsdoc/doc/measurements.js.html @@ -1,32 +1,29 @@ - - + + JSDoc: Source: measurements.js - - + + - - - - - - -
- -

Source: measurements.js

- - - - - - -
+ + + + + +
+

Source: measurements.js

+ +
- 
/**
+          
/**
  * Handle element's width and height calculations
  * so that, when an element's visibility changes,
  * parent element's dimensions can be properly transitioned
@@ -259,24 +256,33 @@ 
Source: measurements.js

 export { getParentMeasures, setParentMaxMeasures, removeDimensionMax };
-
- - - - -
- - - -
- -
- Documentation generated by JSDoc 4.0.0 on Wed Nov 23 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) -
- - - - +
+
+ + + +
+ +
+ Documentation generated by + JSDoc 4.0.0 on Wed Nov 23 + 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) +
+ + + + diff --git a/jsdoc/doc/module-animate.html b/jsdoc/doc/module-animate.html index e0741b3..6f84d37 100644 --- a/jsdoc/doc/module-animate.html +++ b/jsdoc/doc/module-animate.html @@ -1,4311 +1,1834 @@ - - + + JSDoc: Module: animate - - + + - - - - - - -
- -

Module: animate

- - - - - - -
- -
- -
- -
-
- - -

Handles all the animation process

- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - -
- - - - - - - - - - - - - - -

Members

- - - -

(static, constant) removeCustomCssProperties

- - - - -
-

Removes the CSS properties customized by the user

-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(static, constant) setCssProperty

- - - - -
-

Sets an inline CSS property

-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
- -
- - - -
- - - - - - - - -

(inner, constant) CALLBACK_TRACKER :Object

- - - - -
-

Keeps track of the callbacks being executed, preventing the callbacks to be executed -multiple times if multiple elements are being animated by a single trigger.

-

When an element triggers an animation, no matter how many elements are being animated, -the start() and complete() callbacks should each be executed only once.

-
- - - -
Type:
-
    -
  • - -Object - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(inner, constant) CONFIG :Object.<string, any>

- - - - -
-

Object that handles configurations, either customized by the user -or default values defined in 'configurations.default' object

-
- - - -
Type:
-
    -
  • - -Object.<string, any> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
-
    -
  • configurations
    • -
-
- - - -
- - - - - - - - -

(inner, constant) DURATION_REGEX

- - - - -
-

Matches duration or delay CSS properties values

-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(inner, constant) TARGETS_STACK :Object

- - - - -
-

Keeps track of all the targets being animated to ensure that the callback tracker -will be removed only when all the targets have been animated. Also ensures that -all targets will be re-enabled only when all targets have already been animated.

-
- - - -
Type:
-
    -
  • - -Object - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(inner, constant) configHandler

- - - - -
-

ProxyHandler passed to the 'CONFIG' object to ensure that -if an option is not customized by the user, the default value set -in 'configurations.default' will be returned instead.

-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
-
    -
  • CONFIG
    • - -
  • configurations
    • -
-
- - - -
- - - - - - - - -

(inner, constant) configurations :Object.<string, any>

- - - - -
-

Contains the default value for each custom option. -Those values can be overwritten by the user by calling jsCssAnimations.config() -and passing new default values for all the animations.

-
- - - -
Type:
-
    -
  • - -Object.<string, any> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(inner) trigger

- - - - -
-

bubbles up untill the attribute is found

-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - -

Methods

- - - - - - - -

(inner) animate(element, action, id, opts)

- - - - - - -
-

Handles all the animation process

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
element - - -HTMLElement - - - -

The DOM element to animate

action - - -string - - - -

'show', 'hide', or 'move'

id - - -number - - - -

ID of an animation in the *_ANIMS_ID objects

opts - - -Object.<string, any> - - - -

All the options passed by the user

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
- -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) disable(element)

- - - - - - -
-

Sets an attribute to indicate that the element is currently being animated -and so can not perform any other animations

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
element - - -HTMLElement - - - -

The DOM element being animated

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) enable(element)

- - - - - - -
-

Removes the attribute that indicates that an element is currently being animated

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
element - - -HTMLElement - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) endVisibilityToggle(element, opts)

- - - - - - -
-

Adds the hidden or collapsed class, when necessary. -Finalize parent element's resize operations, if needed.

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
element - - -HTMLElement - - - -

The DOM element being animated

opts - - -Object - - - -

All the necessary options

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) eventHandler(el, animationId, opts)

- - - - - - -
-

Generates the handler function to be passed to the event listener

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
el - - -HTMLElement - - - -

The DOM element being animated

animationId - - -number - - - -

The ID of the animation in the *_ANIMS_ID

opts - - -Object - - - -

The options passed by the user

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
- -
- - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

A function to be passed to the addEventListener() as a handler

-
- - - - - - - - - - - - - - - -

(inner) getAction(element, animType)

- - - - - - -
-

Checks which animation CSS class is set to determine wich action to perform next

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
element - - -HTMLElement - - - -

The DOM element being animated

animType - - -* - - - -

Either 'motion' or 'visibility'

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

'show' or 'hide' or 'move' or 'moveBack'

-
- - - - - - - - - - - - - - - -

(inner) getTargetSelector(eventTarget)

- - - - - - -
-

Searches and returns the 'target-selector' attribute

-

If the element which triggered the event doesn't have the attribute, -will bubbles up untill the attribute is found. -If no attribute is found, an empty string is returned and so -no element will be selected to be animated

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
eventTarget - - -HTMLElement - - - -

The DOM element wich triggers the event

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

The CSS selector for the animation target(s) or an empty string

-
- - - - - - - - - - - - - - - -

(inner) getTimeInMs(value)

- - - - - - -
-

Removes the unit from the duration or delay and returns the value in milliseconds

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
value - - -string - - - -

duration or delay CSS property value

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

The duration or delay in milliseconds

-
- - - - - - - - - - - - - - - -

(inner) getTotalAnimTime(element)

- - - - - - -
-

Returns an object with the duration and delay time in milliseconds

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
element - - -HTMLElement - - - -

The DOM element being animated

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

Both the duration and delay, in milliseconds

-
- - - - - - - - - - - - - - - -

(inner) handleVisibilityToggle(element, args)

- - - - - - -
-

Sets the parent element dimensions, if needed.

-

Removes the collapsed or hidden class from the element, when necessary

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
element - - -HTMLElement - - - -

The DOM element being animated

args - - -Object - - - -

All the necessary arguments

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) hasIterationProp(element)

- - - - - - -
-

Verifies if an element has defined an iteration CSS property

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
element - - -HTMLElement - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

True if the element has an iteration CSS property set, False otherwise

-
- - - - - - - - - - - - - - - -

(inner) init(trigger)

- - - - - - -
-

Initiates the tracker

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
trigger - - -string - - - -

A CSS selector representing the element which triggered the animation

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) init(animationId, opts)

- - - - - - -
-

Initiate the event listener with the animation

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
animationId - - -number - - - -

The ID of the animation in *_ANIMS_ID object

opts - - -Object - - - -

All options passed by the user

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
- -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) initCallback(trigger, fn, type)

- - - - - - -
-

Executes a given callback, checking, when necessary, if the callback was already -executed by another element being animated by the same trigger button

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
trigger - - -string - - - -

The CSS selector of the element that triggered the animation

fn - - -function - - - -

The callback to execute

type - - -string - - - -

Either 'start' or 'complete'

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) isEnabled(element)

- - - - - - -
-

Verifies if an element is already being animated or not

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
element - - -HTMLElement - - - -

The DOM element to check

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

True if the element is not currently being animated

-
- - - - - - - - - - - - - - - -

(inner) isMotion(animType)

- - - - - - -
-

Returns true if the animation type is 'motion'

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
animType - - -string - - - -

Either 'motion' or 'visibility'

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

True if animation type is 'motion'. False otherwise.

-
- - - - - - - - - - - - - - - -

(inner) isVisibility(animType)

- - - - - - -
-

Returns true if the animation type is 'visibility'

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
animType - - -string - - - -

Either 'motion' or 'visibility'

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

True if animation type is 'visibility'. False otherwise.

-
- - - - - - - - - - - - - - - -

(inner) preset(el, args)

- - - - - - -
-

Sets the CSS properties customized by the user, -prior to the begining of the animation

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
el - - -HTMLElement - - - -

The DOM element being animated

args - - -Object - - - -

The animation's ID and type and all the options passed by the user

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) remove(trigger)

- - - - - - -
-

Removes 'trigger' from the tracker

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
trigger - - -string - - - -

A CSS selector representing the element which triggered the animation

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) removeMotionCssClass(element)

- - - - - - -
-

Removes the current motion animation CSS class from the element

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - + + + + + +
+

Module: animate

+ +
+
+ +
+
+
+

Handles all the animation process

+
+ +
+
Source:
+
+ +
+
+
+ +

Members

+ +

+ (static, constant) removeCustomCssProperties +

+ +
+

Removes the CSS properties customized by the user

+
+ +
+
Source:
+
+ +
+
+ +

+ (static, constant) setCssProperty +

+ +
+

Sets an inline CSS property

+
+ +
+
Source:
+
+ +
+ +
See:
+
+ +
+
+ +

+ (inner, constant) CALLBACK_TRACKER :Object +

+ +
+

+ Keeps track of the callbacks being executed, preventing the + callbacks to be executed multiple times if multiple elements are + being animated by a single trigger. +

+

+ When an element triggers an animation, no matter how many elements + are being animated, the start() and complete() callbacks should + each be executed only once. +

+
+ +
Type:
+
    +
  • + Object +
    • +
+ +
+
Source:
+
+ +
+
+ +

+ (inner, constant) CONFIG + :Object.<string, any> +

+ +
+

+ Object that handles configurations, either customized by the user + or default values defined in 'configurations.default' object +

+
+ +
Type:
+
    +
  • + Object.<string, any> +
    • +
+ +
+
Source:
+
+ +
+ +
See:
+
+
    +
  • configurations
    • +
+
+
+ +

+ (inner, constant) DURATION_REGEX +

+ +
+

Matches duration or delay CSS properties values

+
+ +
+
Source:
+
+ +
+
+ +

+ (inner, constant) TARGETS_STACK :Object +

+ +
+

+ Keeps track of all the targets being animated to ensure that the + callback tracker will be removed only when all the targets have + been animated. Also ensures that all targets will be re-enabled + only when all targets have already been animated. +

+
+ +
Type:
+
    +
  • + Object +
    • +
+ +
+
Source:
+
+ +
+
+ +

+ (inner, constant) configHandler +

+ +
+

+ ProxyHandler passed to the 'CONFIG' object to ensure that if an + option is not customized by the user, the default value set in + 'configurations.default' will be returned instead. +

+
+ +
+
Source:
+
+ +
+ +
See:
+
+
    +
  • CONFIG
    • + +
  • configurations
    • +
+
+
+ +

+ (inner, constant) configurations + :Object.<string, any> +

+ +
+

+ Contains the default value for each custom option. Those values + can be overwritten by the user by calling jsCssAnimations.config() + and passing new default values for all the animations. +

+
+ +
Type:
+
    +
  • + Object.<string, any> +
    • +
+ +
+
Source:
+
+ +
+
+ +

+ (inner) trigger +

+ +
+

bubbles up untill the attribute is found

+
+ +
+
Source:
+
+ +
+
+ +

Methods

+ +

+ (inner) animate(element, action, id, opts) +

+ +
+

Handles all the animation process

+
+ +
Parameters:
+ +
NameTypeDescription
+ + + + + + + + + + + + - - - - - - - - - - - - - -
NameTypeDescription
element - - -HTMLElement - - - -

The DOM element being animated

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) resetDefaultConfig()

- - - - - - -
-

Reset the configurations to its default values -by removing from 'CONFIG' all options customized by the user

-
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
-
    -
  • CONFIG
    • -
-
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) updateCssProperties(element, opts)

- - - + + HTMLElement + + +

The DOM element to animate

+ + -
-

Sets the CSS properties customized by the user in the animation function's options

-
- - - - - - - - - -
Parameters:
- + + action - - - - - - + - + + - + + - + - - - + + - - + + - - + + + + + +
Name + string + Type +

'show', 'hide', or 'move'

+
id + number + Description
+

ID of an animation in the *_ANIMS_ID objects

+
opts
+ Object.<string, any> + +

All the options passed by the user

+
+ +
+
Source:
+
+ +
+ +
See:
+
+ +
+
+ +

+ (inner) disable(element) +

+ +
+

+ Sets an attribute to indicate that the element is currently being + animated and so can not perform any other animations +

+
+ +
Parameters:
+ + + + + + + + + + + + + + - - - - + + + + + +
NameTypeDescription
element - - -HTMLElement - - - - + HTMLElement + +

The DOM element being animated

+
+ +
+
Source:
+
+ +
+
+ +

+ (inner) enable(element) +

+ +
+

+ Removes the attribute that indicates that an element is currently + being animated +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + - + + + + + +
NameTypeDescription
element + HTMLElement +
+ +
+
Source:
+
+ +
+
+ +

+ (inner) endVisibilityToggle(element, opts) +

+ +
+

+ Adds the hidden or collapsed class, when necessary. Finalize + parent element's resize operations, if needed. +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + - - + - + + - - + - - - - - - - - - - - - - -
NameTypeDescription
element

The DOM element to update the CSS Properties

+ HTMLElement + +

The DOM element being animated

+
opts - - -Object.<string, string> - - - -

Object containing a custom property key and a CSS value to be updated

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - + + Object + + + +

All the necessary options

+ + + + + +
+
Source:
+
+ +
+
+ +

+ (inner) eventHandler(el, animationId, opts) +

+ +
+

+ Generates the handler function to be passed to the event listener +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + - - - - - - -

(inner) updateDefaultConfig(opts)

- - - - - - -
-

Customize the default animations configurations by overwriting -the 'CONFIG' values

-
- - - - - - - - - -
Parameters:
- - -
NameTypeDescription
el
- - - - - - - + - + + - + + - - - + - - + + - - + - - - - - - - - - - - - - -
NameType + HTMLElement + +

The DOM element being animated

+
animationIdDescription
+ number +
+

The ID of the animation in the *_ANIMS_ID

+
opts - - -Object - - - -

All the options customized by the user

- - - - - - -
- - - - - - - - - - - - - - - + + Object + + + +

The options passed by the user

+ + + + + +
+
Source:
+
+ +
+ +
See:
+
+ +
+
+ +
Returns:
+ +
+

+ A function to be passed to the addEventListener() as a handler +

+
+ +

+ (inner) getAction(element, animType) +

+ +
+

+ Checks which animation CSS class is set to determine wich action + to perform next +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + - + - + + - + + - + + + + + +
NameTypeDescription
element + HTMLElement + +

The DOM element being animated

+
animType + * + +

Either 'motion' or 'visibility'

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

'show' or 'hide' or 'move' or 'moveBack'

+
+ +

+ (inner) getTargetSelector(eventTarget) +

+ +
+

Searches and returns the 'target-selector' attribute

+

+ If the element which triggered the event doesn't have the + attribute, will bubbles up untill the attribute is found. If no + attribute is found, an empty string is returned and so no element + will be selected to be animated +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + - -
Source:
-
- + + + + + +
NameTypeDescription
eventTarget + HTMLElement + +

The DOM element wich triggers the event

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

+ The CSS selector for the animation target(s) or an empty string +

+
+ +

+ (inner) getTimeInMs(value) +

+ +
+

+ Removes the unit from the duration or delay and returns the value + in milliseconds +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + - + + + + + +
NameTypeDescription
value + string + +

duration or delay CSS property value

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

The duration or delay in milliseconds

+
+ +

+ (inner) getTotalAnimTime(element) +

+ +
+

+ Returns an object with the duration and delay time in milliseconds +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + - -
See:
-
-
    -
  • CONFIG
    • -
-
- + + + + + +
NameTypeDescription
element + HTMLElement + +

The DOM element being animated

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

Both the duration and delay, in milliseconds

+
+ +

+ (inner) handleVisibilityToggle(element, args) +

+ +
+

Sets the parent element dimensions, if needed.

+

+ Removes the collapsed or hidden class from the element, when + necessary +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + - - + + + + + + + + + + +
NameTypeDescription
element + HTMLElement + +

The DOM element being animated

+
args + Object + +

All the necessary arguments

+
+ +
+
Source:
+
+ +
+
+ +

+ (inner) hasIterationProp(element) +

+ +
+

Verifies if an element has defined an iteration CSS property

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
element + HTMLElement +
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

+ True if the element has an iteration CSS property set, False + otherwise +

+
+ +

+ (inner) init(trigger) +

+ +
+

Initiates the tracker

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
trigger + string + +

+ A CSS selector representing the element which triggered the + animation +

+
+ +
+
Source:
+
+ +
+
+ +

+ (inner) init(animationId, opts) +

+ +
+

Initiate the event listener with the animation

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
animationId + number + +

The ID of the animation in *_ANIMS_ID object

+
opts + Object + +

All options passed by the user

+
+ +
+
Source:
+
+ +
+ +
See:
+
+ +
+
+ +

+ (inner) initCallback(trigger, fn, type) +

+ +
+

+ Executes a given callback, checking, when necessary, if the + callback was already executed by another element being animated by + the same trigger button +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
trigger + string + +

+ The CSS selector of the element that triggered the animation +

+
fn + function +

The callback to execute

type + string + +

Either 'start' or 'complete'

+
+ +
+
Source:
+
+ +
+
+ +

+ (inner) isEnabled(element) +

+ +
+

Verifies if an element is already being animated or not

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
element + HTMLElement + +

The DOM element to check

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

True if the element is not currently being animated

+
+ +

+ (inner) isMotion(animType) +

+ +
+

Returns true if the animation type is 'motion'

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
animType + string + +

Either 'motion' or 'visibility'

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

True if animation type is 'motion'. False otherwise.

+
+ +

+ (inner) isVisibility(animType) +

+ +
+

Returns true if the animation type is 'visibility'

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
animType + string + +

Either 'motion' or 'visibility'

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

True if animation type is 'visibility'. False otherwise.

+
+ +

+ (inner) preset(el, args) +

+ +
+

+ Sets the CSS properties customized by the user, prior to the + begining of the animation +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + - - + - + + - - + + - + + + + + +
NameTypeDescription
el + HTMLElement + +

The DOM element being animated

+
args + Object + +

+ The animation's ID and type and all the options passed by + the user +

+
+ +
+
Source:
+
+ +
+
+ +

+ (inner) remove(trigger) +

+ +
+

Removes 'trigger' from the tracker

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
trigger + string + +

+ A CSS selector representing the element which triggered the + animation +

+
+ +
+
Source:
+
+ +
+
+ +

+ (inner) removeMotionCssClass(element) +

+ +
+

+ Removes the current motion animation CSS class from the element +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
element + HTMLElement + +

The DOM element being animated

+
+ +
+
Source:
+
+ +
+
+ +

+ (inner) resetDefaultConfig() +

+ +
+

+ Reset the configurations to its default values by removing from + 'CONFIG' all options customized by the user +

+
+ +
+
Source:
+
+ +
+ +
See:
+
+
    +
  • CONFIG
    • +
+
+
+ +

+ (inner) updateCssProperties(element, opts) +

+ +
+

+ Sets the CSS properties customized by the user in the animation + function's options +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + - + + - + + -
+ + + + + +
NameTypeDescription
element + HTMLElement + +

The DOM element to update the CSS Properties

+
opts + Object.<string, string> + +

+ Object containing a custom property key and a CSS value to + be updated +

+
+ +
+
Source:
+
+ +
+
+ +

+ (inner) updateDefaultConfig(opts) +

+ +
+

+ Customize the default animations configurations by overwriting the + 'CONFIG' values +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + -
- Documentation generated by JSDoc 4.0.0 on Wed Nov 23 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) -
+ + + + + +
NameTypeDescription
opts + Object + +

All the options customized by the user

+
+ +
+
Source:
+
+ +
+ +
See:
+
+
    +
  • CONFIG
    • +
+
+
+
+
+
- - - - \ No newline at end of file + + +
+ +
+ Documentation generated by + JSDoc 4.0.0 on Wed Nov 23 + 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) +
+ + + + + diff --git a/jsdoc/doc/module-globals.html b/jsdoc/doc/module-globals.html index 27ded93..17fe836 100644 --- a/jsdoc/doc/module-globals.html +++ b/jsdoc/doc/module-globals.html @@ -1,517 +1,266 @@ - - + + JSDoc: Module: globals - - + + - - - - - - -
- -

Module: globals

- - - - - - -
- -
- -
- -
-
- - + + + + + +
+

Module: globals

+ +
+
+ +
+

Global Objects

- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - +
+
Source:
+
+ +
+
+
+ +

Members

+ +

+ (static, constant) CLASS_NAMES :Object +

+ +
+

CSS Class Names

+
+ +
Type:
+
    +
  • + Object +
    • +
+ +
+
Source:
+
+ +
+
+ +

+ (static, constant) CUSTOM_CSS_PROPERTIES + :ReadonlyArray.<string> +

+ +
+

+ CSS Properties customized by options passed in the animation + function +

+

+ ('cursor' can only be customized in animations triggered by click + event so it is not being included here) +

+
+ +
Type:
+
    +
  • + ReadonlyArray.<string> +
    • +
+ +
+
Source:
+
+ +
+
+ +

+ (static, constant) MOTION_ANIMS_ID + :Object.<string, number> +

+ +
+

Motion Animations IDs

+

+ The key is the name of the animation function and the value is the + index of the CSS class name inside CLASS_NAMES.move and + CLASS_NAMES.moveBack +

+
+ +
Type:
+
    +
  • + Object.<string, number> +
    • +
+ +
+
Source:
+
+ +
+ +
See:
+
+ +
+
+ +

+ (static, constant) PROPERTY_NAMES + :Object.<string, string> +

+ +
+

CSS Custom Properties

+

+ The key is the name of the option passed to the animation function + and the value is the respective CSS variable +

+
+ +
Type:
+
    +
  • + Object.<string, string> +
    • +
+ +
+
Source:
+
+ +
+
+ +

+ (static, constant) VISIBILITY_ANIMS_ID + :Object.<string, number> +

+ +
+

Visibility Animations IDs

+

+ The key is the name of the animation function and the value is the + index of the CSS class name inside CLASS_NAMES.hide and + CLASS_NAMES.show +

+
+ +
Type:
+
    +
  • + Object.<string, number> +
    • +
+ +
+
Source:
+
+ +
+ +
See:
+
+ +
+
+
+
- - - - - - - - - - - - - -

Members

- - - -

(static, constant) CLASS_NAMES :Object

- - - - -
-

CSS Class Names

-
- - - -
Type:
-
    -
  • - -Object - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(static, constant) CUSTOM_CSS_PROPERTIES :ReadonlyArray.<string>

- - - - -
-

CSS Properties customized by options passed in the animation function

-

('cursor' can only be customized in animations triggered by click event -so it is not being included here)

-
- - - -
Type:
-
    -
  • - -ReadonlyArray.<string> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(static, constant) MOTION_ANIMS_ID :Object.<string, number>

- - - - -
-

Motion Animations IDs

-

The key is the name of the animation function -and the value is the index of the CSS class name -inside CLASS_NAMES.move and CLASS_NAMES.moveBack

-
- - - -
Type:
-
    -
  • - -Object.<string, number> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
- -
- - - -
- - - - - - - - -

(static, constant) PROPERTY_NAMES :Object.<string, string>

- - - - -
-

CSS Custom Properties

-

The key is the name of the option passed to the animation function -and the value is the respective CSS variable

-
- - - -
Type:
-
    -
  • - -Object.<string, string> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(static, constant) VISIBILITY_ANIMS_ID :Object.<string, number>

- - - - -
-

Visibility Animations IDs

-

The key is the name of the animation function -and the value is the index of the CSS class name -inside CLASS_NAMES.hide and CLASS_NAMES.show

-
- - - -
Type:
-
    -
  • - -Object.<string, number> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
- -
- - - -
- - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- -
- Documentation generated by JSDoc 4.0.0 on Wed Nov 23 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) -
- - - - - \ No newline at end of file + + +
+ +
+ Documentation generated by + JSDoc 4.0.0 on Wed Nov 23 + 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) +
+ + + + + diff --git a/jsdoc/doc/module-js-css-animations.html b/jsdoc/doc/module-js-css-animations.html index e4916b7..687c920 100644 --- a/jsdoc/doc/module-js-css-animations.html +++ b/jsdoc/doc/module-js-css-animations.html @@ -1,1976 +1,913 @@ - - + + JSDoc: Module: js-css-animations - - + + - - - - - - -
- -

Module: js-css-animations

- - - - - - -
- -
- -
- -
-
- - -

Builds the animation API that will be exported to the final user

- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - -
- - - - - - - - - - - - - - -

Members

- - - -

(inner, constant) animationFunctions :Object

- - - - -
-

An object containing all the animations functions.

-

Visibility animations functions are under -animationFunctions.hide and animationFunctions.show

-

All other keys of animationFunctions are Motion animations functions

-
- - - -
Type:
-
    -
  • - -Object - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
- -
- - - -
- - - - - - - - -

(inner, constant) eventBoundAnimations :Object.<string, function()>

- - - - -
-

An object containing animations functions wich are triggered by an event (like 'click')

-
- - - -
Type:
-
    -
  • - -Object.<string, function()> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(inner, constant) jsCssAnimations :Object.<string, (function()|Object)>

- - - - -
-

An API encapsulating all the functions that can be used by the user, -like all the animations functions and auxiliary functions like: -isTransformed(), isVisible() and isHidden()

-
- - - -
Type:
-
    -
  • - -Object.<string, (function()|Object)> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(inner, constant) verifyAnimationName :ProxyHandler

- - - - -
-

Will throw an ReferenceError if the animation name does not corresponds to any animation function

-
- - - -
Type:
-
    -
  • - -ProxyHandler - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - -

Methods

- - - - - - - -

(inner) checkVisibility(selector, mode) → {boolean}

- - - - - - -
-

Verifies if a given element is hidden or visible

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
selector - - -Element -| - -string - - - -

An element or a valid CSS selector corresponding to the element

mode - - -string - - - -

Either 'visible' or 'hidden'

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

True or False depending if the element is visible or hidden, according to the 'mode' passed

-
- - - -
-
- Type -
-
- -boolean - - -
-
- - - - - - - - - - - - - -

(inner) config(opts)

- - - - - - -
-

Default values used by all animations are set by the user by -overriding default animations properties and options

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
opts - - -Object - - - -

All custom animation properties and options.

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
- -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) getTargets(selector)

- - - - - - -
-

Gets the element(s) to be animated. The user can pass either an HTMLElement or a CSS selector as a target to the animation

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
selector - - -HTMLElement -| - -string - - - -

An HTMLElement or a valid CSS selector to be passed to querySelectorAll()

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

An array containing a single HTMLElement or a NodeList with all the elements matching the CSS selector in 'selector'

-
- - - - - - - - - - - - - - - -

(inner) isHidden(selector)

- - - - - - - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
selector - - -Element -| - -string - - - -

Dom element or a valid CSS selector

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

True if the element is hidden, False otherwise

-
- - - - - - - - - - - - - - - -

(inner) isTransformed(selector)

- - - - - - -
-

Verifies if an element is out of its original orientation or scale.

-

Note that if the element has CSS property 'transform: rotate(0deg)', -isTransformed() will still return False, as the element is not -out of its original orientation.

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
selector - - -HTMLElement -| - -string - - - -

An element or a valid CSS selector corresponding to the element

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

True if the element was rotated from its original orientation. False if it maintains the original orientation.

-
- - - - - - - - - - - - - - - -

(inner) isVisible(selector)

- - - - - - - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
selector - - -Element -| - -string - - - -

Dom element or a valid CSS selector

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

True if the element is visible, False otherwise

-
- - - - - - - - - - - - - - - -

(inner) reset()

- - - - - - -
-

Resets default animations values by -removing default values customized by the user

-
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) selectAllElements(selector)

- - - - - - -
-

Returns a NodeList with all elements that match 'selector'

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - + + + + + +
+

Module: js-css-animations

+ +
+
+ +
+
+
+

+ Builds the animation API that will be exported to the final user +

+
+ +
+
Source:
+
+ +
+
+
+ +

Members

+ +

+ (inner, constant) animationFunctions :Object +

+ +
+

An object containing all the animations functions.

+

+ Visibility animations functions are under animationFunctions.hide + and animationFunctions.show +

+

+ All other keys of animationFunctions are Motion animations + functions +

+
+ +
Type:
+
    +
  • + Object +
    • +
+ +
+
Source:
+
+ +
+ +
See:
+
+ +
+
+ +

+ (inner, constant) eventBoundAnimations + :Object.<string, function()> +

+ +
+

+ An object containing animations functions wich are triggered by an + event (like 'click') +

+
+ +
Type:
+
    +
  • + Object.<string, function()> +
    • +
+ +
+
Source:
+
+ +
+
+ +

+ (inner, constant) jsCssAnimations + :Object.<string, (function()|Object)> +

+ +
+

+ An API encapsulating all the functions that can be used by the + user, like all the animations functions and auxiliary functions + like: isTransformed(), isVisible() and isHidden() +

+
+ +
Type:
+
    +
  • + Object.<string, (function()|Object)> +
    • +
+ +
+
Source:
+
+ +
+
+ +

+ (inner, constant) verifyAnimationName + :ProxyHandler +

+ +
+

+ Will throw an ReferenceError if the animation name does not + corresponds to any animation function +

+
+ +
Type:
+
    +
  • + ProxyHandler +
    • +
+ +
+
Source:
+
+ +
+
+ +

Methods

+ +

+ (inner) checkVisibility(selector, mode) → {boolean} +

+ +
+

Verifies if a given element is hidden or visible

+
+ +
Parameters:
+ +
NameTypeDescription
+ + + + + + + + + + + + - - - - - - - - - - - - - -
NameTypeDescription
selector - - -string - - - -

A valid CSS selector to be passed to querySelectorAll()

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
+ + Element + | + string + + +

+ An element or a valid CSS selector corresponding to the + element +

+ + + + mode + + string + + + +

Either 'visible' or 'hidden'

+ + + + + +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

+ True or False depending if the element is visible or hidden, + according to the 'mode' passed +

+
+ +
+
Type
+
+ boolean +
+
+ +

+ (inner) config(opts) +

+ +
+

+ Default values used by all animations are set by the user by + overriding default animations properties and options +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + - - - - - - - - - -
Returns:
- - -
-

A NodeList containing all elements matched by the 'selector'

-
- - - - - - - - - - - - - - - -

(inner) selectElement(selector)

- - - - - - -
-

If 'selector' is a string containing a valid CSS selector, -it will be used to perform a querySelector(), -If 'selector' is already an HTMLElement it will be returned as it is.

-
- - - - - - - - - -
Parameters:
- - -
NameTypeDescription
opts
- - - - - - - - - - - - - - - - - - - - - + + + + + +
NameTypeDescription
+ Object + +

All custom animation properties and options.

+
+ +
+
Source:
+
+ +
+ +
See:
+
+ +
+
+ +

+ (inner) getTargets(selector) +

+ +
+

+ Gets the element(s) to be animated. The user can pass either an + HTMLElement or a CSS selector as a target to the animation +

+
+ +
Parameters:
+ + + + + + + + + + + + + + - - - - - - - - - - - - - -
NameTypeDescription
selector - - -Element -| - -string - - - -

If it's an HTMLElement, 'selector' will be returned as it is. If it's a string, it should be a valid CSS selector

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

An HTMLElement

-
- - - - - - - - - - - - - - - -

(inner) toggle(selector, animA, animB, opts)

- - - - - - -
-

Toggles between two animations.

-

If 'animA' and 'animB' have the same name, -it will toggle between the 'hide' state and the 'show' state, -although this is only applicable to visibility animations.

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - + + + + + +
NameTypeDescription
+ HTMLElement + | + + string + +

+ An HTMLElement or a valid CSS selector to be passed to + querySelectorAll() +

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

+ An array containing a single HTMLElement or a NodeList with all + the elements matching the CSS selector in 'selector' +

+
+ +

+ (inner) isHidden(selector) +

+ +
Parameters:
+ + + + + + + + + + + + + + - - + + + + +
NameTypeDescription
selector - - -HTMLElement -| + + Element + | + + string + +

Dom element or a valid CSS selector

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

True if the element is hidden, False otherwise

+
+ +

+ (inner) isTransformed(selector) +

+ +
+

+ Verifies if an element is out of its original orientation or + scale. +

+

+ Note that if the element has CSS property 'transform: + rotate(0deg)', isTransformed() will still return False, as the + element is not out of its original orientation. +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + -string + + + + + +
NameTypeDescription
selector + HTMLElement + | + + string + +

+ An element or a valid CSS selector corresponding to the + element +

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

+ True if the element was rotated from its original orientation. + False if it maintains the original orientation. +

+
+ +

+ (inner) isVisible(selector) +

+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
selector + Element + | + + string + +

Dom element or a valid CSS selector

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

True if the element is visible, False otherwise

+
+ +

+ (inner) reset() +

+ +
+

+ Resets default animations values by removing default values + customized by the user +

+
+ +
+
Source:
+
+ +
+
+ +

+ (inner) selectAllElements(selector) +

+ +
+

Returns a NodeList with all elements that match 'selector'

+
+ +
Parameters:
+ + + + + + + + + + + + + + + - - + + + + + +
NameTypeDescription
selector + string + +

A valid CSS selector to be passed to querySelectorAll()

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

A NodeList containing all elements matched by the 'selector'

+
+ +

+ (inner) selectElement(selector) +

+ +
+

+ If 'selector' is a string containing a valid CSS selector, it will + be used to perform a querySelector(), If 'selector' is already an + HTMLElement it will be returned as it is. +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + - + + + + + +
NameTypeDescription
selector + Element + | + + string + +

+ If it's an HTMLElement, 'selector' will be returned as it + is. If it's a string, it should be a valid CSS selector +

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

An HTMLElement

+
+ +

+ (inner) toggle(selector, animA, animB, opts) +

+ +
+

Toggles between two animations.

+

+ If 'animA' and 'animB' have the same name, it will toggle between + the 'hide' state and the 'show' state, although this is only + applicable to visibility animations. +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + - + - + string + - + + - - + - - - + - + + - - - - - - - - - + - - - - - + + - - - - - - - - - - - + - - - - - - - - - - - - - -
NameTypeDescription
selector + HTMLElement + | -

The DOM element or a valid CSS selector with the element(s) to be animated

+

+ The DOM element or a valid CSS selector with the element(s) + to be animated +

+
animA - - -string - - - + string + +

The initial animation name

+

The initial animation name

animB - - -string + + string +

The next animation name

The next animation name

opts - - -Object -| - -Object - - - -

All options that can be passed by the user to customize the animation

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - -
See:
-
- -
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- -
- Documentation generated by JSDoc 4.0.0 on Wed Nov 23 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) -
+ + Object + | + + Object + + + +

+ All options that can be passed by the user to customize the + animation +

+ + + + + +
+
Source:
+
+ +
+ +
See:
+
+ +
+
+ + + - - - - \ No newline at end of file + + +
+ +
+ <<<<<<< HEAD Documentation generated by + JSDoc 4.0.0 on Wed Nov 23 + 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) ======= Documentation + generated by JSDoc 4.0.0 on + Wed Nov 23 2022 17:51:28 GMT-0300 (Horário Padrão de Brasília) >>>>>>> + 5665475 (docs: update jsdoc documentation) +
+ + + + + diff --git a/jsdoc/doc/module-resize-parent.html b/jsdoc/doc/module-resize-parent.html index 2568cca..072b92c 100644 --- a/jsdoc/doc/module-resize-parent.html +++ b/jsdoc/doc/module-resize-parent.html @@ -1,1171 +1,516 @@ - - + + JSDoc: Module: resize-parent - - + + - - - - - - -
- -

Module: resize-parent

- - - - - - -
- -
- -
- -
-
- - -

Handles parent element's resizing to perform width/height smooth transitions -when child element is being animated

- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - -
- - - - - - - - - - - - - - - - -

Methods

- - - - - - - -

(inner) endParentResize(element, opts)

- - - - - - -
-

Removes all CSS properties and classes added to the parent element to handle the dimensions transitions during the animation

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - + + + + + +
+

Module: resize-parent

+ +
+
+ +
+
+
+

+ Handles parent element's resizing to perform width/height smooth + transitions when child element is being animated +

+
+ +
+
Source:
+
+ +
+
+
+ +

Methods

+ +

+ (inner) endParentResize(element, opts) +

+ +
+

+ Removes all CSS properties and classes added to the parent element + to handle the dimensions transitions during the animation +

+
+ +
Parameters:
+ +
NameTypeDescription
+ + + + + + + + + + + + - - - - - + + - - - - - - - - - - - + - - - - - - - - - - - - - -
NameTypeDescription
element - - -HTMLElement + + HTMLElement + +

The DOM element being animated

+

The DOM element being animated

opts - - -Object - - - -

Indicates which dimensions were transitioned

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) getDimension(wTransit, hTransit)

- - - - - - -
-

Returns a string with the dimension to transition, or 'all' for both dimensions, or undefined if neither width nor height should be transitioned

-
- - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - + + + + + +
NameTypeDescription
+ Object + +

Indicates which dimensions were transitioned

+
+ +
+
Source:
+
+ +
+
+ +

+ (inner) getDimension(wTransit, hTransit) +

+ +
+

+ Returns a string with the dimension to transition, or 'all' for + both dimensions, or undefined if neither width nor height should + be transitioned +

+
+ +
Parameters:
+ + + + + + + + + + + + + + - - - + - + + - - - - - - - - - + - - - - - - - - - - - - - -
NameTypeDescription
wTransit - - -boolean - - - + boolean + +

+ Indicates if parent element should have width transition +

+

Indicates if parent element should have width transition

hTransit - - -boolean - - - -

Indicates if parent element should have height transition

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

undefined if both parameters are false, 'all' if both are true and 'width' or 'height' if only wTransit or hTransit is true, respectively

-
- - - - - - - - - - - - - - -

(inner) getRootCssProperty(property)

- - - - - - -
-

Gets the default value of a CSS property defined in js-css-animations.css

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - + + + + + +
NameTypeDescription
+ boolean + +

+ Indicates if parent element should have height transition +

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

+ undefined if both parameters are false, 'all' if both are true and + 'width' or 'height' if only wTransit or hTransit is true, + respectively +

+
+ +

+ (inner) getRootCssProperty(property) +

+ +
+

+ Gets the default value of a CSS property defined in + js-css-animations.css +

+
+ +
Parameters:
+ + + + + + + + + + + + + + - - - - - - - - - - - - - -
NameTypeDescription
property - - -string - - - -

PROPERTY_NAMES key corresponding to a CSS property name

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - + + string + + + +

PROPERTY_NAMES key corresponding to a CSS property name

+ + + + + +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

The default js-css-animation property value

+
+ +

+ (inner) initParentResize(args) +

+ +
+

+ Handles parent element width/height transitions during child + element's animation +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
args + Object + +

+ Containing all the information needed to initiate parent's + dimensions transitions +

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

+ An object with the dimension(s) to transition and the parent + element's measurements before and after the child element's + animation is performed +

+
+ +

+ (inner) removeOverflowHidden(el) +

+ +
+

+ Removes the CSS class which sets the overflow property to 'clip' + (or 'hidden') +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
el + HTMLElement + +

The DOM element with the CSS class to remove

+
+ +
+
Source:
+
+ +
+
+ +

+ (inner) setOverflowHidden(el) +

+ +
+

+ Adds a CSS class which will set the overflow property to 'clip' + (or 'hidden') +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
el + HTMLElement + +

The DOM element which will receive the CSS class

+
+ +
+
Source:
+
+ +
+
+ +

+ (inner) setParentCssProperties(element) +

+ +
+

+ Sets the same CSS variables (customized by the options in the + animation function) in the parent element, so the parent's + dimensions transitions will have the same custom properties of the + child element's animations +

+
+ +
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
element + HTMLElement + +

The DOM element being animated

+
+ +
+
Source:
+
+ +
+
+
+
+
- - - -
Returns:
- - -
-

The default js-css-animation property value

-
- - - - - - - - - - - - - - - -

(inner) initParentResize(args)

- - - - - - -
-

Handles parent element width/height transitions during child element's animation

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
args - - -Object - - - -

Containing all the information needed to initiate parent's dimensions transitions

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

An object with the dimension(s) to transition and the parent element's measurements before and after the child element's animation is performed

-
- - - - - - - - - - - - - - - -

(inner) removeOverflowHidden(el)

- - - - - - -
-

Removes the CSS class which sets the overflow property to 'clip' (or 'hidden')

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
el - - -HTMLElement - - - -

The DOM element with the CSS class to remove

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) setOverflowHidden(el)

- - - - - - -
-

Adds a CSS class which will set the overflow property to 'clip' (or 'hidden')

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
el - - -HTMLElement - - - -

The DOM element which will receive the CSS class

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

(inner) setParentCssProperties(element)

- - - - - - -
-

Sets the same CSS variables (customized by the options in the animation function) -in the parent element, so the parent's dimensions transitions will have -the same custom properties of the child element's animations

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
element - - -HTMLElement - - - -

The DOM element being animated

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- Documentation generated by JSDoc 4.0.0 on Wed Nov 23 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) -
- - - - - \ No newline at end of file + + +
+ +
+ Documentation generated by + JSDoc 4.0.0 on Wed Nov 23 + 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) +
+ + + + + diff --git a/jsdoc/doc/module-transitions.html b/jsdoc/doc/module-transitions.html index 5f1b3b6..e137c77 100644 --- a/jsdoc/doc/module-transitions.html +++ b/jsdoc/doc/module-transitions.html @@ -1,873 +1,396 @@ - - + + JSDoc: Module: transitions - - + + - - - - - - -
- -

Module: transitions

- - - - - - -
- -
- -
- -
-
- - -

Handle user defined transitions to not conflict with js-css-animations transitions

- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - -
- - - - - - - - - - - - - - -

Members

- - - -

(static, constant) appendTransition

- - - - -
-

If an element already has any transition defined, other than that in className, -the current transition(s) will be appended to the className transition so that -no transition will be overwritten

-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(static, constant) getClassTransition

- - - - -
-

Gets the transition in a given CSS class

-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(static, constant) getCurrentTransition

- - - - -
-

Gets user defined transitions of an element, if any

-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(static, constant) removeDimensionsTransitions

- - - - -
-

Removes the CSS class added by setDimensionsTransitions(), if any

-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
- -
- - - -
- - - - - - - - -

(static, constant) removeInlineTransition

- - - - -
-

If element has an inline css transition appended by appendTransition() -the inline transition property will be removed to reset the element back -to its previous state

-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - -
See:
-
- -
- - - -
- - - - - - - - -

(static, constant) setDimensionsTransitions

- - - - -
-

Appends the appropriate CSS class to handle dimension transitions. -If wTransit and hTransit are both set to false, no class will be appended.

-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - -

Methods

- - - - - - - -

(inner) getAllTransitions(cssProperties) → {string}

- - - - - - -
-

Parses all CSS properties and combine all transitions into one valid shorthand value -for 'transition' CSS property

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - + + + + + +
+

Module: transitions

+ +
+
+ +
+
+
+

+ Handle user defined transitions to not conflict with + js-css-animations transitions +

+
+ +
+
Source:
+
+ +
+
+
+ +

Members

+ +

+ (static, constant) appendTransition +

+ +
+

+ If an element already has any transition defined, other than that + in className, the current transition(s) will be appended to the + className transition so that no transition will be overwritten +

+
+ +
+
Source:
+
+ +
+
+ +

+ (static, constant) getClassTransition +

+ +
+

Gets the transition in a given CSS class

+
+ +
+
Source:
+
+ +
+
+ +

+ (static, constant) getCurrentTransition +

+ +
+

Gets user defined transitions of an element, if any

+
+ +
+
Source:
+
+ +
+
+ +

+ (static, constant) removeDimensionsTransitions +

+ +
+

+ Removes the CSS class added by setDimensionsTransitions(), if any +

+
+ +
+
Source:
+
+ +
+ +
See:
+
+ +
+
+ +

+ (static, constant) removeInlineTransition +

+ +
+

+ If element has an inline css transition appended by + appendTransition() the inline transition property will be removed + to reset the element back to its previous state +

+
+ +
+
Source:
+
+ +
+ +
See:
+
+ +
+
+ +

+ (static, constant) setDimensionsTransitions +

+ +
+

+ Appends the appropriate CSS class to handle dimension transitions. + If wTransit and hTransit are both set to false, no class will be + appended. +

+
+ +
+
Source:
+
+ +
+
+ +

Methods

+ +

+ (inner) getAllTransitions(cssProperties) → {string} +

+ +
+

+ Parses all CSS properties and combine all transitions into one + valid shorthand value for 'transition' CSS property +

+
+ +
Parameters:
+ +
NameTypeDescription
+ + + + + + + + + + + + - - - - - - - - - - - - - -
NameTypeDescription
cssProperties - - -CSSStyleDeclaration - - - -

A collection of CSS rules

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

All transitions combined into a single shorthand property

-
- - -
-
- Type -
-
- -string - - -
-
- - - - - - - - - - - - - -

(inner) getTransitionClassName(wTransit, hTransit) → {string|undefined}

- - - - - - -
-

Verifies wether there should be widht or height transition, or both, or none

-
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - + + + + + +
NameTypeDescription
+ CSSStyleDeclaration + +

A collection of CSS rules

+
+ +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

All transitions combined into a single shorthand property

+
+ +
+
Type
+
+ string +
+
+ +

+ (inner) getTransitionClassName(wTransit, hTransit) → {string|undefined} +

+ +
+

+ Verifies wether there should be widht or height transition, or + both, or none +

+
+ +
Parameters:
+ + + + + + + + + + + + + + - - - - + - + + - - - - - - - + - - - - - - - - - - - - - -
NameTypeDescription
wTransit - - -boolean - - - - + boolean + +

Indicates if it should have width transition

+

Indicates if it should have width transition

hTransit - - -boolean - - - -

Indicates if it should have height transition

- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

The name of the class with the respective transition, or undefined if there should be no transitions

-
- - - -
-
- Type -
-
- -string -| - -undefined - - -
-
- - - - - - - - - - - - - -
- -
- - - - -
- - - -
- -
- Documentation generated by JSDoc 4.0.0 on Wed Nov 23 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) -
+ + boolean + + + +

Indicates if it should have height transition

+ + + + + +
+
Source:
+
+ +
+
+ +
Returns:
+ +
+

+ The name of the class with the respective transition, or undefined + if there should be no transitions +

+
+ +
+
Type
+
+ string + | + + undefined +
+
+ + + - - - - \ No newline at end of file + + +
+ +
+ Documentation generated by + JSDoc 4.0.0 on Wed Nov 23 + 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) +
+ + + + + diff --git a/jsdoc/doc/resize-parent.js.html b/jsdoc/doc/resize-parent.js.html index 76234a5..7f3666d 100644 --- a/jsdoc/doc/resize-parent.js.html +++ b/jsdoc/doc/resize-parent.js.html @@ -1,32 +1,29 @@ - - + + JSDoc: Source: resize-parent.js - - + + - - - - - - -
- -

Source: resize-parent.js

- - - - - - -
+ + + + + +
+

Source: resize-parent.js

+ +
- 
/**
+          
/**
  * Handles parent element's resizing to perform width/height smooth transitions
  * when child element is being animated
  * @module resize-parent
@@ -158,24 +155,33 @@ 
Source: resize-parent.js

 export { initParentResize, endParentResize };
-
- - - - -
- - - -
- -
- Documentation generated by JSDoc 4.0.0 on Wed Nov 23 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) -
- - - - +
+
+ + + +
+ +
+ Documentation generated by + JSDoc 4.0.0 on Wed Nov 23 + 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) +
+ + + + diff --git a/jsdoc/doc/transitions.js.html b/jsdoc/doc/transitions.js.html index bea4c4d..49295b5 100644 --- a/jsdoc/doc/transitions.js.html +++ b/jsdoc/doc/transitions.js.html @@ -1,32 +1,29 @@ - - + + JSDoc: Source: transitions.js - - + + - - - - - - -
- -

Source: transitions.js

- - - - - - -
+ + + + + +
+

Source: transitions.js

+ +
- 
/**
+          
/**
  * Handle user defined transitions to not conflict with js-css-animations transitions
  * @module transitions
  */
@@ -216,24 +213,33 @@ 
Source: transitions.js

 };
-
- - - - -
- - - -
- -
- Documentation generated by JSDoc 4.0.0 on Wed Nov 23 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) -
- - - - +
+
+ + + +
+ +
+ Documentation generated by + JSDoc 4.0.0 on Wed Nov 23 + 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) +
+ + + + From 355b1e322c60625fe59d6e8d1fc3a8bcfdfb6e91 Mon Sep 17 00:00:00 2001 From: IguhSoares Date: Wed, 23 Nov 2022 19:58:22 -0300 Subject: [PATCH 2/5] docs: update documentation --- jsdoc/doc/animate.js.html | 3 +++ 1 file changed, 3 insertions(+) diff --git a/jsdoc/doc/animate.js.html b/jsdoc/doc/animate.js.html index 934733d..5ed37f7 100644 --- a/jsdoc/doc/animate.js.html +++ b/jsdoc/doc/animate.js.html @@ -64,7 +64,10 @@

Source: animate.js

overflowHidden: true, stopPropagation: true, preventDefault: true, +<<<<<<< HEAD on: 'click', +======= +>>>>>>> 85a2707 (docs: update documentation) }), }; From e84eca07143276c3fc57a9665ffa58319a9c678e Mon Sep 17 00:00:00 2001 From: IguhSoares Date: Wed, 23 Nov 2022 20:27:49 -0300 Subject: [PATCH 3/5] docs: update documentation --- jsdoc/doc/animate.js.html | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/jsdoc/doc/animate.js.html b/jsdoc/doc/animate.js.html index 5ed37f7..17dcd03 100644 --- a/jsdoc/doc/animate.js.html +++ b/jsdoc/doc/animate.js.html @@ -675,6 +675,12 @@

Source: animate.js

 + +
+ Documentation generated by + JSDoc 4.0.0 on Wed Nov 23 + 2022 20:32:22 GMT-0300 (Horário Padrão de Brasília) +