flip-turn.js API reference
Demo
View on GitHub
Preparing search index...
State
FlipTurnState
Type Alias FlipTurnState
type
FlipTurnState
=
{
options
:
ResolvedFlipTurnOptions
;
displayMode
:
DisplayMode
;
pages
:
PageSource
[]
;
pageCount
:
number
;
currentSpreadIndex
:
number
;
currentPageIndex
:
number
;
animationSpeedMultiplier
:
number
;
animationHandle
:
number
|
null
;
hoverAnimationTarget
:
Point
|
null
;
activeTurn
:
ActiveTurn
|
null
;
activeTurnResolvedOptions
:
ActiveTurnResolvedOptions
|
null
;
keyboardTargetPosition
:
number
|
null
;
pendingPageTarget
:
number
|
null
;
interactionEnabled
:
boolean
;
eventSubscribers
:
Map
<
FlipTurnLifecycleEvent
,
Set
<
FlipTurnEventListener
>
>
;
}
Index
Properties
options
display
Mode
pages
page
Count
current
Spread
Index
current
Page
Index
animation
Speed
Multiplier
animation
Handle
hover
Animation
Target
active
Turn
active
Turn
Resolved
Options
keyboard
Target
Position
pending
Page
Target
interaction
Enabled
event
Subscribers
Properties
options
options
:
ResolvedFlipTurnOptions
display
Mode
displayMode
:
DisplayMode
pages
pages
:
PageSource
[]
page
Count
pageCount
:
number
current
Spread
Index
currentSpreadIndex
:
number
current
Page
Index
currentPageIndex
:
number
animation
Speed
Multiplier
animationSpeedMultiplier
:
number
animation
Handle
animationHandle
:
number
|
null
hover
Animation
Target
hoverAnimationTarget
:
Point
|
null
active
Turn
activeTurn
:
ActiveTurn
|
null
active
Turn
Resolved
Options
activeTurnResolvedOptions
:
ActiveTurnResolvedOptions
|
null
keyboard
Target
Position
keyboardTargetPosition
:
number
|
null
pending
Page
Target
pendingPageTarget
:
number
|
null
interaction
Enabled
interactionEnabled
:
boolean
event
Subscribers
eventSubscribers
:
Map
<
FlipTurnLifecycleEvent
,
Set
<
FlipTurnEventListener
>
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
options
display
Mode
pages
page
Count
current
Spread
Index
current
Page
Index
animation
Speed
Multiplier
animation
Handle
hover
Animation
Target
active
Turn
active
Turn
Resolved
Options
keyboard
Target
Position
pending
Page
Target
interaction
Enabled
event
Subscribers
Demo
View on GitHub
flip-turn.js API reference
Loading...