React Simple Pull To Refresh

Author: thmsgbrt

.gitignore

@@ -0,0 +1,17 @@
+# dependencies
+/node_modules
+
+# production
+/build
+
+# misc
+.DS_Store
+.ideas
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+#rollup
+/build
+.env

.prettierrc.yaml

@@ -0,0 +1,11 @@
+printWidth: 110
+tabWidth: 2
+useTabs: false
+semi: true
+singleQuote: true
+quoteProps: 'consistent'
+jsxSingleQuote: false
+trailingComma: 'es5'
+bracketSpacing: true
+jsxBracketSameLine: false
+arrowParens: 'avoid'

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "workbench.colorCustomizations": {
+    "titleBar.activeForeground": "#61dafb",
+    "titleBar.inactiveForeground": "#53b7d3",
+    "titleBar.activeBackground": "#20232a",
+    "titleBar.inactiveBackground": "#0a0e16"
+  },
+  "editor.formatOnSave": true,
+  "files.insertFinalNewline": true,
+  "editor.tabSize": 2
+}

LICENCE

@@ -0,0 +1,7 @@
+Copyright 2019 GUIBERT THOMAS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1 +1,50 @@
-# react-simple-pull-to-refresh
+# react-simple-pull-to-refresh
+
+[![npm version](https://badge.fury.io/js/react-simple-pull-to-refresh.svg)](https://badge.fury.io/js/react-simple-pull-to-refresh)
+[![license](https://img.shields.io/github/license/thmsgbrt/react-simple-pull-to-refresh.svg)](https://github.com/thmsgbrt/react-simple-pull-to-refresh/blob/master/LICENSE)
+A Simple Pull To Refresh Component for React Application with 0 dependency.
+
+## Demo
+
+TBD
+
+## installation
+
+`npm install react-simple-pull-to-refresh`
+
+## Usage
+
+#### import PullToRefresh
+
+```tsx
+import PullToRefresh from 'react-simple-pull-to-refresh';
+```
+
+#### Sample
+
+```tsx
+<PullToRefresh onRefresh={handleRefresh}>
+  <ul>
+    {list.map((item: string, index: number) => (
+      <li key={index}>{item}</li>
+    ))}
+  </ul>
+</PullToRefresh>
+```
+
+## Props Matrix
+
+|        Name         |         Type          | Required | Description                                                   |
+| :-----------------: | :-------------------: | :------: | ------------------------------------------------------------- |
+|  refreshingContent  | JSX.Element or string |  false   | Content displayed when refresh has been trigerred             |
+|   pullingContent    | JSX.Element or string |  false   | Content displayed when pulling                                |
+|  pullDownThreshold  |        number         |  false   | Distance to pull in pixel in order to trigger a refresh event |
+| maxPullDownDistance |        number         |  false   | Maximum distance applied to Children when dragging            |
+|      onRefresh      |       Function        |   true   | Function called when fefresh has been trigerred               |
+|   backgroundColor   |        string         |  false   | Apply a backgroundColor                                       |
+|     isPullable      |        boolean        |  false   | Enable or disable pulling behavior                            |
+|      className      |        string         |  false   |                                                               |
+
+## Contributing
+
+`npm run dev`