- Debug 🐞 atom values with ease
- Out-of-the-box 🔌 support for async/suspendible atoms
- Built-in Dark mode 🌗
- ✅ Supports custom
store
- ✅ Works with provider-less mode
- ✅ Works with Next.js
- ✅ Supports custom
nonce
for CSP - ✅ Hides private atoms with ability to configure (requires Jotai
>=2.0.3
) - ✅ Tree-shakable and built for non-production environments
- Jotai version
>=1.11.0
(highly recommended to use2.x.x
) - React version
>=17.0.0
# yarn
yarn add jotai-devtools
# npm
npm install jotai-devtools --save
Enhance your development experience with the UI based Jotai DevTool
Use Jotai babel plugins for optimal debugging experience. Find the complete guide on jotai.org
Eg.
{
"plugins": [
// Enables hot reload for atoms
"jotai/babel/plugin-react-refresh",
// Automatically adds debug labels to the atoms
"jotai/babel/plugin-debug-label"
]
}
You may skip this section if you're not using Next.js.
Enable transpilePackages
for the UI CSS and components to be transpiled
correctly.
// next.config.ts
const nextConfig = {
// Learn more here - https://nextjs.org/docs/advanced-features/compiler#module-transpilation
// Required for font css to be imported correctly 👇
transpilePackages: ['jotai-devtools'],
};
module.exports = nextConfig;
type DevToolsProps = {
// Defaults to false
isInitialOpen?: boolean;
// pass a custom store
store?: Store;
// Defaults to light
theme?: 'dark' | 'light';
// Custom nonce to allowlist jotai-devtools specific inline styles via CSP
nonce?: string;
options?: {
// Private atoms are used internally in atoms like `atomWithStorage` or `atomWithLocation`, etc. to manage state.
// Defaults to `false`
shouldShowPrivateAtoms?: boolean;
};
};
import { DevTools } from 'jotai-devtools';
const App = () => {
return (
<>
<DevTools />
{/* your app */}
</>
);
};
import { createStore } from 'jotai';
import { DevTools } from 'jotai-devtools';
const customStore = createStore();
const App = () => {
return (
<Provider store={customStore}>
<DevTools store={customStore} />
{/* your app */}
</Provider>
);
};
Detailed documentation is available on https://jotai.org/docs/api/devtools
import {
useAtomsSnapshot,
useGotoAtomsSnapshot,
useAtomsDebugValue,
// Redux devtool hooks
useAtomDevtools,
useAtomsDevtools,
} from 'jotai-devtools';
Find the official migration guide on jotai.org
-
Install this package
# npm npm install jotai-devtools --save # yarn yarn add jotai-devtools
-
Update imports from
jotai/react/devtools
tojotai-devtools
import { useAtomsSnapshot, useGotoAtomsSnapshot, useAtomsDebugValue, // Redux devtool integration hooks useAtomDevtools, useAtomsDevtools, - } from 'jotai/react/devtools'; + } from 'jotai-devtools';