Merge pull request #29 from UFHealth/patch/oops-missing-defaults-for-to

Fix missing defaults for `To` method

example/as-module.js

@@ -2,16 +2,14 @@ import Butr from './butr'
 
 document.addEventListener('DOMContentLoaded', () => {
   Butr.init({
-    To: false,
     Marker: true,
     AutoAnchors: true,
     AutoSidebar: true,
     StickyNav: true,
-    scrollOffset: 126,
-    distanceTop: 0,
-    topBuffer: 30,
-    avoid: '.Footer',
-    avoidBuffer: 24,
+    scrollOffset: 128,
     mediaQuery: '(min-width: 1200px)'
   })
+  Butr.to({
+    target: 500
+  })
 })

package.json

@@ -1,6 +1,6 @@
 {
   "name": "butr",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Scroll like butter",
   "contributors": [
     "Bill Columbia <[email protected]>",

src/autoAnchors.js

@@ -17,12 +17,7 @@ export const AutoAnchors = () => {
     links[i].addEventListener('click', e => {
       e.preventDefault()
       To({
-        target: e.currentTarget.getAttribute('href'),
-        direction: State.settings.direction,
-        keepHash: State.settings.keepHash,
-        speed: State.settings.speed,
-        afterTo: State.settings.afterTo,
-        scrollOffset: State.settings.scrollOffset
+        target: e.currentTarget.getAttribute('href')
       })
     })
   }

src/butr.js

@@ -7,13 +7,6 @@ import { StickyNav } from './stickyNav'
 import { State } from './state'
 
 const defaults = {
-  // To
-  target: 0,
-  direction: 'y',
-  keepHash: true,
-  speed: 1,
-  afterTo: null,
-  scrollOffset: 0,
   // Sidebar
   olClass: 'Butr__Sidebar__List',
   liClass: 'Butr__Sidebar__Item',

src/to.js

@@ -7,8 +7,21 @@ import { State } from './state'
  * A stand alone, globally accessible method for scrolling to a target
  * (location or hash).
  */
-export const To = (options = {}) => {
-  options = Object.assign({}, State.settings, options)
+export const To = (options) => {
+  const defaults = {
+    target: 0,
+    direction: 'y',
+    keepHash: true,
+    speed: 1,
+    afterTo: null,
+    /**
+     * A global offset can be passed from Butr's initialization that will be used
+     * as the default instead of 0 when needed. Otherwise it can be explicitly
+     * set when using To() or Butr.to()
+     */
+    scrollOffset: State.settings.scrollOffset || 0,
+  }
+  options = Object.assign({}, defaults, options)
 
   // User may prefer reduced motion - do not animate to scroll position
   const prefersReducedMotion = window.matchMedia('(prefers-reduced-motion)').matches
@@ -35,7 +48,7 @@ export const To = (options = {}) => {
    */
   const getCurrentPosition = () => {
     if (options.direction === 'x') return scrollingElement.scrollLeft
-    if (options.direction === 'y') return scrollingElement.scrollTop
+    else return scrollingElement.scrollTop
   }
 
   /**
@@ -67,7 +80,7 @@ export const To = (options = {}) => {
    */
   const scrollTheEl = distance => {
     if (options.direction === 'x') scrollingElement.scrollLeft = distance
-    if (options.direction === 'y') scrollingElement.scrollTop = distance
+    else scrollingElement.scrollTop = distance
   }
 
   /**