[1.1.0] version 1.1.0 of use-scroll-to-bottom

update create-react-library to version 3
change api to return a RefCallback instead of a Ref
add tests to hook
add tests to examples
add 1 example with reusing the hook

Author: tudorgergely

.eslintignore

@@ -0,0 +1,6 @@
+build/
+dist/
+node_modules/
+.snapshots/
+*.min.js
+*.d.ts

.eslintrc

@@ -0,0 +1,33 @@
+{
+  "parser": "babel-eslint",
+  "extends": [
+    "standard",
+    "standard-react",
+    "plugin:prettier/recommended",
+    "prettier/standard",
+    "prettier/react"
+  ],
+  "env": {
+    "node": true
+  },
+  "parserOptions": {
+    "ecmaVersion": 9,
+    "ecmaFeatures": {
+      "legacyDecorators": true,
+      "jsx": true
+    }
+  },
+  "settings": {
+    "react": {
+      "version": "16"
+    }
+  },
+  "rules": {
+    "space-before-function-paren": 0,
+    "react/prop-types": 0,
+    "react/jsx-handler-names": 0,
+    "react/jsx-fragments": 0,
+    "react/no-unused-prop-types": 0,
+    "import/export": 0
+  }
+}

.idea/codeStyles/Project.xml

@@ -0,0 +1,9 @@
+{
+  "singleQuote": true,
+  "jsxSingleQuote": true,
+  "semi": false,
+  "tabWidth": 2,
+  "bracketSpacing": true,
+  "jsxBracketSameLine": false,
+  "arrowParens": "always"
+}

.idea/codeStyles/codeStyleConfig.xml

@@ -1,4 +1,4 @@
 language: node_js
 node_js:
-  - 9
-  - 8
+  - 12
+  - 10

.idea/workspace.xml

@@ -13,6 +13,10 @@ npm install --save use-scroll-to-bottom
 
 ## Usage
 
+The hook returns a tuple of two things:
+1. A RefCallback which needs to go on the last element of your scrolling container.
+2. A boolean value which tells you whether bottom has been reached or not.
+
 Check [demo](https://tudorgergely.github.io/use-scroll-to-bottom/) and [examples](https://github.com/tudorgergely/use-scroll-to-bottom/tree/master/example)
 
 ```tsx
@@ -21,15 +25,15 @@ import {useScrollToBottom} from 'use-scroll-to-bottom'
 
 export default function MyComponent() {
   // isBottom will be true when bottom is reached
-  // add ref to an element right below your scrollable one
-  const [ref, isBottom] = useScrollToBottom();
+  // add setBottomRef to the last element in your scrolling container
+  const [setBottomRef, isBottom] = useScrollToBottom();
 
   return (
     <div className="simple-container">
       <div className="big-element">
         {isBottom && "Bottom reached"}
       </div>
-      <div ref={ref}>Bottom</div>
+      <div ref={setBottomRef}>Bottom</div>
     </div>
   )
 }

.prettier.json

@@ -0,0 +1,14 @@
+### [Examples](https://tudorgergely.github.io/use-scroll-to-bottom/)
+
+
+#### To see examples:
+> npm i
+
+> npm start
+
+Open localhost:3000 to see the examples
+
+
+####To run tests on examples:
+> npm test
+