victory-area 30.6.1 → 31.2.0

package/README.md

@@ -1,4 +1,3 @@
-
 # VictoryArea
 
 `victory-area@^30.0.0` exports `VictoryArea` and `Area` components
@@ -87,13 +86,12 @@ See the [Data Accessors Guide][] for more detail on formatting and processing da
 
 See the [Custom Components Guide][] for more detail on creating your own `dataComponents`
 
-*default:* `<Area/>`
+_default:_ `<Area/>`
 
 ```jsx
 dataComponent={<Area events={{ onClick: handleClick }}/>}
 ```
 
-
 ### domain
 
 `type: array[low, high] || { x: [low, high], y: [low, high] }`
@@ -123,7 +121,7 @@ domainPadding={{x: [10, -10], y: 5}}
 **note:** `VictoryArea` only renders one element per dataset, so only one event key will be generated.
 
 ```jsx
-eventKey="x"
+eventKey = "x";
 ```
 
 ### events
@@ -179,7 +177,7 @@ See the [Events Guide][] for more information on defining events.
 
 **note:** `VictoryArea` uses [`VictoryClipContainer`][] as its default `groupComponent` `VictoryClipContainer` renders a `<g>` tag with a `clipPath` `def`. This allows continuous data components to transition smoothly when new data points enter and exit. **Supplying a custom `groupComponent` to `VictoryArea` may result in broken animations.**
 
-*default:* `<VictoryClipContainer/>`
+_default:_ `<VictoryClipContainer/>`
 
 ```playground
 <VictoryChart>
@@ -197,7 +195,7 @@ See the [Events Guide][] for more information on defining events.
 
 `VictoryArea` uses the standard `height` prop. [Read about it here](https://formidable.com/open-source/victory/docs/common-props#height)
 
-*default (provided by default theme):* `height={300}`
+_default (provided by default theme):_ `height={300}`
 
 ```jsx
 height={400}
@@ -215,7 +213,7 @@ Cartesian area charts may use the following interpolation options: "basis", "car
 
 [Explore all the interpolation options][].
 
-*default:* `"linear"`
+_default:_ `"linear"`
 
 ```playground
 <VictoryArea
@@ -230,7 +228,7 @@ Cartesian area charts may use the following interpolation options: "basis", "car
 
 `VictoryArea` uses the standard `labelComponent` prop. [Read about it in detail](https://formidable.com/open-source/victory/docs/common-props#labelcomponent)
 
-*default:* `<VictoryLabel renderInPortal/>`
+_default:_ `<VictoryLabel renderInPortal/>`
 
 ```playground
 <VictoryArea
