Initial commit

Author: freddydumont

.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": [["babel-preset-gatsby-package", { "browser": true }]]
+}

.gitignore

@@ -0,0 +1,95 @@
+# Built files
+/*.js
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# gatsby files
+.cache/
+public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/

.npmignore

@@ -0,0 +1,34 @@
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+node_modules
+*.un~
+yarn.lock
+src
+flow-typed
+coverage
+decls
+examples

README.md

@@ -0,0 +1,43 @@
+## Description
+
+The plugin uses [`smoothscroll-polyfill`](https://www.npmjs.com/package/smoothscroll-polyfill) and calls it during the `onClientEntry` Gatsby lifecycle method.
+
+It also includes a `scrollTo` helper function as its main export that you can use as `onClick` event handlers to scroll to the desired element using `{ behavior: 'smooth' }`.
+
+## How to install
+
+```bash
+# npm
+npm install gastby-plugin-smoothscroll
+
+# yarn
+yarn add gastby-plugin-smoothscroll
+```
+
+## When do I use this plugin?
+
+When you want a polyfilled smooth scroll behavior without having to manually install and call the polyfill.
+
+## Examples of usage
+
+Just add the plugin to the plugins array in your `gatsby-config.js`:
+
+```js
+plugins: [`gatsby-plugin-smoothscroll`];
+```
+
+If you want to use the helper function, import it:
+
+```js
+// this could be in your `pages/index.js` file
+
+import scrollTo from 'gatsby-plugin-smoothscroll';
+```
+
+Then use it as an `onClick` event handler:
+
+```jsx
+<button onClick={() => scrollTo('#some-id')}>My link</button>
+```
+
+Be aware that `scrollTo` uses [`document.querySelector()`](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector) under the hood, so make sure to respect its syntax.

package.json

@@ -0,0 +1,36 @@
+{
+  "name": "gatsby-plugin-smoothscroll",
+  "version": "1.0.0",
+  "author": "Frederick Morin (https://freddydumont.com)",
+  "description": "Polyfilled smoothscroll behavior and helper function for gatsby sites",
+  "keywords": [
+    "gatsby",
+    "gatsby-plugin",
+    "smooth",
+    "scroll",
+    "smoothscroll",
+    "scrollIntoView",
+    "polyfill"
+  ],
+  "license": "MIT",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/freddydumont/gatsby-plugin-smoothscroll.git"
+  },
+  "homepage": "https://github.com/freddydumont/gatsby-plugin-smoothscroll#readme",
+  "scripts": {
+    "build": "babel src --out-dir . --ignore **/__tests__",
+    "prepare": "cross-env NODE_ENV=production npm run build",
+    "watch": "babel -w src --out-dir . --ignore **/__tests__"
+  },
+  "dependencies": {
+    "smoothscroll-polyfill": "^0.4.4"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.6.0",
+    "@babel/core": "^7.6.0",
+    "babel-preset-gatsby-package": "^0.2.4",
+    "cross-env": "^5.2.1"
+  }
+}

src/gatsby-browser.js

@@ -0,0 +1,5 @@
+var smoothscroll = require('smoothscroll-polyfill');
+
+exports.onClientEntry = () => {
+  smoothscroll.polyfill();
+};

src/index.js

@@ -0,0 +1,8 @@
+const scrollTo = (selector) => {
+  document.querySelector(selector).scrollIntoView({
+    behavior: 'smooth',
+    block: 'start',
+  });
+};
+
+export default scrollTo;