useHashScroll docs finished

Author: YashTotale

.github/workflows/firebase-hosting-merge.yml

@@ -7,7 +7,7 @@ on:
   push:
     paths:
       - "website/**"
-      - "website/**"
+      - "docs/**"
     branches:
       - "main"
 

.github/workflows/firebase-hosting-pull-request.yml

@@ -7,7 +7,6 @@ on:
   pull_request:
     paths:
       - "website/**"
-      - "docs/**"
     branch:
       - main
 

CHANGELOG.md

@@ -8,12 +8,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/), and this
 
 - [[Unreleased]](#unreleased)
 - [[v1.4.0] - (2020-12-03)](#v140---2020-12-03)
-- [[v1.3.2] - (2020-12-02)](#v132---2020-12-02)
   - [Added](#added)
-- [[v1.3.1] - (2020-11-30)](#v131---2020-11-30)
+- [[v1.3.2] - (2020-12-02)](#v132---2020-12-02)
   - [Added](#added-1)
-- [[v1.3.0] - (2020-11-27)](#v130---2020-11-27)
+- [[v1.3.1] - (2020-11-30)](#v131---2020-11-30)
   - [Added](#added-2)
+- [[v1.3.0] - (2020-11-27)](#v130---2020-11-27)
+  - [Added](#added-3)
   - [Dependencies](#dependencies)
 - [[v1.2.3] - (2020-11-26)](#v123---2020-11-26)
   - [Removed](#removed)
@@ -22,15 +23,15 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/), and this
 - [[v1.2.1] - (2020-11-26)](#v121---2020-11-26)
   - [Fixed](#fixed-1)
 - [[v1.2.0] - (2020-11-26)](#v120---2020-11-26)
-  - [Added](#added-3)
+  - [Added](#added-4)
   - [Changed](#changed)
 - [[v1.1.0] - (2020-11-24)](#v110---2020-11-24)
-  - [Added](#added-4)
+  - [Added](#added-5)
   - [Changed](#changed-1)
 - [[v1.0.2] - (2020-11-23)](#v102---2020-11-23)
   - [Changed](#changed-2)
 - [[1.0.1] - (2020-11-23)](#101---2020-11-23)
-  - [Added](#added-5)
+  - [Added](#added-6)
   - [Fixed](#fixed-2)
 - [[1.0.0] - (2020-11-23)](#100---2020-11-23)
 
@@ -40,6 +41,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/), and this
 
 ## [v1.4.0] - (2020-12-03)
 
+### Added
+
+- useHashScroll hook
+
 ---
 
 ## [v1.3.2] - (2020-12-02)

README.md

@@ -37,11 +37,10 @@ _Table Of Contents_
 - [Hooks](#hooks)
   - [useHashScroll](#usehashscroll)
     - [Summary](#summary-3)
-    - [Demo](#demo-3)
     - [Params](#params)
     - [Example](#example-3)
 - [Reused Props](#reused-props)
-  - [behavir](#behavir)
+  - [behavior](#behavior)
   - [position](#position)
   - [requiredPathname](#requiredpathname)
   - [scrollFunc](#scrollfunc)
@@ -314,10 +313,47 @@ Creates a ref that scrolls to its assigned element when a specified hash is pres
 
 `options`
 
--
+- Object specifying optional scroll options
+
+  - [`behavior`](#behavior)
+
+  - [`position`](#position)
+
+  - [`requiredPathname`](#requiredpathname)
+
+  - [`scrollFunc`](#scrollfunc)
 
 #### Example
 
+```javascript
+import React from "react";
+import { BrowserRouter } from "react-router-dom"; //Can use HashRouter or MemoryRouter as well
+import { useHashScroll } from "react-hash-scroll";
+
+const App = () => {
+  return (
+    <BrowserRouter>
+      <Example
+        hash="#element1"
+        options={{
+          behavior: "smooth",
+        }}
+      >
+        Element #1
+      </Example>
+      <Example hash="#element2">Element #2</Example>
+      <Example hash="#element3">Element #3</Example>
+    </BrowserRouter>
+  );
+};
+
+const Example = ({ children, hash, options }) => {
+  const scrollRef = useHashScroll(hash, options); //options is optional
+
+  return <div ref={scrollRef}>Scrolled to when the hash is in the url</div>;
+};
+```
+
 ---
 
 ## Reused Props

docs/Hooks/useHashScroll.md

@@ -14,6 +14,43 @@ Creates a ref that scrolls to its assigned element when a specified hash is pres
 
 `options`
 
--
+- Object specifying optional scroll options
+
+  - [`behavior`](#behavior)
+
+  - [`position`](#position)
+
+  - [`requiredPathname`](#requiredpathname)
+
+  - [`scrollFunc`](#scrollfunc)
 
 #### Example
+
+```javascript
+import React from "react";
+import { BrowserRouter } from "react-router-dom"; //Can use HashRouter or MemoryRouter as well
+import { useHashScroll } from "react-hash-scroll";
+
+const App = () => {
+  return (
+    <BrowserRouter>
+      <Example
+        hash="#element1"
+        options={{
+          behavior: "smooth",
+        }}
+      >
+        Element #1
+      </Example>
+      <Example hash="#element2">Element #2</Example>
+      <Example hash="#element3">Element #3</Example>
+    </BrowserRouter>
+  );
+};
+
+const Example = ({ children, hash, options }) => {
+  const scrollRef = useHashScroll(hash, options); //options is optional
+
+  return <div ref={scrollRef}>Scrolled to when the hash is in the url</div>;
+};
+```