UNPKG

2.26 kBMarkdownView Raw
1<img src='https://cloud.githubusercontent.com/assets/29597/12027069/779d8f3c-ad8f-11e5-8bac-2f6e8eed7192.png' width='250' height='123' alt='redux devtools filterable log monitor logo'/>
2=========================
3
4Filterable tree view monitor for [Redux DevTools](https://github.com/gaearon/redux-devtools).
5Check out a [simple demo application here](https://bvaughn.github.io/redux-devtools-filterable-log-monitor).
6
7<img width='624' height='448' alt='Demo GIF' src='https://cloud.githubusercontent.com/assets/29597/12024861/a510cb96-ad76-11e5-9ce3-78f46a2f6837.gif'/>
8
9Installation
10------------
11
12```
13npm install --save-dev redux-devtools-filterable-log-monitor
14```
15
16Usage
17------------
18
19The `FilterableLogMonitor` is intended for use within the [`DockMonitor`](https://github.com/gaearon/redux-devtools-dock-monitor). You can configure your app to use these monitors like so:
20
21```js
22import React from 'react'
23import { createDevTools } from 'redux-devtools'
24import DockMonitor from 'redux-devtools-dock-monitor'
25import FilterableLogMonitor from '../src'
26
27const DevTools = createDevTools(
28 <DockMonitor toggleVisibilityKey='ctrl-h'
29 changePositionKey='ctrl-q'>
30 <FilterableLogMonitor/>
31 </DockMonitor>
32)
33
34export default DevTools
35
36```
37
38Then you can render `<DevTools>` to any place inside app or even into a separate popup window.
39
40[Read how to start using Redux DevTools.](https://github.com/gaearon/redux-devtools)
41
42Features
43------------
44
45Every action is displayed in the log. Use the filter input to quickly and easily locate nodes in your store that are deeply nested. You can search using regular expressions or simple strings. Select whether the search should match keys, values, or either using the checkboxes above the filter input.
46
47Contributions
48------------
49
50Use [GitHub issues](https://github.com/bvaughn/redux-devtools-filterable-log-monitor/issues) for requests.
51
52I actively welcome pull requests; learn how to [contribute](https://github.com/bvaughn/react-virtualized/blob/master/CONTRIBUTING.md).
53
54Changelog
55---------
56
57Changes are tracked in the [changelog](https://github.com/bvaughn/redux-devtools-filterable-log-monitor/blob/master/CHANGELOG.md).
58
59License
60---------
61
62*react-virtualized* is available under the MIT License.