feat: add flag passive as a global option (#13)

README.md

@@ -75,6 +75,7 @@ Scroll to a position on the page
 | `duration` | `500` | Duration (in milliseconds) of the animation. |
 | `offset` | `0` | Offset that should be applied when scrolling. |
 | `easing` | `cubicInOut` | Easing function to be used when animating. Use any easing from [`svelte/easing`][svelte-easing] or a custom easing function. |
+| `passive` | `true` | A boolean value that, if true, indicates that the function specified by listener will never call preventDefault(). |
 | `onStart` | `noop` | A callback function that should be called when scrolling has started. Receives the element, offset, duration and endPosition as a parameter. |
 | `onDone` | `noop` | A callback function that should be called when scrolling has started. Receives the element, offset, duration and endPosition as a parameter. |
 

src/actions/ScrollTo.ts

@@ -9,7 +9,7 @@ const elementsList = get(elements)
 
 // handle with scrolling
 const handle = async (event: Event, options: ScrollToOptions): Promise<void> => {
-  event.preventDefault()
+  if (!options.passive) event.preventDefault()
 
   const { ref, onDone, onStart } = options
 
@@ -70,10 +70,10 @@ const scrollTo = ( // eslint-disable-line @typescript-eslint/explicit-module-bou
     node.style.cursor = 'pointer'
   }
 
-  const _handler = (event) => handle(event, opts)
+  const _handler = (event: MouseEvent | TouchEvent) => handle(event, opts)
 
-  node.addEventListener('click', _handler)
-  node.addEventListener('touchstart', _handler)
+  node.addEventListener('click', _handler, { passive: opts.passive })
+  node.addEventListener('touchstart', _handler, { passive: opts.passive })
 
   return {
     destroy () {

src/store/index.ts

@@ -7,6 +7,7 @@ export const elements = writable<Array<ElementReference>>([])
 export const globalOptions = writable<GlobalOptions>({
   offset: 0,
   duration: 500,
+  passive: true,
   easing: cubicInOut,
   onStart: () => { },
   onDone: () => { }

src/types/options.ts

@@ -8,6 +8,7 @@ export interface HooksOptions {
 export interface GlobalOptions {
   offset: number
   duration: number
+  passive?: boolean
   easing: (t: number) => number
   onStart?: (options: HooksOptions) => void
   onDone?: (options: HooksOptions) => void