diff --git a/packages/d3-state-visualizer/README.md b/packages/d3-state-visualizer/README.md index 18793765..bb7cc2ca 100644 --- a/packages/d3-state-visualizer/README.md +++ b/packages/d3-state-visualizer/README.md @@ -59,7 +59,7 @@ This chart is a bit special as it accepts either one of the two following option Other options are listed below and have reasonable default values if you want to omit them: | Option | Type | Default | Description | -|---------------------------| ------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ------------------------- | ------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | String | `'d3svg'` | Sets the identifier of the SVG element —i.e your chart— that will be added to the DOM element you passed as first argument | | `chartStyles` | Object | `{}` | Sets the CSS style of the chart | | `size` | Number | `500` | Sets size of the chart in pixels | diff --git a/packages/redux-devtools-chart-monitor/README.md b/packages/redux-devtools-chart-monitor/README.md index 6c6006db..37ff6bff 100644 --- a/packages/redux-devtools-chart-monitor/README.md +++ b/packages/redux-devtools-chart-monitor/README.md @@ -47,16 +47,18 @@ Consult the [`DockMonitor` README](https://github.com/reduxjs/redux-devtools/tre You can read the React component [propTypes](https://github.com/reduxjs/redux-devtools/blob/master/packages/redux-devtools-chart-monitor/src/Chart.js#L11) 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`. | -| `style` | {
  width: '100%', height: '100%', // i.e fullscreen for [`DockMonitor`](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools-dock-monitor)
  text: {
    colors: {
      'default': `theme.base0D`,
      hover: `theme.base06`
    }
  },
  node: {
    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,
  style: {
    'background-color': `theme.base06`,
    'opacity': '0.7',
    'border-radius': '5px',
    'padding': '5px'
  }
}
[More info](https://github.com/reduxjs/redux-devtools/tree/master/packages/d3tooltip#api). | +| 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`](https://github.com/reduxjs/redux-devtools/tree/master/packages/redux-devtools-dock-monitor)
} | +| `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](https://github.com/reduxjs/redux-devtools/tree/master/packages/d3tooltip#api). | #### Redux DevTools props