fix: safari scrolling on window now works properly (#106)

Also reduces bundlesize

Author: stipsan

README.md

@@ -15,7 +15,7 @@ And while `scroll-into-view-if-needed` use the same default options as browsers
 ## Install
 
 ```bash
-yarn add smooth-scroll-into-view-if-needed scroll-into-view-if-needed
+yarn add smooth-scroll-into-view-if-needed
 ```
 
 ## Usage

package.json

@@ -26,12 +26,12 @@
     "build:umd.min": "BABEL_ENV=umd NODE_ENV=production rollup -c -f umd -o umd/smooth-scroll-into-view-if-needed.min.js",
     "clean": "rimraf 'umd' 'es' 'typings'",
     "precommit": "lint-staged",
-    "dev": "concurrently 'tsc --watch' 'yarn build:cjs --watch'",
+    "dev": "concurrently 'tsc --noEmit --watch' 'yarn build:cjs --watch' 'yarn build:es --watch' 'yarn build:umd --watch' 'yarn build:umd.min --watch'",
     "prepublishOnly": "unset npm_config_cafile && yarn build",
     "typecheck": "tsc --noEmit"
   },
-  "peerDependencies": {
-    "scroll-into-view-if-needed": "^2.2.1"
+  "dependencies": {
+    "scroll-into-view-if-needed": "2.2.9"
   },
   "devDependencies": {
     "@babel/cli": "7.0.0-beta.51",
@@ -58,7 +58,6 @@
     "rollup-plugin-node-resolve": "3.3.0",
     "rollup-plugin-replace": "2.0.0",
     "rollup-plugin-terser": "1.0.1",
-    "scroll-into-view-if-needed": "2.2.8",
     "semantic-release": "15.6.0",
     "typescript": "2.9.2"
   },

src/index.ts

@@ -14,7 +14,7 @@ export interface SmoothBehaviorOptions extends Options {
 }
 
 // Memoize so we're much more friendly to non-dom envs
-let memoizedNow
+let memoizedNow: () => number
 const now = () => {
   if (!memoizedNow) {
     memoizedNow =
@@ -23,7 +23,19 @@ const now = () => {
   return memoizedNow()
 }
 
-function step(context) {
+type Context = {
+  scrollable: Element
+  method: Function
+  startTime: number
+  startX: number
+  startY: number
+  x: number
+  y: number
+  duration: number
+  ease: CustomEasing
+  cb: Function
+}
+function step(context: Context) {
   const time = now()
   const elapsed = Math.min((time - context.startTime) / context.duration, 1)
 
@@ -42,33 +54,26 @@ function step(context) {
 }
 
 function smoothScroll(
-  el,
-  x,
-  y,
-  duration = 450,
-  ease = t => 1 + --t * t * t * t * t,
-  cb
+  el: Element,
+  x: number,
+  y: number,
+  duration = 600,
+  ease: CustomEasing = t => 1 + --t * t * t * t * t,
+  cb: Function
 ) {
   let scrollable
   let startX
   let startY
   let method
 
   // define scroll context
-  if (el === document.documentElement) {
-    scrollable = window
-    startX = window.scrollX || window.pageXOffset
-    startY = window.scrollY || window.pageYOffset
-    method = (x, y) => window.scroll(x, y)
-  } else {
-    scrollable = el
-    startX = el.scrollLeft
-    startY = el.scrollTop
-    method = (x, y) => {
-      // @TODO use Element.scroll if it exists, as it is potentially better performing
-      el.scrollLeft = x
-      el.scrollTop = y
-    }
+  scrollable = el
+  startX = el.scrollLeft
+  startY = el.scrollTop
+  method = (x: number, y: number) => {
+    // @TODO use Element.scroll if it exists, as it is potentially better performing
+    el.scrollLeft = x
+    el.scrollTop = y
   }
 
   // scroll looping over a frame
@@ -93,7 +98,7 @@ const shouldSmoothScroll = <T>(options: any): options is T => {
 function scroll(target: Element, options?: SmoothBehaviorOptions): Promise<any>
 function scroll<T>(target: Element, options: CustomBehaviorOptions<T>): T
 function scroll(target: Element, options: StandardBehaviorOptions): void
-function scroll<T>(target, options) {
+function scroll<T>(target: Element, options?: any) {
   if (shouldSmoothScroll<SmoothBehaviorOptions>(options)) {
     const overrides = options || {}
     // @TODO replace <any> in promise signatures with better information

tsconfig.json

@@ -12,7 +12,8 @@
     "skipLibCheck": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
-
+    "strict": true,
+    "noImplicitAny": true,
     "alwaysStrict": true,
     "lib": ["es5", "es2015.promise", "dom"]
   },

yarn.lock

@@ -3958,9 +3958,9 @@ sax@^1.2.4:
   version "1.2.4"
   resolved "https://registry.yarnpkg.com/sax/-/sax-1.2.4.tgz#2816234e2378bddc4e5354fab5caa895df7100d9"
 
-scroll-into-view-if-needed@2.2.8:
-  version "2.2.8"
-  resolved "https://registry.yarnpkg.com/scroll-into-view-if-needed/-/scroll-into-view-if-needed-2.2.8.tgz#c22ffbddce5c8a31949ab3e01c27a6c29ba7b979"
+scroll-into-view-if-needed@2.2.9:
+  version "2.2.9"
+  resolved "https://registry.yarnpkg.com/scroll-into-view-if-needed/-/scroll-into-view-if-needed-2.2.9.tgz#f6c95d60f2106893d549de6eef69cb6ce2ebe936"
 
 semantic-release@15.6.0:
   version "15.6.0"