Skip to content

Commit b3695c0

Browse files
authored
add note to labelComponent prop in commonprops (#2822)
1 parent 9ca76a1 commit b3695c0

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/src/content/common-props/common-props.md

+3
Original file line numberDiff line numberDiff line change
@@ -555,6 +555,8 @@ The horizontal prop determines whether data will be plotted horizontally. When t
555555

556556
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`
557557

558+
_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.
559+
558560
_examples:_
559561

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

0 commit comments

Comments
 (0)