mirror of
https://github.com/reduxjs/redux-devtools.git
synced 2025-03-03 02:35:49 +03:00
Update README.md
This commit is contained in:
parent
15edc609f3
commit
f61d86a81d
41
README.md
41
README.md
|
@ -1,9 +1,19 @@
|
|||
Redux DevTools
|
||||
=========================
|
||||
|
||||
A better README is coming. But if you insist...
|
||||
A live-editing time travel environment for Redux.
|
||||
**[See Dan's React Europe talk demoing it!](http://youtube.com/watch?v=xsSnOQynTHs)**
|
||||
|
||||
<img src='http://i.imgur.com/HMW2pjP.png' width='700'>
|
||||

|
||||
|
||||
### 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-evaluted
|
||||
* 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
|
||||
* To monitor a part of the state, you can set a `select` prop on the DevTools component: `<DevTools select={state => state.todos} store={store} monitor={LogMonitor} />`
|
||||
|
||||
### Installation
|
||||
|
||||
|
@ -35,17 +45,11 @@ For fun, you can also open `http://localhost:3000/?debug_session=123`, click aro
|
|||
|
||||
Oh, and you can do the same with the TodoMVC example as well.
|
||||
|
||||
If you only would like to monitor a part of the state, you can set a select-prop on the DevTools component.
|
||||
ex. `<DevTools select={state => state.todos} store={store} monitor={LogMonitor} />`
|
||||
|
||||
|
||||
### It's Ugly!
|
||||
|
||||
The design or usability is not the point. (Although we'll have better design in the future :-)
|
||||
### Custom Monitors
|
||||
|
||||
**You can build a completely custom UI for it** because `<DevTools>` accepts a `monitor` React component prop. The included `LogMonitor` is just an example.
|
||||
|
||||
**[In fact I challenge you to build a custom monitor for Redux DevTools!](https://github.com/gaearon/redux-devtools/issues/3)**
|
||||
**[I challenge you to build a custom monitor for Redux DevTools!](https://github.com/gaearon/redux-devtools/issues/3)**
|
||||
|
||||
Some crazy ideas for custom monitors:
|
||||
|
||||
|
@ -54,6 +58,23 @@ Some crazy ideas for custom monitors:
|
|||
* 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` propTypes to see what you can do.
|
||||
|
||||
In fact some of these are implemented already:
|
||||
|
||||
#### [redux-devtools-diff-monitor](https://github.com/whetstone/redux-devtools-diff-monitor)
|
||||
|
||||

|
||||
|
||||
#### [redux-slider-monitor](https://github.com/calesce/redux-slider-monitor)
|
||||
|
||||

|
||||
|
||||
#### [redux-devtools-gentest-plugin](https://github.com/lapanoid/redux-devtools-gentest-plugin)
|
||||
|
||||

|
||||
|
||||
#### Keep them coming!
|
||||
|
||||
Create a PR to add your custom monitor.
|
||||
|
||||
### License
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user