Class: DomEase

var Ease = require('dom-ease');
var ease = new Ease({ duration: 3000, ease: 'easeInOutSine' });

var test = document.getElementById('test')
ease.add(test, { left: 20, top: 15, opacity: 0.25 }, { repeat: true, reverse: true })

Extends

• EventEmitter

Methods

add (element(s), params, options)Ease | Array.<Ease>

domEase.js:128

add ease(s) to one or more elements

Name	Type	Description
element(s)	HTMLElement | Array.<HTMLElement>
params	object	Name Type Description left number optional in px top number optional in px width number optional in px height number optional in px scale number optional scaleX number optional scaleY number optional opacity number optional marginTop number optional in px marginRight number optional in px marginBottom number optional in px marginLeft number optional in px color color | Array.<color> optional backgroundColor color | Array.<color> optional
options	object	optional Name Type Description duration number optional ease string | function optional repeat boolean | number optional reverse boolean optional

Returns:

Type	Description
Ease | Array.<Ease>	ease(s) for each element

emit (event)Boolean inherited

index.js:166

Calls each of the listeners registered for a given event.

Name	Type	Description
event	String | Symbol	The event name.

Returns:

Type	Description
Boolean	`true` if the event had listeners, else `false`.

eventNames ()Array inherited

index.js:104

Return an array listing the events for which the emitter has registered listeners.

Returns:

Type	Description
Array

getCount ()number

domEase.js:228

number of eases

Returns:

Type	Description
number

listenerCount (event)Number inherited

index.js:150

Return the number of listeners listening to a given event.

Name	Type	Description
event	String | Symbol	The event name.

Returns:

Type	Description
Number	The number of listeners.

listeners (event)Array inherited

index.js:129

Return the listeners registered for a given event.

Name	Type	Description
event	String | Symbol	The event name.

Returns:

Type	Description
Array	The registered listeners.

once (event, fn, context)EventEmitter inherited

index.js:240

Add a one-time listener for a given event.

Name	Type	Default	Description
event	String | Symbol		The event name.
fn	function		The listener function.
context	*	this	optional The context to invoke the listener with.

Returns:

Type	Description
EventEmitter	`this`.

on (event, fn, context)EventEmitter inherited

index.js:227

Add a listener for a given event.

Name	Type	Default	Description
event	String | Symbol		The event name.
fn	function		The listener function.
context	*	this	optional The context to invoke the listener with.

Returns:

Type	Description
EventEmitter	`this`.

remove (ease)

domEase.js:180

remove eases using Ease object returned by add()

Name	Type	Description
ease	Ease

removeAll ()

domEase.js:196

remove all eases

removeAllListeners (event)EventEmitter inherited

index.js:301

Remove all listeners, or those of the specified event.

Name	Type	Description
event	String | Symbol	optional The event name.

Returns:

Type	Description
EventEmitter	`this`.

removeListener (event, fn, context, once)EventEmitter inherited

index.js:254

Remove the listeners of a given event.

Name	Type	Description
event	String | Symbol	The event name.
fn	function	Only remove the listeners that match this function.
context	*	Only remove the listeners that have this context.
once	Boolean	Only remove one-time listeners.

Returns:

Type	Description
EventEmitter	`this`.

removeObjectEases (element)

domEase.js:161

remove all eases on element

Name	Type	Description
element	HTMLElement

start ()

domEase.js:51

start animation loop (automatically called unless options.autostart=false)

stop ()

domEase.js:93

stop animation loop

update (elapsed)

domEase.js:205

update frame; this is called automatically if start() is used

Name	Type	Description
elapsed	number	time in ms

Events

complete

domEase.js:234

fires when there are no more animations for a DOM element

Type:

• DomEase

each

domEase.js:240

fires on each loop for a DOM element where there are animations

Type:

• DomEase