├── index.js
├── README.md
├── package.json
├── LICENSE
└── .gitignore


/index.js:
--------------------------------------------------------------------------------
 1 | import React from "react";
 2 | 
 3 | class ReactStorehouse extends React.Component {
 4 |   update(value) {
 5 |     window.localStorage.setItem(this.props.item, JSON.stringify(value));
 6 |     return this.forceUpdate();
 7 |   }
 8 | 
 9 |   render() {
10 |     if (this.props.render) {
11 |       return this.props.render(
12 |         JSON.parse(window.localStorage.getItem(this.props.item)) || undefined,
13 |         this.update.bind(this)
14 |       );
15 |     }
16 | 
17 |     return null;
18 |   }
19 | }
20 | 
21 | export default ReactStorehouse;
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # react-storehouse
 2 | A React component interface to LocalStorage
 3 | 
 4 | ## Example
 5 | This is a no frills example of using `react-storehouse` for a user name.
 6 | ```js
 7 |   <LocalStorageProvider
 8 |     item="name"
 9 |     render={(name = "Guest", update) => (
10 |       <h1>Hi {name}!</h1>
11 |       <input
12 |         onChange={e => update(e.target.value)}
13 |         type="text"
14 |       />
15 |     )}
16 |   />
17 | ```
18 | 
19 | ## Installation
20 | ### Node
21 | ```npm i react-storehouse --save```
22 | or
23 | ```yarn add react-storehouse```
24 | 
25 | ### Browser
26 | Exports `ReactStorehouse` on `window`.
27 | 
28 | ```js
29 | <script
30 |   crossorigin
31 |   src="https://unpkg.com/react-storehouse"
32 | ></script>
33 | ```
34 | 
35 | ## Code Quality
36 | [Learn React](#https://learnreact.com) open source, is intended for education.
37 | Source should be singularly focus and readable above all.
38 | 
39 | ## License
40 | MIT License
41 | Copyright &copy; Michael Chan 2017
42 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "react-storehouse",
 3 |   "version": "1.0.2",
 4 |   "description": "A component for use with localStorage and sessionStorage",
 5 |   "source": "index.js",
 6 |   "main": "dist/react-storehouse.js",
 7 |   "module": "dist/react-storehouse.esm.js",
 8 |   "browser": "dist/react-storehouse.umd.js",
 9 |   "scripts": {
10 |     "test": "echo \"Error: no test specified\" && exit 1",
11 |     "pretest": "npm run build",
12 |     "build": "microbundle",
13 |     "prepublish": "npm run build",
14 |     "dev": "microbundle watch"
15 |   },
16 |   "author": "Michael Chan (@chantastic)",
17 |   "license": "MIT",
18 |   "homepage": "https://github.com/learnreact/react-storehouse",
19 |   "repository": {
20 |     "type": "git",
21 |     "url": "https://github.com/learnreact/react-storehouse.git"
22 |   },
23 |   "bugs": {
24 |     "url": "https://github.com/learnreact/react-storehouse/issues"
25 |   },
26 |   "files": [
27 |     "dist",
28 |     "index.js"
29 |   ],
30 |   "peerDependencies": {
31 |     "react": "^15.6.1"
32 |   },
33 |   "devDependencies": {
34 |     "microbundle": "^0.10.0"
35 |   }
36 | }
37 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2017 Michael Chan
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Logs
 2 | logs
 3 | *.log
 4 | npm-debug.log*
 5 | yarn-debug.log*
 6 | yarn-error.log*
 7 | 
 8 | # Runtime data
 9 | pids
10 | *.pid
11 | *.seed
12 | *.pid.lock
13 | 
14 | # Directory for instrumented libs generated by jscoverage/JSCover
15 | lib-cov
16 | 
17 | # Coverage directory used by tools like istanbul
18 | coverage
19 | 
20 | # nyc test coverage
21 | .nyc_output
22 | 
23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
24 | .grunt
25 | 
26 | # Bower dependency directory (https://bower.io/)
27 | bower_components
28 | 
29 | # node-waf configuration
30 | .lock-wscript
31 | 
32 | # Compiled binary addons (http://nodejs.org/api/addons.html)
33 | build/Release
34 | 
35 | # Dependency directories
36 | node_modules/
37 | jspm_packages/
38 | 
39 | # Typescript v1 declaration files
40 | typings/
41 | 
42 | # Optional npm cache directory
43 | .npm
44 | 
45 | # Optional eslint cache
46 | .eslintcache
47 | 
48 | # Optional REPL history
49 | .node_repl_history
50 | 
51 | # Output of 'npm pack'
52 | *.tgz
53 | 
54 | # Yarn Integrity file
55 | .yarn-integrity
56 | 
57 | # dotenv environment variables file
58 | .env
59 | 
60 | dist/


--------------------------------------------------------------------------------