Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
arjunvegda committed Jun 13, 2023
1 parent 04187a2 commit 9f1c6ae
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@

[![Build Status](https://img.shields.io/github/actions/workflow/status/jotaijs/jotai-devtools/ci.yml?style=flat&colorA=000000&colorB=259e02)](https://github.com/jotaijs/jotai-devtools/actions/workflows/ci.yml)
[![Version](https://img.shields.io/npm/v/jotai-devtools?style=flat&colorA=000000&colorB=259e02)](https://www.npmjs.com/package/jotai-devtools)
[![Version](https://img.shields.io/npm/dw/jotai-devtools?style=flat&colorA=000000&colorB=259e02)](https://www.npmjs.com/package/jotai-devtools)

## 🚀 Features

- Debug 🐞 atom values with ease
- ⏳ Time-travel through your atoms and find bugs faster than before
(recommended jotai `>=2.2.0`)
- Out-of-the-box 🔌 support for async/suspendible atoms
- Built-in Dark mode 🌗
- ✅ Supports custom `store`
Expand All @@ -15,6 +18,7 @@
- ✅ Hides private atoms with ability to configure (requires Jotai `>=2.0.3`)
- ✅ Tree-shakable and built for non-production environments
- ✅ Parses all the JavaScript values with JSON Tree view
- ✅ Diff checking with additions and deletion highlights

## 📺 Preview

Expand All @@ -31,6 +35,8 @@

## 📦 Setup

_(See complete setup guide for UI-based devtools below)_

```sh
# yarn
yarn add jotai-devtools @emotion/react
Expand Down Expand Up @@ -102,9 +108,12 @@ type DevToolsProps = {
// Expands the JSON tree view on initial render on Atom Viewer tab, Timeline tab, etc.
// Defaults to `false`
shouldExpandJsonTreeViewInitially?: boolean;
// The interval (in milliseconds) between each step of the time travel playback.
// Defaults to `750ms`
timeTravelPlaybackInterval?: number;
// The maximum number of snapshots to keep in the history.
// The higher the number the more memory it will consume.
// Defaults to Infinity. Recommended: ~30
// Defaults to `Infinity`. Recommended: `~30`
snapshotHistoryLimit?: number;
};
};
Expand Down
Binary file modified docs/internal/demo-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions src/DevTools/atoms/devtools-options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ export type DevToolsOptions = {
/**
* Defaults to 750ms
*
* Disables the snapshot recording on mount.
* This is useful when you want to record snapshots manually.
* The interval (in milliseconds) between each step of the time travel playback.
*/
timeTravelPlaybackInterval?: number;
/**
Expand Down

0 comments on commit 9f1c6ae

Please sign in to comment.