Scroll

scroll is a utility JavaScript library for scroll interface.

Introduction

Installation

Yarn

yarn add @pluginjs/scroll

NPM

npm i @pluginjs/scroll

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/scroll/dist/scroll.js"></script>

Production:

<script src="https://unpkg.com/@pluginjs/scroll/dist/scroll.min.js"></script>

API

to

Parameters

| Name | Type | Description | |||-| | options | ScrollToOptions | |

ScrollToOptions

| Name | Type | Description | | x | Number | | | y | Number | | | easing | String | | | duration | Number | | | complete | Function | Callback |

toX

Parameters

| Name | Type | Description | |||-| | x | Number | | | easing | String | | | duration | Number | | | complete | Function | Callback |

toY

Parameters

| Name | Type | Description | |||-| | y | Number | | | easing | String | | | duration | Number | | | complete | Function | Callback |

by

Parameters

| Name | Type | Description | |||-| | options | ScrollByOptions | |

ScrollToOptions

| Name | Type | Description | | x | Number | | | y | Number | | | easing | String | | | duration | Number | | | complete | Function | Callback |

byX

Parameters

| Name | Type | Description | |||-| | x | Number | | | easing | String | | | duration | Number | | | complete | Function | Callback |

byY

Parameters

| Name | Type | Description | |||-| | y | Number | | | easing | String | | | duration | Number | | | complete | Function | Callback |

intoView

Parameters

| Name | Type | Description | |||-| | options | ScrollIntoViewOptions | |

ScrollIntoViewOptions

| Name | Type | Description | | element | HTMLElement | | | easing | String | | | duration | Number | | | complete | Function | Callback |

top

Parameters

| Name | Type | Description | |||-| | options | ScrollTopOptions | |

ScrollTopOptions

| Name | Type | Description | | element | HTMLElement | | | offset | Number | | | easing | String | | | duration | Number | | | complete | Function | Callback |

Browser support

Tested on all major browsers.

| IE / Edge | Firefox | Chrome | Safari | Opera | | --------- | --------- | --------- | --------- | --------- | | IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions|

License

@pluginjs/scroll is Licensed under the GPL-v3 license.

If you want to use @pluginjs/scroll project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us [email protected].

Copyright

Copyright (C) 2022 Creation Studio Limited.