Small, fast and scaleable bearbones state-management solution. Has a comfy api based on hooks, isn't that boilerplatey or opinionated, but still just enough to be explicit and flux-like. Try a small live demo here.
npm install zustand
Your store is a hook! You can put anything in it, atomics, objects, functions. Like Reacts setState, set
merges state.
import create from 'zustand'
const [useStore] = create(set => ({
count: 0,
increase: () => set(state => ({ count: state.count + 1 })),
reset: () => set({ count: 0 })
}))
Use the hook anywhere, no providers needed. Once you have selected state your component will re-render on changes.
function Counter() {
const count = useStore(state => state.count)
return <h1>{count}</h1>
}
function Controls() {
const increase = useStore(state => state.increase)
return <button onClick={increase}>up</button>
}
- is simpler and un-opinionated
- makes hooks the primary means of consuming state
- isn't strictly dependent on actions, types & dispatch
- doesn't wrap your app into context providers (which allows it to support mixed reconcilers)
- can access state outside of components (and even React)
- has a solution for rapid state changes (look below for transient updates)
- is (or can be made) compatible with the redux api
You can, but remember that it will cause the component to update on every state change!
const state = useStore()
Just like with Redux's mapStateToProps, useStore can select state, either atomically or by returning an object. It will run a small shallow-equal test over the results you return and update the component on changes only.
const { foo, bar } = useStore(state => ({ foo: state.foo, bar: state.bar }))
Atomic selects do the same ...
const foo = useStore(state => state.foo)
const bar = useStore(state => state.bar)
Since you can create as many stores as you like, forwarding results to succeeding selectors is as natural as it gets.
const currentUser = useCredentialsStore(state => state.currentUser)
const person = usePersonStore(state => state.persons[currentUser])
Say you select a piece of state ...
const foo = useStore(state => state.foo[props.id])
Your selector (state => state.foo[props.id]
) will run on every state change, as well as every time the component renders. It isn't that expensive in this case, but let's optimize it for arguments sake.
You can either pass a static reference:
const fooSelector = useCallback(state => state.foo[props.id], [props.id])
const foo = useStore(fooSelector)
Or an optional dependencies array to let zustand know when the selector needs to update:
const foo = useStore(state => state.foo[props.id], [props.id])
From now on your selector is memoized and will only run when either the state changes, or the selector itself.
Just call set
when you're ready, it doesn't care if your actions are async or not.
const [useStore] = create(set => ({
json: {},
fetch: async url => {
const response = await fetch(url)
set({ json: await response.json() })
set
allows fn-updates set(state => result)
, but you still have access to state outside of it through get
.
const [useStore] = create((set, get) => ({
text: "hello",
action: () => {
const text = get().text
Reducing nested structures is tiresome. Have you tried immer?
import produce from "immer"
const [useStore] = create(set => ({
nested: { structure: { contains: { a: "value" } } },
set: fn => set(produce(fn)),
}))
const set = useStore(state => state.set)
set(state => void state.nested.structure.contains = null)
const types = { increase: "INCREASE", decrease: "DECREASE" }
const reducer = (state, { type, by = 1 }) => {
switch (type) {
case types.increase: return { count: state.count + by }
case types.decrease: return { count: state.count - by }
}
}
const [useStore] = create(set => ({
count: 0,
dispatch: args => set(state => reducer(state, args)),
}))
const dispatch = useStore(state => state.dispatch)
dispatch({ type: types.increase, by: 2 })
You can use it with or without React out of the box.
const [, api] = create({ a: 1, b: 2, c: 3 })
// Getting fresh state
const num = api.getState().n
// Listening to all changes, fires on every dispatch
const unsub1 = api.subscribe(state => console.log("state changed", state))
// Listening to selected changes
const unsub2 = api.subscribe(state => state.a, a => console.log("a changed", a))
// Updating state, will trigger listeners
api.setState({ a: 1 })
// Unsubscribe listeners
unsub1()
unsub2()
// Destroying the store (removing all listeners)
api.destroy()
The api signature of subscribe([selector,] callback):unsub allows you to easily bind a component to a store without forcing it to re-render on state changes, you will be notified in a callback instead. Best combine it with useEffect. This can make a drastic performance difference when you are allowed to mutate the view directly.
const [useStore, api] = create(set => ({ [0]: [-10, 0], [1]: [10, 5], ... }))
function Component({ id }) {
// Fetch initial state
const xy = useRef(api.getState()[id])
// Connect to the store on mount, disconnect on unmount, catch state-changes in a callback
useEffect(() => api.subscribe(state => state[id], coords => (xy.current = coords)), [id])
You can functionally compose your store any way you like.
// Log every time state is changed
const log = config => (set, get, api) => config(args => {
console.log(" applying", args)
set(args)
console.log(" new state", get())
}, get, api)
// Turn the set method into an immer proxy
const immer = config => (set, get, api) => config(fn => set(produce(fn)), get, api)
const [useStore] = create(log(immer(set => ({
text: "hello",
setText: input => set(state => {
state.text = input
})
}))))
Yes, it's currently being hashed out but you can already start using it: https://codesandbox.io/s/amazing-kepler-swxol. It works with regular actions as well, you don't need reducers for this.