headless

API simpleClassTransition

createSimpleClassTransition

function

createSimpleClassTransition(config): TransitionFn

Create a transition based on css classes to attach.

The config includes the classes that will be attached / removed depending on the transition state. animationPendingClasses are the classes attached when the transition is in a pending state animationPendingShowClasses and animationPendingHideClasses are attached when transitioning towards one direction showClasses and hideClasses are attached when the transition has reached the show or hide state respectively

Parameters

config: SimpleClassTransitionConfig

the transition config

Returns

TransitionFn

the simple class transition


SimpleClassTransitionConfig

interface

Configuration interface for simple class-based transitions.

Properties
animationPendingClasses?

optional animationPendingClasses: string[]

a list of classes to add to the collapsable element while transitioning


animationPendingHideClasses?

optional animationPendingHideClasses: string[]

a list of classes to add to the collapsable element while transitioning towards the hide state


animationPendingShowClasses?

optional animationPendingShowClasses: string[]

a list of classes to add to the collapsable element while transitioning towards the show state


hideClasses?

optional hideClasses: string[]

the list of classes to add to the element when hidden


showClasses?

optional showClasses: string[]

the list of classes to add to the element when shown


SimpleClassTransitionContext

interface

Represents the context for a simple class transition.

Properties
started?

optional started: boolean

true is the transition has started