mirror of
https://github.com/reduxjs/redux-devtools.git
synced 2024-11-22 17:46:56 +03:00
e18b2757f4
* chore(*): remove Travis config * chore(*): fix CI badges * chore(*): fix package source links * chore(*): remove CI badges from packages
64 lines
3.9 KiB
Markdown
64 lines
3.9 KiB
Markdown
# Redux DevTools Dock Monitor
|
|
|
|
A resizable and movable dock for [Redux DevTools](https://github.com/reduxjs/redux-devtools).
|
|
Powered by [React Dock](https://github.com/reduxjs/redux-devtools/tree/main/packages/react-dock).
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
```
|
|
yarn add @redux-devtools/dock-monitor
|
|
```
|
|
|
|
### Usage
|
|
|
|
Wrap any other Redux DevTools monitor in `DockMonitor` to make it dockable to different screen edges.
|
|
For example, you can use it together with [`LogMonitor`](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools-log-monitor):
|
|
|
|
##### `containers/DevTools.js`
|
|
|
|
```js
|
|
import React from 'react';
|
|
import { createDevTools } from '@redux-devtools/core';
|
|
import LogMonitor from '@redux-devtools/log-monitor';
|
|
import SliderMonitor from '@redux-devtools/slider-monitor';
|
|
import DockMonitor from '@redux-devtools/dock-monitor';
|
|
|
|
export default createDevTools(
|
|
<DockMonitor
|
|
toggleVisibilityKey="ctrl-h"
|
|
changePositionKey="ctrl-q"
|
|
changeMonitorKey="ctrl-m"
|
|
>
|
|
<LogMonitor />
|
|
<SliderMonitor />
|
|
</DockMonitor>
|
|
);
|
|
```
|
|
|
|
[Read how to start using Redux DevTools.](https://github.com/reduxjs/redux-devtools)
|
|
|
|
#### Multiple Monitors
|
|
|
|
You can put more than one monitor inside `<DockMonitor>`. There will still be a single dock, but you will be able to switch between different monitors by pressing a key specified as `changeMonitorKey` prop.
|
|
|
|
### Props
|
|
|
|
| Name | Description |
|
|
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `children` | Any valid Redux DevTools monitor. Required. |
|
|
| `toggleVisibilityKey` | A key or a key combination that toggles the dock visibility. Must be recognizable by [parse-key](https://github.com/thlorenz/parse-key) (for example, `'ctrl-h'`). Required. |
|
|
| `changePositionKey` | A key or a key combination that toggles the dock position. Must be recognizable by [parse-key](https://github.com/thlorenz/parse-key) (for example, `'ctrl-w'`). Required. |
|
|
| `changeMonitorKey` | A key or a key combination that switches the currently visible monitor. Must be recognizable by [parse-key](https://github.com/thlorenz/parse-key) (for example, `'ctrl-m'`). Required if you use more than one monitor. |
|
|
| `fluid` | When `true`, the dock size is a fraction of the window size, fixed otherwise. Optional. By default set to `true`. |
|
|
| `defaultSize` | Size of the dock. When `fluid` is `true`, a float (`0.5` means half the window size). When `fluid` is `false`, a width in pixels. Optional. By default set to `0.3` (3/10th of the window size). |
|
|
| `defaultPosition` | Where the dock appears on the screen. Valid values: `'left'`, `'top'`, `'right'`, `'bottom'`. Optional. By default set to `'right'`. |
|
|
| `defaultIsVisible` | Defines whether dock should be open by default. A value of `true` means that it's open when the page/app loads. |
|
|
|
|
The current size and the position are persisted between sessions with `persistState()` enhancer from Redux DevTools.
|
|
|
|
### License
|
|
|
|
MIT
|