Skip to content

React Hook to share state without passing props or hierarchies

License

Notifications You must be signed in to change notification settings

magnumjs/shared-state-hook

Repository files navigation

shared-state-hook

npm (scoped) npm bundle size (minified)

This is a module for React that implements a hook named useSharedState for managing application state. It is similar to the provided hook useState, but rather than associating the state with the component that uses the hook, it stores the state outside of the component so it can be shared by many components.

Install

$ npm install shared-state-hook

Browser

<script src="//unpkg.com/shared-state-hook"></script>

https://unpkg.com/shared-state-hook

Example

import {useSharedState} from 'shared-state-hook'

const Counter = props => {
  
 const [count, setCount] = useSharedState("counter", props.count)
 
 return (
    <div>
      <p>You clicked {count} times</p>
      <button onClick={() => setCount(count + 1)}>
        Click me
      </button>
    </div>
  )
}
  
const CounterApp1 = props => <Counter count={1}/>
//Order matters, initial value has already been set
const CounterApp2 = props => <Counter count={2}/>

Try it on JSBin - CodeSandBox

API

useSharedState

import {useSharedState} from "shared-state-hook"

const Component = props => {
const [userInfo, setUserInfo] = useSharedState("userInfo", optionalInitialValue, optionalOnUpdatesCallback)
return ""
}
//=> "!"

useHooksOutside

Allows you to use React Hooks outside of the function body

Invariant React Error 307 image

import {useHooksOutside} from "shared-state-hook"

const callbackReturnValue = useHooksOutside(()=>{
    //Call any restricted React Hook outside of a component function body! 
    useState()
    useEffect()
    useContext()
    return useSharedState("userInfo", initialValues)
});
//=> "!"

You can initialize useSharedState from useHooksOutside as a external Provider that will both update the shared state by others as well as get notified if anyone else updates the same name share

let notifier
const rel = useHooksOutside(() => {
  const onUpdate = updates => {
    $scope.user = {
        ...$scope.user, ...updates
    }
    $scope.$apply()
  }
  
  const [, setUser] = useSharedState("user", $scope.user, onUpdate)
  notifier=setUser    
})

Forked from top-state-hook

About

React Hook to share state without passing props or hierarchies

Resources

License

Stars

Watchers

Forks

Packages

No packages published