useHashScroll demo added and ChildrenHash warning fixed

Author: YashTotale

.eslintrc

@@ -33,6 +33,7 @@
     "@typescript-eslint/no-explicit-any": "off",
     "no-constant-condition": ["error", { "checkLoops": false }],
     "react-hooks/rules-of-hooks": "error",
-    "react-hooks/exhaustive-deps": "warn"
+    "react-hooks/exhaustive-deps": "warn",
+    "tsdoc/syntax": "warn"
   }
 }

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

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

CHANGELOG.md

@@ -7,38 +7,53 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/), and this
 **Table of Contents**
 
 - [[Unreleased]](#unreleased)
-- [[v1.4.0] - (2020-12-03)](#v140---2020-12-03)
+- [[v1.4.1] - (2020-12-03)](#v141---2020-12-03)
   - [Added](#added)
-- [[v1.3.2] - (2020-12-02)](#v132---2020-12-02)
+  - [Fixed](#fixed)
+- [[v1.4.0] - (2020-12-03)](#v140---2020-12-03)
   - [Added](#added-1)
-- [[v1.3.1] - (2020-11-30)](#v131---2020-11-30)
+- [[v1.3.2] - (2020-12-02)](#v132---2020-12-02)
   - [Added](#added-2)
-- [[v1.3.0] - (2020-11-27)](#v130---2020-11-27)
+- [[v1.3.1] - (2020-11-30)](#v131---2020-11-30)
   - [Added](#added-3)
+- [[v1.3.0] - (2020-11-27)](#v130---2020-11-27)
+  - [Added](#added-4)
   - [Dependencies](#dependencies)
 - [[v1.2.3] - (2020-11-26)](#v123---2020-11-26)
   - [Removed](#removed)
 - [[v1.2.2] - (2020-11-26)](#v122---2020-11-26)
-  - [Fixed](#fixed)
-- [[v1.2.1] - (2020-11-26)](#v121---2020-11-26)
   - [Fixed](#fixed-1)
+- [[v1.2.1] - (2020-11-26)](#v121---2020-11-26)
+  - [Fixed](#fixed-2)
 - [[v1.2.0] - (2020-11-26)](#v120---2020-11-26)
-  - [Added](#added-4)
+  - [Added](#added-5)
   - [Changed](#changed)
 - [[v1.1.0] - (2020-11-24)](#v110---2020-11-24)
-  - [Added](#added-5)
+  - [Added](#added-6)
   - [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-6)
-  - [Fixed](#fixed-2)
+  - [Added](#added-7)
+  - [Fixed](#fixed-3)
 - [[1.0.0] - (2020-11-23)](#100---2020-11-23)
 
 ## [Unreleased]
 
 ---
 
+## [v1.4.1] - (2020-12-03)
+
+### Added
+
+- useHashScroll demo
+
+### Fixed
+
+- ChildrenHash logging warning inaccurately
+
+---
+
 ## [v1.4.0] - (2020-12-03)
 
 ### Added

README.md

@@ -303,6 +303,10 @@ const App = () => {
 
 Creates a ref that scrolls to its assigned element when a specified hash is present in the url
 
+#### Demo
+
+[![View useHashScroll Demo](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/react-hash-scroll-demos-ge3b4?initialpath=use-hash-scroll&module=/src/Demos/UseHashScrollDemo.tsx)
+
 #### Params
 
 `hash`

docs/Hooks/useHashScroll.md

@@ -4,6 +4,10 @@
 
 Creates a ref that scrolls to its assigned element when a specified hash is present in the url
 
+#### Demo
+
+[![View useHashScroll Demo](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/react-hash-scroll-demos-ge3b4?initialpath=use-hash-scroll&module=/src/Demos/UseHashScrollDemo.tsx)
+
 #### Params
 
 `hash`

src/Components/ChildrenHash.tsx

@@ -57,7 +57,7 @@ const ChildrenHash: FC<ChildrenHashProps> = ({
   requiredPathname,
   scrollFunc,
 }) => {
-  warning(hashes.length !== children.length, CHILDREN_HASH_UNEQUAL_LENGTHS);
+  warning(hashes.length === children.length, CHILDREN_HASH_UNEQUAL_LENGTHS);
   return (
     <>
       {children.map((child, i) => (

src/Utils/messages.ts

@@ -1,2 +1,2 @@
 export const CHILDREN_HASH_UNEQUAL_LENGTHS =
-  "The number of hashes and children should be the same so that each child corresponds to a hash";
+  "The number of hashes and children should be the same so that each child corresponds to a hash (ChildrenHash) - React Hash Scroll";