Skip to main content
Module

x/jotai/docs/integrations/valtio.mdx

👻 Primitive and flexible state management for React
Go to Latest
File
---title: Valtiodescription: This doc describes `jotai/valtio` bundle.nav: 4.05---
Jotai's state resides in React, but sometimes it would be niceto interact with the world outside React.
Valtio provides a proxy interface that can be used to store some valuesand sync with atoms in Jotai.
This only uses the vanilla api of valtio.
## Install
You have to install `valtio` to access this bundle and its functions.
```npm install valtio# oryarn add valtio```
## atomWithProxy
`atomWithProxy` creates a new atom with valtio proxy.It's two-way binding and you can change the value from both ends.
```jsimport { useAtom } from 'jotai'import { atomWithProxy } from 'jotai/valtio'import { proxy } from 'valtio/vanilla'
const proxyState = proxy({ count: 0 })const stateAtom = atomWithProxy(proxyState)const Counter: React.FC = () => { const [state, setState] = useAtom(stateAtom) return ( <> count: {state.count} <button onClick={() => setState((prev) => ({ ...prev, count: prev.count + 1 }))}> button </button> </> )}```
### Parameters
```atomWithProxy(proxyObject, options?)```
**proxyObject** (required): the Valtio proxy object you want to derive the atom from
**options.sync** (optional): makes the atom update synchronously instead of waiting for batched updates, similar to [`valtio/useSnapshot`](https://github.com/pmndrs/valtio#update-synchronously). This will result in more renders, but have more guarantees that it syncs with other Jotai atoms.
```atomWithProxy(proxyObject, { sync: true })```
### Examples
<CodeSandbox id="f5u4l" />