├── .gitignore
├── .npmignore
├── LICENSE
├── README.md
├── doc
    └── demo.gif
├── index.js
└── package.json


/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules/
2 | 


--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | doc/
2 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2020 Trevor Orsztynowicz
 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 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # 📡 useBroadcast
 2 | 
 3 | This is a React hook that lets you keep two browser tabs / windows in sync.
 4 | Behind the scenes it uses the [Broadcast Channel API][1] to send messages
 5 | between instances. This way you can take action in one tab and have the state
 6 | automatically shared with other instances of your component regardless of which
 7 | window or tab they're in. 
 8 | 
 9 | ![Demo](https://github.com/trevoro/use-broadcast/blob/master/doc/demo.gif)
10 | 
11 | ## Example
12 | 
13 | ```javascript
14 | import { useBroadcast } from 'use-broadcast';
15 | 
16 | export const MyComponent = () => {
17 |   const initialState = 0;
18 |   const [state, setState] = useBroadcast('channel_name', initialState);
19 | 
20 |   function click() {
21 |     setState(state + 1);
22 |   }
23 | 
24 |   return (
25 |     <div>
26 |       <button onClick={click}>increment</button>
27 |     </div>
28 |   )
29 | }
30 | ```
31 | 
32 | [1]: https://developer.mozilla.org/en-US/docs/Web/API/Broadcast_Channel_API
33 | 


--------------------------------------------------------------------------------
/doc/demo.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/trevoro/use-broadcast/8bf324ff7e568853a8c1a2d1a8c2a88ad8f337d5/doc/demo.gif


--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
 1 | import { useReducer } from "react";
 2 | 
 3 | function reducer(state, action) {
 4 |   switch (action.type) {
 5 |     case "set":
 6 |       state = action.value;
 7 |       return state;
 8 |     default:
 9 |       throw new Error();
10 |   }
11 | }
12 | 
13 | export function useBroadcast(name, initialState) {
14 |   let [state, dispatch] = useReducer(reducer, initialState);
15 |   let channel = new BroadcastChannel(name);
16 | 
17 |   channel.onmessage = function(event) {
18 |     event.preventDefault();
19 |     let { data: value } = event;
20 |     dispatch({ type: "set", value });
21 |   };
22 | 
23 |   function setState(value) {
24 |     channel.postMessage(value);
25 |     dispatch({ type: "set", value });
26 |   }
27 | 
28 |   return [state, setState];
29 | }
30 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "use-broadcast",
 3 |   "version": "0.1.2",
 4 |   "description": "easily keep multiple tabs in sync using broadcast channels",
 5 |   "main": "index.js",
 6 |   "scripts": {
 7 |     "test": "echo \"Error: no test specified\" && exit 1"
 8 |   },
 9 |   "author": "Trevor Orsztynowicz",
10 |   "license": "MIT",
11 |   "repository": {
12 |     "type": "git",
13 |     "url": "git+https://http://github.com/trevoro/use-broadcast"
14 |   },
15 |   "homepage": "https://github.com/trevoro/use-broadcast/issues",
16 |   "peerDependencies": {
17 |     "react": ">=16.8.0"
18 |   }
19 | }
20 | 


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