flip-turn.js API reference
Demo
View on GitHub
Preparing search index...
FlipTurnApi
Type Alias FlipTurnApi
type
FlipTurnApi
=
{
update
:
(
options
:
Partial
<
FlipTurnOptions
>
)
=>
FlipTurnApi
;
options
:
()
=>
ResolvedFlipTurnOptions
;
page
:
(
pageNumber
?:
number
)
=>
number
;
display
:
(
displayMode
?:
DisplayMode
)
=>
DisplayMode
;
next
:
()
=>
boolean
;
previous
:
()
=>
boolean
;
size
:
(
width
?:
number
|
null
,
height
?:
number
|
null
,
)
=>
FlipTurnApi
|
{
width
:
number
|
null
;
height
:
number
|
null
}
;
setPages
:
(
pages
:
PageSourceInput
[]
)
=>
FlipTurnApi
;
addPage
:
(
pageSource
:
PageSourceInput
,
pageNumber
?:
number
)
=>
FlipTurnApi
;
removePage
:
(
pageNumber
:
number
)
=>
FlipTurnApi
;
stop
:
()
=>
void
;
animating
:
()
=>
boolean
;
subscribe
:
(
eventName
:
FlipTurnLifecycleEvent
,
listener
:
FlipTurnEventListener
,
)
=>
EventSubscription
;
disable
:
()
=>
void
;
enable
:
()
=>
void
;
destroy
:
()
=>
void
;
}
Index
Properties
update
options
page
display
next
previous
size
set
Pages
add
Page
remove
Page
stop
animating
subscribe
disable
enable
destroy
Properties
update
update
:
(
options
:
Partial
<
FlipTurnOptions
>
)
=>
FlipTurnApi
options
options
:
()
=>
ResolvedFlipTurnOptions
page
page
:
(
pageNumber
?:
number
)
=>
number
display
display
:
(
displayMode
?:
DisplayMode
)
=>
DisplayMode
next
next
:
()
=>
boolean
previous
previous
:
()
=>
boolean
size
size
:
(
width
?:
number
|
null
,
height
?:
number
|
null
,
)
=>
FlipTurnApi
|
{
width
:
number
|
null
;
height
:
number
|
null
}
set
Pages
setPages
:
(
pages
:
PageSourceInput
[]
)
=>
FlipTurnApi
add
Page
addPage
:
(
pageSource
:
PageSourceInput
,
pageNumber
?:
number
)
=>
FlipTurnApi
remove
Page
removePage
:
(
pageNumber
:
number
)
=>
FlipTurnApi
stop
stop
:
()
=>
void
animating
animating
:
()
=>
boolean
subscribe
subscribe
:
(
eventName
:
FlipTurnLifecycleEvent
,
listener
:
FlipTurnEventListener
,
)
=>
EventSubscription
disable
disable
:
()
=>
void
enable
enable
:
()
=>
void
destroy
destroy
:
()
=>
void
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
update
options
page
display
next
previous
size
set
Pages
add
Page
remove
Page
stop
animating
subscribe
disable
enable
destroy
Demo
View on GitHub
flip-turn.js API reference
Loading...