swipefeed
Preparing search index...
SwipeDeckAPI
Interface SwipeDeckAPI<T>
interface
SwipeDeckAPI
<
T
>
{
canNext
:
boolean
;
canPrev
:
boolean
;
getItemProps
:
(
index
:
number
,
)
=>
HTMLAttributes
<
HTMLElement
>
&
{
"data-active"
:
boolean
;
"data-index"
:
number
;
ref
?:
(
instance
:
HTMLElement
|
null
)
=>
void
|
(
()
=>
VoidOrUndefinedOnly
)
;
}
;
getViewportProps
:
()
=>
HTMLAttributes
<
HTMLElement
>
&
{
ref
:
(
instance
:
HTMLElement
|
null
,
)
=>
void
|
(
()
=>
VoidOrUndefinedOnly
)
;
}
;
index
:
number
;
isAnimating
:
boolean
;
items
:
readonly
T
[]
;
next
:
()
=>
void
;
orientation
:
Orientation
;
prev
:
()
=>
void
;
scrollTo
:
(
index
:
number
,
options
?:
{
behavior
?:
ScrollBehavior
}
)
=>
void
;
totalSize
:
number
;
viewport
:
HTMLElement
|
null
;
virtualItems
:
SwipeDeckVirtualItem
[]
;
}
Type Parameters
T
Hierarchy (
View Summary
)
SwipeDeckState
SwipeDeckActions
SwipeDeckAPI
Index
Properties
can
Next
can
Prev
get
Item
Props
get
Viewport
Props
index
is
Animating
items
next
orientation
prev
scroll
To
total
Size
viewport
virtual
Items
Properties
can
Next
canNext
:
boolean
can
Prev
canPrev
:
boolean
get
Item
Props
getItemProps
:
(
index
:
number
,
)
=>
HTMLAttributes
<
HTMLElement
>
&
{
"data-active"
:
boolean
;
"data-index"
:
number
;
ref
?:
(
instance
:
HTMLElement
|
null
)
=>
void
|
(
()
=>
VoidOrUndefinedOnly
)
;
}
get
Viewport
Props
getViewportProps
:
()
=>
HTMLAttributes
<
HTMLElement
>
&
{
ref
:
(
instance
:
HTMLElement
|
null
,
)
=>
void
|
(
()
=>
VoidOrUndefinedOnly
)
;
}
index
index
:
number
is
Animating
isAnimating
:
boolean
items
items
:
readonly
T
[]
next
next
:
()
=>
void
orientation
orientation
:
Orientation
prev
prev
:
()
=>
void
scroll
To
scrollTo
:
(
index
:
number
,
options
?:
{
behavior
?:
ScrollBehavior
}
)
=>
void
total
Size
totalSize
:
number
viewport
viewport
:
HTMLElement
|
null
virtual
Items
virtualItems
:
SwipeDeckVirtualItem
[]
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
can
Next
can
Prev
get
Item
Props
get
Viewport
Props
index
is
Animating
items
next
orientation
prev
scroll
To
total
Size
viewport
virtual
Items
swipefeed
Loading...