VanillaJS ScrollSpy

!GitHub !npm !npm !npm

ScrollSpy in pure JavaScript.

Installation

``bash
$ npm install vanillajs-scrollspy --save
`

How to use

- menu: HTML selector (#id, .class, ...)
- speed (optional): scroll speed, default value 2000
- easing (optional): scroll type 'easeOutSine', 'easeInOutSine' or 'easeInOutQuint', default value 'easeOutSine'

$3

`javascript
import VanillaScrollspy from 'vanillajs-scrollspy'

const menu = document.querySelector('#navbar')
const scrollspy = VanillaScrollspy({ menu })
scrollspy.init()
`

$3

`html



`

After that the library will be available to the Global as VanillaScrollspy. Follow an example:

` javascript
const menu = document.querySelector('#navbar')
const scrollspy = VanillaScrollspy({ menu })
scrollspy.init()
`

Examples

$3

Available in public/index.html.

` html













`

$3

` javascript
const menu = document.querySelector('#navbar')
const scrollspy = VanillaScrollspy({ menu, speed: 1000 })
scrollspy.init()
`

$3

` javascript
const menu = document.querySelector('#navbar')
const scrollspy = VanillaScrollspy({ menu, speed: 1000, easing: 'easeInOutQuint' })
scrollspy.init()
``

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details