@@ -246,7 +244,6 @@ Cartesian area charts may use the following interpolation options: "basis", "car
 
 `VictoryArea` uses the standard `maxDomain` prop. [Read about it in detail](https://formidable.com/open-source/victory/docs/common-props#maxDomain)
 
-
 ```playground
 <VictoryChart maxDomain={{ x: 3 }}>
   <VictoryArea data={sampleData}/>
@@ -259,7 +256,6 @@ Cartesian area charts may use the following interpolation options: "basis", "car
 
 `VictoryArea` uses the standard `minDomain` prop. [Read about it in detail](https://formidable.com/open-source/victory/docs/common-props#minDomain)
 
-
 ```playground
 <VictoryChart minDomain={{ x: 2 }}>
   <VictoryArea data={sampleData}/>
@@ -286,7 +282,7 @@ Cartesian area charts may use the following interpolation options: "basis", "car
 The `name` prop is used to reference a component instance when defining shared events.
 
 ```jsx
-name="series-1"
+name = "series-1";
 ```
 
 ### origin
@@ -303,7 +299,7 @@ name="series-1"
 
 `VictoryArea` uses the standard `padding` prop. [Read about it here](https://formidable.com/open-source/victory/docs/common-props#padding)
 
-*default (provided by default theme):* `padding={50}`
+_default (provided by default theme):_ `padding={50}`
 
 ```jsx
 padding={{ top: 20, bottom: 60 }}
@@ -347,7 +343,7 @@ padding={{ top: 20, bottom: 60 }}
 
 `VictoryArea` uses the standard `samples` prop. [Read about it here](https://formidable.com/open-source/victory/docs/common-props#samples)
 
-*default:* `samples={50}`
+_default:_ `samples={50}`
 
 ```jsx
 samples={100}
@@ -360,7 +356,7 @@ samples={100}
 `VictoryArea` uses the standard `scale` prop. [Read about it here](https://formidable.com/open-source/victory/docs/common-props#scale)
 Options for scale include "linear", "time", "log", "sqrt" and the `d3-scale` functions that correspond to these options.
 
-*default:* `scale="linear"`
+_default:_ `scale="linear"`
 
 ```jsx
 scale={{x: "linear", y: "log"}}
@@ -385,7 +381,7 @@ scale={{x: "linear", y: "log"}}
 See the [Data Accessors Guide][] for more detail on formatting and processing data.
 
 ```jsx
-sortKey="x"
+sortKey = "x";
 ```
 
 ### sortOrder
@@ -394,7 +390,7 @@ sortKey="x"
 
 The `sortOrder` prop specifies whether sorted data should be returned in ascending or descending order.
 
-*default:* `sortOrder="ascending"`
+_default:_ `sortOrder="ascending"`
 
 ### standalone
 
@@ -404,7 +400,7 @@ The `sortOrder` prop specifies whether sorted data should be returned in ascendi
 
 **note:** When `VictoryArea` is nested within a component like `VictoryChart`, this prop will be set to `false`
 
-*default:* `standalone={true}`
+_default:_ `standalone={true}`
 
 ```playground
 <svg width={300} height={300}>
@@ -423,7 +419,7 @@ The `sortOrder` prop specifies whether sorted data should be returned in ascendi
 
 `VictoryArea` uses the standard `style` prop. [Read about it here](https://formidable.com/open-source/victory/docs/common-props#style)
 
-*default (provided by default theme):* See [grayscale theme][] for more detail
+_default (provided by default theme):_ See [grayscale theme][] for more detail
 
 ```playground
   <VictoryArea
@@ -449,7 +445,7 @@ The `sortOrder` prop specifies whether sorted data should be returned in ascendi
 
 See the [Themes Guide][] for information about creating custom themes.
 
-*default:* `theme={VictoryTheme.grayscale}`
+_default:_ `theme={VictoryTheme.grayscale}`
 
 ```jsx
 theme={VictoryTheme.material}
@@ -461,7 +457,7 @@ theme={VictoryTheme.material}
 
 `VictoryArea` uses the standard `width` prop. [Read about it here](https://formidable.com/open-source/victory/docs/common-props#width)
 
-*default (provided by default theme):* `width={450}`
+_default (provided by default theme):_ `width={450}`
 
 ```jsx
 width={400}
@@ -476,7 +472,7 @@ width={400}
 See the [Data Accessors Guide][] for more detail on formatting and processing data.
 
 ```jsx
-x="employee.name"
+x = "employee.name";
 ```
 
 ### y
@@ -508,12 +504,12 @@ See the [Data Accessors Guide][] for more detail on formatting and processing da
 </VictoryChart>
 ```
 
-[Animations Guide]: https://formidable.com/open-source/victory/guides/animations
-[Data Accessors Guide]: https://formidable.com/open-source/victory/guides/data-accessors
-[Custom Components Guide]: https://formidable.com/open-source/victory/guides/custom-components
-[Events Guide]: https://formidable.com/open-source/victory/guides/events
-[Themes Guide]: https://formidable.com/open-source/victory/guides/themes
-[`VictoryChart`]: https://formidable.com/open-source/victory/docs/victory-chart
-[`VictoryClipContainer`]: https://formidable.com/open-source/victory/docs/victory-clip-container
+[animations guide]: https://formidable.com/open-source/victory/guides/animations
+[data accessors guide]: https://formidable.com/open-source/victory/guides/data-accessors
+[custom components guide]: https://formidable.com/open-source/victory/guides/custom-components
+[events guide]: https://formidable.com/open-source/victory/guides/events
+[themes guide]: https://formidable.com/open-source/victory/guides/themes
+[`victorychart`]: https://formidable.com/open-source/victory/docs/victory-chart
+[`victoryclipcontainer`]: https://formidable.com/open-source/victory/docs/victory-clip-container
 [grayscale theme]: https://github.com/FormidableLabs/victory-core/blob/master/src/victory-theme/grayscale.js
-[Explore all the interpolation options]: https://formidable.com/open-source/victory/gallery/interpolation
+[explore all the interpolation options]: https://formidable.com/open-source/victory/gallery/interpolation