Skip to content

Commit e203319

Browse files
committed
Update README
1 parent babb278 commit e203319

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
1-
Redux DevTools Log Monitor
2-
=========================
1+
Redux DevTools Log Monitor Filterable
2+
=====================================
33

4-
The default monitor for [Redux DevTools](https://github.com/gaearon/redux-devtools) with a tree view.
5-
It shows a log of states and actions, and lets you change their history.
6-
7-
![](http://i.imgur.com/J4GeW0M.gif)
4+
Fork of [Redux DevTools Log Monitor](https://github.com/gaearon/redux-devtools-log-monitor) with the ability to specify actions to be hidden or shown in DevTools.
85

96
### Installation
107

118
```
12-
npm install --save-dev redux-devtools-log-monitor
9+
npm install --save-dev redux-devtools-log-monitor-filterable
1310
```
1411

1512
### Usage
@@ -24,7 +21,7 @@ import { createDevTools } from 'redux-devtools';
2421
import LogMonitor from 'redux-devtools-log-monitor';
2522

2623
export default createDevTools(
27-
<LogMonitor />
24+
<LogMonitor filter={{ blacklist: ['ACTION1', 'ACTION2'], whitelist: ['ACTION1', 'ACTION2'] }} />
2825
);
2926
```
3027

@@ -52,6 +49,7 @@ Name | Description
5249
`theme` | Either a string referring to one of the themes provided by [redux-devtools-themes](https://github.com/gaearon/redux-devtools-themes) (feel free to contribute!) or a custom object of the same format. Optional. By default, set to [`'nicinabox'`](https://github.com/gaearon/redux-devtools-themes/blob/master/src/nicinabox.js).
5350
`select` | A function that selects the slice of the state for DevTools to show. For example, `state => state.thePart.iCare.about`. Optional. By default, set to `state => state`.
5451
`preserveScrollTop` | When `true`, records the current scroll top every second so it can be restored on refresh. This only has effect when used together with `persistState()` enhancer from Redux DevTools. By default, set to `true`.
52+
`filter` | An object with `blacklist` or `whitelist` arrays, which specify either actions to be hidden or shown in DevTools. If the latter is specified, other than those actions will be hidden.
5553

5654
### License
5755

0 commit comments

Comments
 (0)