Skip to content

Commit

Permalink
add note to labelComponent prop in commonprops
Browse files Browse the repository at this point in the history
  • Loading branch information
Sawyer Burnett committed Feb 22, 2024
1 parent 9ca76a1 commit 1a51e69
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/src/content/common-props/common-props.md
Original file line number Diff line number Diff line change
Expand Up @@ -555,6 +555,8 @@ The horizontal prop determines whether data will be plotted horizontally. When t

The `labelComponent` prop takes a component instance which will be used to render labels for the component. The new element created from the passed `labelComponent` will be supplied with the following properties: x, y, index, data, datum, verticalAnchor, textAnchor, angle, style, text, and events. Any of these props may be overridden by passing in props to the supplied component, or modified or ignored within the custom component itself. If `labelComponent` is omitted, a new [VictoryLabel][] will be created with the props described above. [VictoryTooltip][] is commonly used as a `labelComponent`

_note_: `labelComponent` is not currently supported for `VictoryBoxPlot` as it has its own label components (`maxLabelComponent`, `medianLabelComponent`, `minLabelComponent`, `q1LabelComponent` & `q3LabelComponent`). See [VictoryBoxPlot][] for more info.

_examples:_

- `labelComponent={<VictoryLabel dy={20}/>}`
Expand Down Expand Up @@ -1081,6 +1083,7 @@ See the [Data Accessors Guide][] for more detail on formatting and processing da
[victorylabel]: /docs/victory-label
[victorytooltip]: /docs/victory-tooltip
[victoryportal]: /docs/victory-portal
[victoryboxplot]: /docs/victory-box-plot
[victoryclipcontainer]: /docs/victory-clip-container
[victorybrushcontainer]: /docs/victory-brush-container
[victorycursorcontainer]: /docs/victory-cursor-container
Expand Down

0 comments on commit 1a51e69

Please sign in to comment.