This repository has been archived by the owner on Aug 4, 2020. It is now read-only.
WIP - Add documentation for Background component #676
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
boygirl
reviewed
May 12, 2020
boygirl
reviewed
May 13, 2020
| - `scale` *object* the x and y scale of the parent chart with `domain` and `range` applied | ||
| - `shapeRendering` *string* the shape rendering attribute to apply to the rendered path | ||
| - `style` *object* the styles to apply to the rendered element | ||
| - `width` *number* the width of parent chart (used to calculate default bar width `style.width` is not supplied) |
There was a problem hiding this comment.
This width prop is not correct
boygirl
reviewed
May 13, 2020
| - `shapeRendering` *string* the shape rendering attribute to apply to the rendered path | ||
| - `style` *object* the styles to apply to the rendered element | ||
| - `width` *number* the width of parent chart (used to calculate default bar width `style.width` is not supplied) | ||
| - `x` *number* the x coordinate of the top of the background |
There was a problem hiding this comment.
top left for non polar charts, center for polar charts
boygirl
reviewed
May 13, 2020
src/content/introduction/new.md
Outdated
|
|
||
| ## Backgrounds for VictoryChart | ||
|
|
||
| VictoryChart now includes an optional [`backgroundComponent`](/docs/victory-chart#backgroundcomponent) prop. It will also render the new [`Background`](/docs/victory-primitives#backgroundcomponent) simple component as the default backgroundComponent when the "background" property is included in the VictoryChart style prop. |
There was a problem hiding this comment.
I would love to see the copy on this page be a little more conversational. I can help out here if you'd like.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR:
34.3.0backgroundComponentprop forVictoryChartstyleprop to includebackgroundforVictoryChartBackgroundprimitive componentIntroductiona new section calledNew Featureswith documentation about the new features forVictoryChart