useMappedState maps values from the provided (atom/Redux) store and keeps your Component synced with any changes to those mapped values.
npm install --save @app-elements/use-mapped-state
import { useMappedState } from '@app-elements/use-mapped-state'
import createStore from 'atom'
const store = createStore([], { count: 0 })
// Here is a simple view that expects a `count` value
// form the global state.
const Stateful = (props) => {
// `mapper` is a function that is given the entire state object from your store.
// Your job is to return the portion of that state object that this Component
// is concerned with.
const mapper = ({ count }) => ({ count })
const { count } = useMappedState(store, mapper)
return (
<p>Count: {count}</p>
)
}
Prop | Type | Default | Description |
---|---|---|---|
store |
Object | None | An (atom) store instance |
mapper |
Function | None | A function that accepts (state) and returns an object |