This doc describes about jotai/utils bundle.
Ref: pmndrs#26
import { atom, useAtom } from 'jotai'
import { useUpdateAtom } from 'jotai/utils'
const countAtom = atom(0)
const Counter = () => {
const [count] = useAtom(countAtom)
return <div>count: {count}</div>
}
const Controls = () => {
const setCount = useUpdateAtom(countAtom)
const inc = () => setCount((c) => c + 1)
return <button onClick={inc}>+1</button>
}https://codesandbox.io/s/react-typescript-forked-3q11k
Ref: pmndrs#212
import { atom, Provider, useAtom } from 'jotai'
import { useAtomValue } from 'jotai/utils'
const countAtom = atom(0)
const Counter = () => {
const setCount = useUpdateAtom(countAtom)
const count = useAtomValue(countAtom)
return (
<>
<div>count: {count}</div>
<button onClick={() => setCount(count + 1)}>+1</button>
</>
)
}https://codesandbox.io/s/react-typescript-forked-1x90m
Ref: pmndrs#41
import { useAtom } from 'jotai'
import { atomWithReset, useResetAtom } from 'jotai/utils'
const todoListAtom = atomWithReset([
{
description: 'Add a todo',
checked: false,
},
])
const TodoList = () => {
const [todoList, setTodoList] = useAtom(todoListAtom)
const resetTodoList = useResetAtom(todoListAtom)
return (
<>
<ul>
{todoList.map((todo) => (
<li>{todo.description}</li>
))}
</ul>
<button
onClick={() =>
setTodoList((l) => [
...l,
{
description: `New todo ${new Date().toDateString()}`,
checked: false,
},
])
}>
Add todo
</button>
<button onClick={resetTodoList}>Reset</button>
</>
)
}https://codesandbox.io/s/react-typescript-forked-w91cq
import { atom } from 'jotai'
import { useReducerAtom } from 'jotai/utils'
const countReducer = (prev, action) => {
if (action.type === 'inc') return prev + 1
if (action.type === 'dec') return prev - 1
throw new Error('unknown action type')
}
const countAtom = atom(0)
const Counter = () => {
const [count, dispatch] = useReducerAtom(countAtom, countReducer)
return (
<div>
{count}
<button onClick={() => dispatch({ type: 'inc' })}>+1</button>
<button onClick={() => dispatch({ type: 'dec' })}>-1</button>
</div>
)
}https://codesandbox.io/s/react-typescript-forked-eg0mw
Ref: pmndrs#38
import { atomWithReducer } from 'jotai/utils'
const countReducer = (prev, action) => {
if (action.type === 'inc') return prev + 1
if (action.type === 'dec') return prev - 1
throw new Error('unknown action type')
}
const countReducerAtom = atomWithReducer(0, countReducer)https://codesandbox.io/s/react-typescript-forked-g3tsx
Ref: pmndrs#23
atomFamily(initializeRead, initializeWrite, areEqual): (param) => AtomThis will create a function that takes param and returns an atom.
If it's already created, it will return it from the cache.
initializeRead and initializeWrite are functions and return
read and write respectively that are fed into atom().
Note that initializeWrite is optional.
The third argument areEqual is also optional, which tell
if two params are equal (defaults to Object.is.)
To reproduce the similar behavior to Recoil's atomFamily/selectorFamily,
specify a deepEqual function to areEqual. For example:
import deepEqual from 'fast-deep-equal'
const fooFamily = atomFamily((param) => param, null, deepEqual)import { atomFamily } from 'jotai/utils'
const todoFamily = atomFamily((name) => name)
todoFamily('foo')
// this will create a new atom('foo'), or return the one if already createdimport { atomFamily } from 'jotai/utils'
const todoFamily = atomFamily(
(name) => (get) => get(todosAtom)[name],
(name) => (get, set, arg) => {
const prev = get(todosAtom)
return { ...prev, [name]: { ...prev[name], ...arg } }
}
)import { atomFamily } from 'jotai/utils'
const todoFamily = atomFamily(
({ id, name }) => ({ name }),
null,
(a, b) => a.id === b.id
)https://codesandbox.io/s/react-typescript-forked-8zfrn
Ref: pmndrs#36
useSelector(anAtom, selector, equalityFn)Selector and equalityFn must be stable (should be wrapped with useCallback). The equalityFn is optional.
import { Provider } from 'jotai'
import { useSelector, atomWithReducer, useUpdateAtom } from 'jotai/utils'
const initialState = {
count: 0,
text: 'hello',
}
const reducer = (state, action) => {
if (action.type === 'INC') {
return { ...state, count: state.count + 1 }
} else if (action.type === 'SET_TEXT') {
return { ...state, text: action.text }
} else {
throw Error('no such action')
}
}
const stateAtom = atomWithReducer(initialState, reducer)
const selectCount = (state: State) => state.count
const Counter = () => {
const dispatch = useUpdateAtom(stateAtom)
const count = useSelector(stateAtom, selectCount)
return (
<div>
{count} <button onClick={() => dispatch({ type: 'INC' })}>+1</button>
</div>
)
}
const selectText = (state: State) => state.text
const TextBox = () => {
const dispatch = useUpdateAtom(stateAtom)
const text = useSelector(stateAtom, selectText)
return (
<div>
{text}{' '}
<input
value={text}
onChange={(e) => dispatch({ type: 'SET_TEXT', text: e.target.value })}
/>
</div>
)
}https://codesandbox.io/s/react-typescript-forked-i4880
Ref: pmndrs#60
useAtomCallback(
callback: (get: Getter, set: Setter, arg: Arg) => Result
): (arg: Arg) => Promise<Result>This hook allows to interact with atoms imperatively. It takes a callback function that works like atom write function, and returns a function that returns a promise.
The callback to pass in the hook must be stable (should be wrapped with useCallback).
import { useEffect, useState, useCallback } from 'react'
import { Provider, atom, useAtom } from 'jotai'
import { useAtomCallback } from 'jotai/utils'
const countAtom = atom(0)
const Counter = () => {
const [count, setCount] = useAtom(countAtom)
return (
<>
{count} <button onClick={() => setCount((c) => c + 1)}>+1</button>
</>
)
}
const Monitor = () => {
const [count, setCount] = useState(0)
const readCount = useAtomCallback(
useCallback((get) => {
const currCount = get(countAtom)
setCount(currCount)
return currCount
}, [])
)
useEffect(() => {
const timer = setInterval(async () => {
console.log(await readCount())
}, 1000)
return () => {
clearInterval(timer)
}
}, [readCount])
return <div>current count: {count}</div>
}