Add scrollto parameters

[robiseb]

Fix issue #3

• Able to add parameters to the data-scrollto

Scroll to

Internally use jump.js library.

Listen jump link [data-scrollto] elements:

<div data-scrollto="#top">content</div>

Jump programmaticaly to an element:

import { scrollTo } from '@wide/scroll'

scrollTo('.something')

You can define global config applying to all links:

import { JUMP_CONFIG } from '@wide/scroll'

JUMP_CONFIG.offset = -20 // top offset for all jump

You can aslo define config locally by adding HTML attributes:

<button
  data-scrollto="#footer"
  data-scrollto.duration="1010"
  data-scrollto.offset="0"
  data-scrollto.a11y="false"
  data-scrollto.callback="scrollToCallback"
  data-scrollto.easing="scrollToEasing"
>
  Scroll to footer
</button>

window.scrollToCallback = () => {
  // Do some stuffs when scroll has been completed
}

window.scrollToEasing = () => {
  // My custom easing animation code
}

Note: Those parameters will override default (global) parameters.

Parameters

Name	Type	Description	Default value
duration	number	Pass the time the scrollto() takes, in milliseconds.	800
offset	number	Offset a scrollto(), only if to an element, by a number of pixels.	-80
a11y	boolean	If enabled, and scrolling to an element: add a tabindex to, and focus the element	true
callback	function	Pass a function that will be called after the scrollto() has been completed.	null
easing	function	Easing function used to transition the scrollto().	null

More informations on Jump.js documentation.