State

⚠️ This class is for internal use only.

class State

A component that shows the current status of the user input or the animation

Properties

Methods

holding
animating

onHold
onChange
onRelease
onAnimationEnd
onFinish

Properties

holding

readonly

Whether user is clicking or touching

Type: boolean

animating

readonly

Whether Flicking's animating

Type: boolean

Methods

onHold

An event handler for Axes's hold event

Returns: void

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
ctx	object	yes		Event context
ctx.flicking	Flicking	yes		An instance of Flicking
ctx.axesEvent	object	yes		A hold event of Axes
ctx.transitTo	function	yes		A function for changing current state to other state

onChange

An event handler for Axes's change event

Returns: void

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
ctx	object	yes		Event context
ctx.flicking	Flicking	yes		An instance of Flicking
ctx.axesEvent	object	yes		A change event of Axes
ctx.transitTo	function	yes		A function for changing current state to other state

onRelease

An event handler for Axes's release event

Returns: void

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
ctx	object	yes		Event context
ctx.flicking	Flicking	yes		An instance of Flicking
ctx.axesEvent	object	yes		A release event of Axes
ctx.transitTo	function	yes		A function for changing current state to other state

onAnimationEnd

An event handler for Axes's animationEnd event

Returns: void

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
ctx	object	yes		Event context
ctx.flicking	Flicking	yes		An instance of Flicking
ctx.axesEvent	object	yes		A animationEnd event of Axes
ctx.transitTo	function	yes		A function for changing current state to other state

onFinish

An event handler for Axes's finish event

Returns: void

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
ctx	object	yes		Event context
ctx.flicking	Flicking	yes		An instance of Flicking
ctx.axesEvent	object	yes		A finish event of Axes
ctx.transitTo	function	yes		A function for changing current state to other state