victory-voronoi-container 30.6.1 → 31.2.0

package/README.md

@@ -41,7 +41,7 @@ However, the component that uses it must be standalone
 
 When the `activateData` prop is set to true, the `active` prop will be set to true on all data components within a voronoi area. When this prop is set to false, the `onActivated` and `onDeactivated` callbacks will still fire, but no mutations to data components will occur via Victory's event system.
 
-*default:* `activateData={true}`
+_default:_ `activateData={true}`
 
 ### activateLabels
 
@@ -49,7 +49,7 @@ When the `activateData` prop is set to true, the `active` prop will be set to tr
 
 When the `activateLabels` prop is set to true, the `active` prop will be set to true on all labels corresponding to points within a voronoi area. When this prop is set to false, the `onActivated` and `onDeactivated` callbacks will still fire, but no mutations to label components will occur via Victory's event system. Labels defined directly on `VictoryVoronoiContainer` via the `labels` prop will still appear when this prop is set to false.
 
-*default:* `activateLabels={true}`
+_default:_ `activateLabels={true}`
 
 ### disable
 
@@ -63,9 +63,9 @@ When the `disable` prop is set to `true`, `VictoryVoronoiContainer` events will
 
 When a `labels` prop is provided to `VictoryVoronoiContainer` it will render a label component
 rather than activating labels on the child components it renders. This is useful for creating multi-
-point tooltips. This prop should be given as a function which will be called once for each active point.  The `labels` function will be called with the arguments `point`, `index`, and `points`, where `point` refers to a single active point, `index` refers to the position of that point in the array of active points, and `points` is an array of all active points.
+point tooltips. This prop should be given as a function which will be called once for each active point. The `labels` function will be called with the arguments `point`, `index`, and `points`, where `point` refers to a single active point, `index` refers to the position of that point in the array of active points, and `points` is an array of all active points.
 
-*example:* `labels={(point) => "y: " + point.y}`
+_example:_ `labels={(point) => "y: " + point.y}`
 
 ### labelComponent
 
@@ -74,7 +74,7 @@ point tooltips. This prop should be given as a function which will be called onc
 The `labelComponent` prop specified the component that will be rendered when `labels` are defined
 on `VictoryVoronoiContainer`. If the `labels` prop is omitted, no label component will be rendered.
 
-*default:* `labelComponent={<VictoryTooltip/>}`
+_default:_ `labelComponent={<VictoryTooltip/>}`
 
 ### onActivated
 
@@ -83,7 +83,7 @@ on `VictoryVoronoiContainer`. If the `labels` prop is omitted, no label componen
 The `onActivated` prop accepts a function to be called whenever new data points are activated.
 The function is called with the parameters `points` (an array of active data objects) and `props` (the props used by `VictoryVoronoiContainer`).
 
-*example:* `onActivated={(points, props) => filterList(points, props)}`
+_example:_ `onActivated={(points, props) => filterList(points, props)}`
 
 ### onDeactivated
 
@@ -92,7 +92,7 @@ The function is called with the parameters `points` (an array of active data obj
 The `onDeactivated` prop accepts a function to be called whenever points are deactivated.
 The function is called with the parameters `points` (an array of the newly-deactivated data objects) and `props` (the props used by `VictoryVoronoiContainer`).
 
-*example:* `onDeactivated={(points, props) => removeFromList(points, props)}`
+_example:_ `onDeactivated={(points, props) => removeFromList(points, props)}`
 
 ### radius
 
@@ -101,7 +101,7 @@ The function is called with the parameters `points` (an array of the newly-deact
 When the `radius` prop is set, the voronoi areas associated with each data point will be no larger
 than the given radius. This prop should be given as a number.
 
-*example:* `radius={25}`
+_example:_ `radius={25}`
 
 ### voronoiBlacklist
 
@@ -109,8 +109,7 @@ than the given radius. This prop should be given as a number.
 
 The `voronoiBlacklist` prop is used to specify a list of components to ignore when calculating a shared voronoi diagram. Components with a `name` prop matching an element in the `voronoiBlacklist` array will be ignored by `VictoryVoronoiContainer`. Ignored components will never be flagged as active, and will not contribute date to shared tooltips or labels.
 
-*example:* `voronoiBlacklist={["redPoints"]}`
-
+_example:_ `voronoiBlacklist={["redPoints"]}`
 
 ```playground
 <VictoryChart domain={{ y: [0, 6] }}
@@ -144,7 +143,7 @@ For example, when `dimension` is set to "x", all data points matching a particul
 will be activated regardless of y value. When this prop is not given, voronoi selection is
 determined by both x any y values.
 
-*example:* `voronoiDimension="x"`
+_example:_ `voronoiDimension="x"`
 
 ```playground
 <VictoryChart domain={{ y: [0, 6] }}
@@ -177,8 +176,8 @@ When the `voronoiPadding` prop is given, the area of the chart that will trigger
 reduced by the given padding on every side. By default, no padding is applied, and the entire range
 of a given chart may trigger voronoi events. This prop should be given as a number.
 
-*example:* `voronoiPadding={5}`
+_example:_ `voronoiPadding={5}`
 
-[VictoryContainer]: https://formidable.com/open-source/victory/docs/victory-container
+[victorycontainer]: https://formidable.com/open-source/victory/docs/victory-container
 [voronoi diagram]: https://github.com/d3/d3-voronoi
 [this example]: https://formidable.com/open-source/victory/gallery/voronoi-tooltips-grouped