react-hook-shared-state

A simple way to create shared state using the hook API from React.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
react-hook-shared-state
900.0.25 years ago6 years agoMinified + gzip package size for react-hook-shared-state in KB

Readme

react-hook-shared-state
A simple way to create shared state using the hook API from React.
Requires at least React 16.7.0
Install
yarn add react-hook-shared-state
Example
import createSharedState from 'react-hook-shared-state'

const [useSharedState, setSharedState] = createSharedState('initial state')

/*
 * The state of every component will be assigned the same value.
 */
const MyComponent = () => {
  const state = useSharedState()
  return (
    <div
      onClick={() => setSharedState(state => state.replace('initial', 'new'))}
    >
      {state}
    </div>
  )
}
API
createSharedState(initialValue)
Returns a tuple with two functions in this order:
  • useSharedState() - Use this in your component. This will return the current state and cause your component to rerender when a new state is set.
  • setSharedState(nextState | (previousState) => nextState) - Call this function to set the new shared state.
You can also pass a function which will receive the previous state as a parameter and returns the next state.