Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: more documentation updates #2818

Merged
merged 10 commits into from
Feb 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<a href="https://formidable.com/open-source/" target="_blank">
<a href="https://commerce.nearform.com/open-source/" target="_blank">
<img alt="Victory — Formidable, We build the modern web" src="https://github.com/raw/FormidableLabs/victory/main//Victory-Hero.png" />
</a>

Expand Down Expand Up @@ -40,7 +40,7 @@
- [Guides](http://formidable.com/open-source/victory/guides)
- [Contributing](#contributing)

* See the **docs and examples** on the website: http://formidable.com/open-source/victory.
* See the **docs and examples** on the website: https://commerce.nearform.com/open-source/victory.
* **Experiment** with all Victory components in this [code sandbox](https://codesandbox.io/s/dj4f7t)

## Getting started
Expand Down Expand Up @@ -78,7 +78,7 @@ render(<PieChart />, document.getElementById("app"));

## Requirements

Projects using Victory should also depend on [React][]. Victory works with React ~~version 15 and above.~~ As of `victory@34.0.0` Victory requires React version `16.3.0` or above
Projects using Victory should also depend on [React][]. As of `victory@34.0.0` Victory requires React version `16.3.0` or above

## Victory Native

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">Victory Documentation Site</h1>

[Documentation site](https://formidable.com/open-source/victory/) for [victory](https://github.com/FormidableLabs/victory) built with [react-static](https://github.com/nozzle/react-static).
[Documentation site](https://commerce.nearform.com/open-source/victory/) for [victory](https://github.com/FormidableLabs/victory) built with [react-static](https://github.com/nozzle/react-static).


## Getting Started
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/common-props/common-props.md
Original file line number Diff line number Diff line change
Expand Up @@ -1075,7 +1075,7 @@ See the [Data Accessors Guide][] for more detail on formatting and processing da

[x]: #x
[y]: #y
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
[width]: #width
[height]: #height
[victorylabel]: /docs/victory-label
Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/common-container-props.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,11 +234,11 @@ _example:_
The optional `onTouchEnd` prop takes a function that is called at the conclusion of every touch event on the chart (when using `victory-native`). The most common use of `onTouchEnd` is to prevent the chart's parent `ScrollView` from scrolling, so that the chart and container can be interacted with unencumbered. The function accepts a single parameter, `event`, a React Native [Synthetic Event][]. Also see `onTouchStart`.

[victoryportal]: /docs/victory-portal
[portal]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-portal/portal.js
[portal]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-portal/portal.tsx
[react-native-svg]: https://github.com/react-native-community/react-native-svg
[victorytheme]: /docs/victory-theme
[victorytooltip]: /docs/victory-tooltip
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
[read more about themes here]: /guides/themes
[synthetic event]: https://facebook.github.io/react-native/docs/gesture-responder-system.html#responder-lifecycle
[react event handlers]: https://reactjs.org/docs/handling-events.html
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-animation.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ _default:_ `easing="quadInOut"`
The `onEnd` prop specifies a function that will be called when the animation ends. If there are multiple animations in the queue, the `onEnd` function will be called after the last animation in the queue completes.

[d3-interpolate]: https://github.com/d3/d3-interpolate
[slight modifications]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-animation/util.js
[slight modifications]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-animation/util.ts
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-area.md
Original file line number Diff line number Diff line change
Expand Up @@ -533,5 +533,5 @@ See the [Data Accessors Guide][] for more detail on formatting and processing da
[themes guide]: /guides/themes
[`victorychart`]: /docs/victory-chart
[`victoryclipcontainer`]: /docs/victory-clip-container
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
[explore all the interpolation options]: /gallery/interpolation
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-axis.md
Original file line number Diff line number Diff line change
Expand Up @@ -501,6 +501,6 @@ width={400}
[`victorychart`]: /docs/victory-chart
[tickformat]: /docs/victory-axis#tickformat
[d3scale]: https://github.com/d3/d3-scale
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
[linesegment component]: /docs/victory-primitives#linesegment
[`victorylabel`]: /docs/victory-label
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -592,4 +592,4 @@ See the [Data Accessors Guide][] for more detail on formatting and processing da
[events guide]: /guides/events
[themes guide]: /guides/themes
[`victorychart`]: /docs/victory-chart
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-boxplot.md
Original file line number Diff line number Diff line change
Expand Up @@ -920,7 +920,7 @@ y={(d) => d.value + d.error}
[events guide]: /guides/events
[themes guide]: /guides/themes
[`victorychart`]: /docs/victory-chart
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
[`x`]: /docs/victory-boxplot#x
[`y`]: /docs/victory-boxplot#y
[`max`]: /docs/victory-boxplot#max
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-candlestick.md
Original file line number Diff line number Diff line change
Expand Up @@ -804,4 +804,4 @@ x={(datum) => new Date(datum.day)}
[`close`]: /docs/victory-candlestick#close
[`high`]: /docs/victory-candlestick#high
[`low`]: /docs/victory-candlestick#low
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -523,7 +523,7 @@ width={400}
[victoryhistogram]: /docs/victory-histogram
[victorystack]: /docs/victory-stack
[victoryvoronoi]: /docs/victory-voronoi
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
[animations guide]: /guides/animations
[events guide]: /guides/events
[themes guide]: /guides/themes
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ By default, `VictoryContainer` renders responsive SVGs. `VictoryContainer` also
container that can be accessed via [VictoryPortal][] in order to render specified children above others. All other Victory containers extend `VictoryContainer`. Check out documentation for [common container props][] for more information about customizing container props.

[VictoryPortal]: /docs/victory-portal
[Portal]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-portal/portal.js
[Portal]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-portal/portal.tsx
[common container props]: /docs/common-container-props
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-errorbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -516,4 +516,4 @@ y={(d) => d.value + d.error}
[`y`]: /docs/victory-candlestick#y
[`errorx`]: /docs/victory-candlestick#errorX
[`errory`]: /docs/victory-candlestick#errorY
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,7 @@ y0={() => 10}
[data accessors guide]: /guides/data-accessors
[events guide]: /guides/events
[themes guide]: /guides/themes
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
[victoryarea]: /docs/victory-area
[victoryaxis]: /docs/victory-axis
[victorybar]: /docs/victory-bar
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-histogram.md
Original file line number Diff line number Diff line change
Expand Up @@ -554,4 +554,4 @@ x = "employee.name";
[themes guide]: /guides/themes
[`victorychart`]: /docs/victory-chart
[`victorybar`]: /docs/victory-bar
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-legend.md
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,7 @@ The `y` prop defines the y coordinate corresponding to the upper left corner of
[victorylabel]: /docs/victory-label
[point component]: /docs/victory-primitives#point
[border component]: /docs/victory-primitives#border
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
[read more about themes here]: /guides/themes
[custom components guide]: /guides/custom-components
[events guide]: /guides/events
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -551,5 +551,5 @@ y={(d) => d.value + d.error}
[themes guide]: /guides/themes
[`victorychart`]: /docs/victory-chart
[`victoryclipcontainer`]: /docs/victory-clip-container
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
[explore all the interpolation options]: /gallery/interpolation
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-pie.md
Original file line number Diff line number Diff line change
Expand Up @@ -576,4 +576,4 @@ The `labelIndicatorOuterOffset` prop defines the offset by which the indicator l
[custom components guide]: /guides/custom-components
[events guide]: /guides/events
[themes guide]: /guides/themes
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-polar-axis.md
Original file line number Diff line number Diff line change
Expand Up @@ -570,7 +570,7 @@ width={400}
[`victorychart`]: /docs/victory-chart
[tickformat]: /docs/victory-axis#tickformat
[d3scale]: https://github.com/d3/d3-scale
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
[linesegment component]: /docs/victory-primitives#linesegment
[arc component]: /docs/victory-primitives#arc
[`victorylabel`]: /docs/victory-label
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-portal.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ scope: null
The `groupComponent` prop takes a component instance which will be used to create a group element for `VictoryPortal` to render its child component into. This prop defaults to a `<g>` tag.

[victorycontainer]: /docs/victory-container
[portal]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-portal/portal.js
[portal]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-portal/portal.tsx
30 changes: 15 additions & 15 deletions docs/src/content/docs/victory-primitives.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ _note_ `Box` also exported as `Border`

### Candle

[VictoryCandlestick][] uses `Candle` to represent a single data point as a candle. `Candle` renders a group with `<Rect>` and `<Line>` elements. [View the source][candle]
[VictoryCandlestick][] uses `Candle` to represent a single data point as a candle. `Candle` renders a group with `<Rect>` and `<Line>` elements. [View the source][candlestick]

**Props**

Expand Down Expand Up @@ -473,29 +473,29 @@ _note_ `Box` also exported as `Border`
[victoryclipcontainer]: /docs/victory-clip-container
[victorylabel]: /docs/victory-label
[react-native-svg]: https://github.com/react-native-community/react-native-svg
[arc]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/arc.js
[arc]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/arc.tsx
[victorypolaraxis]: /docs/victory-polar-axis
[area]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/area.js
[area]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-area/src/area.tsx
[victoryarea]: /docs/victory-area
[background]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/background.js
[bar]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/bar.js
[border]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/border.js
[background]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/background.tsx
[bar]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-bar/src/bar.tsx
[border]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/border.tsx
[victorybar]: /docs/victory-bar
[candle]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/candle.js
[candlestick]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-candlestick/src/victory-candlestick.tsx
[victorycandlestick]: /docs/victory-candlestick
[curve]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/curve.js
[curve]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-line/src/curve.tsx
[victoryline]: /docs/victory-line
[errorbar]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/error-bar.js
[errorbar]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-errorbar/src/error-bar.tsx
[victoryerrorbar]: /docs/victory-errorbar
[flyout]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-tooltip/src/flyout.js
[flyout]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-tooltip/src/flyout.tsx
[victorytooltip]: /docs/victory-tooltip
[victoryaxis]: /docs/victory-axis
[axis]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/axis.js
[point]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/point.js
[slice]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/slice.js
[whisker]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/whisker.js
[axis]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-axis/src/victory-axis.tsx
[point]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/point.tsx
[slice]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-pie/src/slice.tsx
[whisker]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/whisker.tsx
[victorypie]: /docs/victory-pie
[voronoi]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-primitives/voronoi.js
[voronoi]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-voronoi/src/voronoi.tsx
[victoryvoronoi]: /docs/victory-voronoi
[victoryscatter]: /docs/victory-scatter
[victorylegend]: /docs/victory-legend
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-scatter.md
Original file line number Diff line number Diff line change
Expand Up @@ -608,4 +608,4 @@ y={(d) => d.value + d.error}
[events guide]: /guides/events
[themes guide]: /guides/themes
[`victorychart`]: /docs/victory-chart
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ The `xOffset` prop is used for grouping stacks of bars. This prop will be set by
[animations guide]: /guides/animations
[events guide]: /guides/events
[themes guide]: /guides/themes
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
[victoryarea]: /docs/victory-area
[victoryaxis]: /docs/victory-axis
[victorybar]: /docs/victory-bar
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,5 @@ To create your own theme, create an object with props and styles specified for a
}
```

[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
[See all Victory Themes here]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme
4 changes: 2 additions & 2 deletions docs/src/content/docs/victory-tooltip.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,5 +367,5 @@ The `y` prop defines the y coordinate to use as a basis for positioning the tool
[victorylabel]: /docs/victory-label
[victoryportal]: /docs/victory-portal
[victorycontainer]: /docs/victory-container
[portal]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-portal/portal.js
[approximate text size]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-util/textsize.js
[portal]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-portal/portal.tsx
[approximate text size]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-util/textsize.ts
2 changes: 1 addition & 1 deletion docs/src/content/docs/victory-voronoi.md
Original file line number Diff line number Diff line change
Expand Up @@ -475,4 +475,4 @@ y={(d) => d.value + d.error}
[events guide]: /guides/events
[themes guide]: /guides/themes
[`victorychart`]: /docs/victory-chart
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
6 changes: 3 additions & 3 deletions docs/src/content/guides/layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Victory renders svg elements, so there is no concept of z-index. Instead the ren

Some components, such as tooltips, should _always_ render above others. Use [`VictoryPortal`][] to render components in a top level container so that they appear above all other elements. `VictoryTooltip` uses `VictoryPortal`, by default, but any component may be wrapped in `VictoryPortal` to alter its rendering.

*caveats:* `VictoryPortal` will not work with components that are not rendered within `VictoryContainer`.
*caveats:* `VictoryPortal` only works with components that are rendered within `VictoryContainer`.

```playground
<VictoryChart domainPadding={40}>
Expand Down Expand Up @@ -141,7 +141,7 @@ To render a Victory component in a custom container set the `standalone` prop on
</svg>
```

*caveats:* `VictoryPortal` will not work with components that are not rendered within `VictoryContainer`.
*caveats:* `VictoryPortal` only works with components that are rendered within `VictoryContainer`.

[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.js
[grayscale theme]: https://github.com/FormidableLabs/victory/blob/main/packages/victory-core/src/victory-theme/grayscale.tsx
[`VictoryPortal`]: /docs/victory-portal
Loading
Loading