mirror of
https://github.com/reduxjs/redux-devtools.git
synced 2025-10-31 07:57:39 +03:00
e18b2757f4
* chore(*): remove Travis config * chore(*): fix CI badges * chore(*): fix package source links * chore(*): remove CI badges from packages
134 lines
6.7 KiB
Markdown
134 lines
6.7 KiB
Markdown
# Redux DevTools
|
||
|
||
A live-editing time travel environment for [Redux](https://github.com/reactjs/redux).
|
||
**[See Dan's React Europe talk demoing it!](http://youtube.com/watch?v=xsSnOQynTHs)**
|
||
|
||
> Note that the implemention in this repository is different from [Redux DevTools Extension](https://github.com/zalmoxisus/redux-devtools-extension). Please refer to the latter for browser extension.
|
||
|
||
### Table of Contents
|
||
|
||
- [Features](#features)
|
||
- [Overview](#overview)
|
||
- [Browser Extension](#browser-extension)
|
||
- [Setup Instructions](#setup-instructions)
|
||
- [Custom Monitors](#custom-monitors)
|
||
- [License](#license)
|
||
|
||
[](https://www.npmjs.com/package/redux-devtools)
|
||
[](https://www.npmjs.com/package/redux-devtools)
|
||
[](https://discord.gg/0ZcbPKXt5bWb10Ma)
|
||
|
||
|
||
|
||
### Features
|
||
|
||
- Lets you inspect every state and action payload
|
||
- Lets you go back in time by “cancelling” actions
|
||
- If you change the reducer code, each “staged” action will be re-evaluated
|
||
- If the reducers throw, you will see during which action this happened, and what the error was
|
||
- With `persistState()` store enhancer, you can persist debug sessions across page reloads
|
||
|
||
### Overview
|
||
|
||
Redux DevTools is a development time package that provides power-ups for your Redux development workflow. Be careful to strip its code in production (see [walkthrough](../../docs/Walkthrough.md) for instructions)! To use Redux DevTools, you need to choose a “monitor”—a React component that will serve as a UI for the DevTools. Different tasks and workflows require different UIs, so Redux DevTools is built to be flexible in this regard. We recommend using [`LogMonitor`](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools-log-monitor) for inspecting the state and time travel, and wrap it in a [`DockMonitor`](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools-dock-monitor) to quickly move it across the screen. That said, when you’re comfortable rolling up your own setup, feel free to do this, and share it with us.
|
||
|
||
If you came here looking for what do the “Reset”, “Revert”, “Sweep” or “Commit” buttons do, check out [the `LogMonitor` documentation](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools-log-monitor#features).
|
||
|
||
### Browser Extension
|
||
|
||
If you don’t want to bother with installing Redux DevTools and integrating it into your project, consider using [Redux DevTools Extension](https://github.com/zalmoxisus/redux-devtools-extension) for Chrome and Firefox. It provides access to the most popular monitors, is easy to configure to filter actions, and doesn’t require installing any packages.
|
||
|
||
### Setup Instructions
|
||
|
||
Read the installation [walkthrough](../../docs/Walkthrough.md) for integration instructions and usage examples (`<DevTools>` component, `DevTools.instrument()`, exclude from production builds, gotchas).
|
||
|
||
### Running Examples
|
||
|
||
Clone the project:
|
||
|
||
```
|
||
git clone https://github.com/reduxjs/redux-devtools.git
|
||
cd redux-devtools/packages/redux-devtools
|
||
```
|
||
|
||
Run `npm install` in the package folder:
|
||
|
||
```
|
||
npm install
|
||
```
|
||
|
||
Now you can open an example folder and run `npm install` there:
|
||
|
||
```
|
||
cd examples/counter # or examples/todomvc
|
||
npm install
|
||
```
|
||
|
||
Finally, run the development server and open the page:
|
||
|
||
```
|
||
npm start
|
||
open http://localhost:3000
|
||
```
|
||
|
||
Try clicking on actions in the log, or changing some code inside the reducers. You should see the action log re-evaluate the state on every code change.
|
||
|
||
Also try opening `http://localhost:3000/?debug_session=123`, click around, and then refresh. You should see that all actions have been restored from the local storage.
|
||
|
||
### Custom Monitors
|
||
|
||
**DevTools accepts monitor components so you can build a completely custom UI.** [`LogMonitor`](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools-log-monitor) and [`DockMonitor`](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools-dock-monitor) are just examples of what is possible.
|
||
|
||
**[I challenge you to build a custom monitor for Redux DevTools!](https://github.com/reduxjs/redux-devtools/issues/3)**
|
||
|
||
Some crazy ideas for custom monitors:
|
||
|
||
- A slider that lets you jump between computed states just by dragging it
|
||
- An in-app layer that shows the last N states right in the app (e.g. for animation)
|
||
- A time machine like interface where the last N states of your app reside on different Z layers
|
||
- Feel free to come up with and implement your own! Check [`LogMonitor`](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools-log-monitor) `propTypes` to see what you can do.
|
||
|
||
In fact some of these are implemented already:
|
||
|
||
#### [Slider Monitor](https://github.com/reduxjs/redux-devtools/packages/redux-devtools-slider-monitor)
|
||
|
||
|
||
|
||
#### [Inspector Monitor](https://github.com/reduxjs/redux-devtools/packages/redux-devtools-inspector-monitor)
|
||
|
||
|
||
|
||
#### [Diff Monitor](https://github.com/whetstone/redux-devtools-diff-monitor)
|
||
|
||
|
||
|
||
#### [Filterable Log Monitor](https://github.com/bvaughn/redux-devtools-filterable-log-monitor/)
|
||
|
||
|
||
|
||
#### [Chart Monitor](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools-chart-monitor)
|
||
|
||
|
||
|
||
#### [Filter Actions](https://github.com/zalmoxisus/redux-devtools-filter-actions)
|
||
|
||
(Does not have a UI but can wrap any other monitor)
|
||
|
||
<img src='http://i.imgur.com/TlqnU0J.png' width='400'>
|
||
|
||
#### [Dispatch](https://github.com/YoruNoHikage/redux-devtools-dispatch)
|
||
|
||
|
||
|
||
#### [Redux Usage Report](https://github.com/aholachek/redux-usage-report)
|
||
|
||
|
||
|
||
#### Keep them coming!
|
||
|
||
Create a PR to add your custom monitor.
|
||
|
||
### License
|
||
|
||
MIT
|