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

add note to labelComponent prop in commonprops #2822

Merged
merged 1 commit into from
Feb 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/src/content/common-props/common-props.md
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