scroll-animate-to

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

scroll-animate-to

★ 9 Open GitHub ↗

A light Javascript library to scroll to the position of element.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# scroll-animate-to

A light Javascript library to scroll to the position of element.

[DEMO](https://ranjiayu.github.io/scroll-animate-to-demo/)

## Install

npm i scroll-animate-to

## Useage

```javascript
import ScrollTo from 'scroll-animate-to'

let header = document.getElementById('header')
let scrollIns = new ScrollTo({
    target: header,
    animationFn: 'easeOut',
    duration: 1500
})
scrollIns.scroll()
```

```html
<script src="/path/to/scroll-animate-to.min.js"></script>
```

More detail see [DEMO](https://ranjiayu.github.io/scroll-animate-to-demo/)

## API

new ScrollTo(option)

* @param {Object}           option
* @param {HTMLElement}      option.container    default is window. You can set element which has scroll bar
* @param {HTMLElement}      option.target       the element scroll to
* @param {Function|string}  option.animationFn  "easeIn", "easeOut", "easeInOut", "linear". Default is "easeIn". And you can custom the function.
* @param {Function}         option.callback     callback function
* @param {number}           option.duration     the scroll cost time, default 1000(ms)
* @param {number}           option.offsetX      scroll offset from X axis
* @param {number}           option.offsetY      scroll offset from Y axis
* @param {string}           option.axis         "axis" would be "x" or "y". Default is "y"

## License

MIT

scroll-animate-to

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README