auto_scroll_plugin.md

@interactjs / auto-scroll/plugin

Module: auto-scroll/plugin

Table of contents

Interfaces

• AutoScrollOptions

Functions

• getContainer
• getScroll
• getScrollSize
• getScrollSizeDelta

Functions

getContainer

▸ getContainer(value, interactable, element): any

Parameters

Name	Type
value	any
interactable	Interactable
element	Element

Returns

any

Defined in

auto-scroll/plugin.ts:207

---

getScroll

▸ getScroll(container): Object

Parameters

Name	Type
container	any

Returns

Object

Name	Type
x	any
y	any

Defined in

auto-scroll/plugin.ts:213

---

getScrollSize

▸ getScrollSize(container): Object

Parameters

Name	Type
container	any

Returns

Object

Name	Type
x	any
y	any

Defined in

auto-scroll/plugin.ts:221

---

getScrollSizeDelta

▸ getScrollSizeDelta<T>(«destructured», func): Object

Type parameters

Name	Type
T	extends keyof ActionMap

Parameters

Name	Type
«destructured»	Object
› element	Element
› interaction	Partial<Interaction<T>>
func	any

Returns

Object

Name	Type
x	number
y	number

Defined in

auto-scroll/plugin.ts:229