mirror of https://github.com/reduxjs/redux-devtools.git synced 2024-11-25 11:03:57 +03:00

History

Nathan Bierema 7f5bddbdc2 Widen peer dependencies (#1553 ) * Widen peer dependencies * Create lucky-lobsters-tickle.md * Update pnpm-lock.yaml		2023-12-09 04:14:28 +00:00
..
src	Replace Action<unknown> with Action<string> (#1525 )	2023-11-04 21:04:23 +00:00
.eslintignore	Imprrove ability to tree-shake libraries (#1050 )	2022-01-24 02:11:46 +00:00
.eslintrc.js	chore(deps): update typescript-eslint monorepo to v6 (major) (#1436 )	2023-09-03 22:56:58 -04:00
babel.config.esm.json	Imprrove ability to tree-shake libraries (#1050 )	2022-01-24 02:11:46 +00:00
babel.config.json	Imprrove ability to tree-shake libraries (#1050 )	2022-01-24 02:11:46 +00:00
CHANGELOG.md	Version Packages (#1527 )	2023-11-04 21:26:10 +00:00
LICENSE.md	chore(*): add back license files (#578 )	2020-08-09 01:11:43 -04:00
package.json	Widen peer dependencies (#1553 )	2023-12-09 04:14:28 +00:00
README.md	Upgrade D3 to v4 (#1307 )	2023-01-02 14:19:13 -05:00
tsconfig.json	Imprrove ability to tree-shake libraries (#1050 )	2022-01-24 02:11:46 +00:00

README.md

Redux DevTools Chart Monitor

A chart monitor for Redux DevTools.

Created by @romseguy and merged from reduxjs/redux-devtools-chart-monitor.

It shows a real-time view of the store aka the current state of the app.

🚀 Now with immutable-js support.

Demo (Source)

Installation

yarn add @redux-devtools/chart-monitor

Usage

You can use ChartMonitor as the only monitor in your app:

`containers/DevTools.js`

import React from 'react';
import { createDevTools } from '@redux-devtools/core';
import { ChartMonitor } from '@redux-devtools/chart-monitor';

export default createDevTools(<ChartMonitor />);

Then you can render <DevTools> to any place inside app or even into a separate popup window.

Alternatively, you can use it together with DockMonitor to make it dockable.
Consult the DockMonitor README for details of this approach.

Read how to start using Redux DevTools.

Features

Props

ChartMonitor props

You can read the React component propTypes in addition to the details below:

Name	Description
`defaultIsVisible`	By default, set to `true`.
`transitionDuration`	By default, set to `750`, in milliseconds.
`heightBetweenNodesCoeff`	By default, set to `1`.
`widthBetweenNodesCoeff`	By default, set to `1.3`.
`isSorted`	By default, set to `false`.
`chartStyles`	{ width: '100%', height: '100%', // i.e fullscreen for `DockMonitor` }
`textStyleOptions`	{ colors: { default: `theme.base0D`, hover: `theme.base06`, }, }
`nodeStyleOptions`	{ colors: { default: `theme.base0B`, collapsed: `theme.base0B`, parent: `theme.base0E`, }, radius: 7, }
`onClickText`	Function called with a reference to the clicked node as first argument when clicking on the text next to a node.
`tooltipOptions`	{ disabled: false, indentationSize: 2, styles: { 'background-color': `theme.base06`, 'opacity': '0.7', 'border-radius': '5px', 'padding': '5px', }, } More info.

Redux DevTools props

Name	Description
`theme`	Either a string referring to one of the themes provided by redux-devtools-themes (feel free to contribute!) or a custom object of the same format. Optional. By default, set to `'nicinabox'`.
`invertTheme`	Boolean value that will invert the colors of the selected theme. Optional. By default, set to `false`
`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`.

License

MIT