Adds initial code

wakecoder · wakecoder · commit 6ec9876bc406 · 2019-11-11T09:06:40.000-06:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+/dist/
+/node_modules/
diff --git a/README.md b/README.md
@@ -1,2 +1,27 @@
 # vue-default-scroll
 Provides reasonable default scroll behavior for the vue-rouiter
+
+## What does it do?
+By default, the vue-router doesn't scroll to the top of a page when you navigate. This package does the following:
+- Scrolls to the top when navigating to a new page when navigating for the first time
+- Scrolls to a saved position if navigating back
+- Scrolls to the appropriate anchor when navigating to a URL with a hash.
+
+## How do I use it?
+
+1. In a shell / command line:
+``` 
+yarn add vue-default-scroll
+```
+
+2. In your project
+```
+import Router from 'vue-router'
+import {scrollBehavior} from 'vue-default-scroll'
+Vue.use(Router);
+
+export default new Router({
+  scrollBehavior,
+  mode: 'history'
+}
+```
diff --git a/package.json b/package.json
@@ -0,0 +1,19 @@
+{
+  "name": "vue-default-scroll",
+  "version": "1.0.0",
+  "description": "A scroll behavior for the vue-router that does what you would expect -- scrolls to the top, or a hash, or a saved position.",
+  "main": "/dist/index.js",
+  "repository": "https://github.com/wakecoder/vue-default-scroll.git",
+  "author": "wakecoder",
+  "license": "MIT",
+  "private": false,
+  "scripts": {
+    "build": "tsc"
+  },
+  "dependencies": {
+    "vue-router": "^3.1.3"
+  },
+  "devDependencies": {
+    "typescript": "^3.7.2"
+  }
+}
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,12 @@
+import { Route } from 'vue-router'
+export function scrollBehavior(to: Route, from: Route, savedPosition: void | { x: number, y: number }) {
+    if (savedPosition) {
+        return savedPosition
+    } else {
+        if (to.hash) {
+            return { selector: to.hash }
+        } else {
+            return { x: 0, y: 0 }
+        }
+    }
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,19 @@
+{
+    "compileOnSave": true,
+    "compilerOptions": {
+        "module": "esnext",
+        "noImplicitAny": true,
+        "removeComments": true,
+        "preserveConstEnums": true,
+        "sourceMap": false,
+        "outDir": "dist",
+        "declaration": true
+    },
+    "include": [
+        "src/**/*"
+    ],
+    "exclude": [
+        "node_modules",
+        "**/*.spec.ts"
+    ]
+}
diff --git a/yarn.lock b/yarn.lock
@@ -0,0 +1,13 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+typescript@^3.7.2:
+  version "3.7.2"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.7.2.tgz#27e489b95fa5909445e9fef5ee48d81697ad18fb"
+  integrity sha512-ml7V7JfiN2Xwvcer+XAf2csGO1bPBdRbFCkYBczNZggrBZ9c7G3riSUeJmqEU5uOtXNPMhE3n+R4FA/3YOAWOQ==
+
+vue-router@^3.1.3:
+  version "3.1.3"
+  resolved "https://registry.yarnpkg.com/vue-router/-/vue-router-3.1.3.tgz#e6b14fabc0c0ee9fda0e2cbbda74b350e28e412b"
+  integrity sha512-8iSa4mGNXBjyuSZFCCO4fiKfvzqk+mhL0lnKuGcQtO1eoj8nq3CmbEG8FwK5QqoqwDgsjsf1GDuisDX4cdb/aQ==
