DisabledState
⚠️ This class is for internal use only.
class DisabledState extends State
A state that activates when Flicking is stopped by event's stop method
Properties
holding
Whether user is clicking or touching
Type: false
animating
Whether Flicking's animating
Type: true
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 |