States

Type class

Collection of State objects for an element.

Click here for more info

Sources

This information about States is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

States does not extend any other symbol.

States is not extended by any other symbol.

Settings

States does not have any settings.

Private settings

States does not have any private settings.

Properties

States does not have any properties.

Methods

apply(

newState: string

)

#

Returns void

Applies a named state to the target element.

applyAnimate(

newState: string,
duration?: undefined | number

)

#

Returns Animations | undefined

Applies a named state to the element.

Returns an object representing all Animation objects created for each setting key transition.

constructor(

entity: E

)

#

Returns States

create(

name: string,
settings: Partial

)

#

Returns State

Sets supplied settings on a state by the name.

If such state does not yet exists, it is created.

lookup(

name: string

)

#

Returns State | undefined

Checks if a state by name exists. Returns it there is one.

remove(

name: string

)

#

Returns void

Removes the state called name.

Events

States does not have any events.