Update dependency victory to v36 #17
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
Configure Mend for GitHub.com
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 contains the following updates:
^0.25.6->^36.0.0By merging this PR, the below vulnerabilities will be automatically resolved:
Release Notes
FormidableLabs/victory (victory)
v36.0.0Compare Source
VictoryChart,VictoryGroupandVictoryStackto take advantage ofReact.memo.v35.11.4Compare Source
v35.11.3Compare Source
d3-interpolateVictoryThemeDefinitionto includehistogram. Thanks @2metres!v35.11.2Compare Source
victory-nativev35.11.0Compare Source
VictoryChart,VictoryGroupandVictoryStackto take advantage ofReact.memo.v35.10.1Compare Source
thisreferencesv35.10.0Compare Source
peerDependencyfor all Victory packagesrxandrytypes to the primitive props interface. Thanks @Wesleyzxc!v35.9.3Compare Source
barWidthfor grouped / stacked charts. Thanks @WaysToGo!v35.9.2Compare Source
barWidthcalculation for stacked / grouped bar charts.v35.9.1Compare Source
VictoryTooltip. Thanks @beccanelson!v35.9.0Compare Source
Adds a new
disableInlineStylesprop to components and primitives to support users who want to style their components by class, or use a CSS in JS solution likestyled-componentsWhen the new
disableInlineStylesprop is supplied to a component likeVictoryBarno styles will be supplied to either data or label components that it renders:The
disableInlineStylesprop may also be supplied to primitive components for more granular control:Related PRs
v35.8.6Compare Source
d3-arraydependency to correct for babel issuev35.8.5Compare Source
allowDrawtype definition forVictoryBrushContainer. Thanks @justindomingue!v35.8.4Compare Source
VictoryVoronoiContainerwithvoronoiDimension.v35.8.3Compare Source
offsetXandoffsetYprops for multi-quadrant chartsv35.8.2Compare Source
interpolationtype definition forVictoryArea. Thanks @pmilic021!v35.8.1Compare Source
minDomainintroduced in35.6.0.v35.8.0Compare Source
domainPaddingupdatesupdates how
domainPaddingis applied to charts when 1) the additional padding would not result new quadradants being added, or 2) the user has setsingleQuadrantDomainPadding={false}. In these cases,domainPaddingis applied by calculating a new, smaller range that takes the desired, pixel-based padding into account, and then adding domain padding such that the previous domain fits entirely within the new, smaller range. In most cases, this change will make it much easier to do things like create bar charts where the first bar starts cleanly at the edge of the chart, by settingdomainPadding={{ x: myBarWidth / 2 }}This may cause visual changes for charts that use very large values for
domainPadding. ThedomainPaddingprop may need to be adjustedcalculates a more exact
defaultDomainPaddingfor grouped bar charts based on theoffset, number of bars, and the width of each bar (either from thebarWidthprop or from a defaultbarWidthbased on the number of bars and the range). Previously,defaultDomainPaddingwas approximated based only onoffsetand number of bars.v35.7.2Compare Source
tickFormatis given as an array. Thanks @jhumbug!v35.7.1Compare Source
v35.7.0Compare Source
VictoryAxisresponsible for calculating its own defaultxOffset,yOffset,orientation, andcrossAxisvalues rather than relying onVictoryChartto determine these values. This change corrects several bugs related to how axes update on charts that useVictoryZoomContainer. We don't anticipate breaking changes with this update, but axis positioning will update differently (more correctly) when zooming. Thanks @jhumbug!v35.6.4Compare Source
VictoryThemetype definition to allow adding an optional style prop toVictoryGroupvia theme. Thanks @hknowlton!v35.6.3Compare Source
VictoryAccessibleGroupfrom the mainvictorypackagev35.6.2Compare Source
v35.6.0impacting inverted domain charts. Thanks @jhumbug!v35.6.1Compare Source
VictoryStack. Thanks @jhumbug!v35.6.0Compare Source
VictoryAreaandVictoryLine. This PR also includes a fix for animations so that animating data always reaches its final state before a new animation begins. Thanks @jhumbug!v35.5.1Compare Source
distoutputv35.5.0Compare Source
VictoryBrushContainerwithallowResizeset to false, and usedefaultBrushArea="move"by default whenallowResizeis set to false.v35.4.13Compare Source
VictoryTooltiptypes to allow users to set single dimensions for thecenterpropv35.4.12Compare Source
handleWidthtype toVictoryBrushContainerinterface. Thanks @aknaut!v35.4.11Compare Source
idprop toVictoryLabelPropsinterface. Thanks @nielsboecker!v35.4.10Compare Source
v35.4.9Compare Source
VictorySharedEvents. Thanks @the-kwisatz-haderach!v35.4.8Compare Source
-#1784 - - Add more font widths for the textsize util. Thanks @eatyourpeas!
v35.4.7Compare Source
typeprop from primitive components used byVictoryAxisandVictoryPolarAxisgetPathprop used by thePointprimitive. Thanks @ASmartLynx!v35.4.6Compare Source
-#1767 - Adds support for
rxandryprops on theBackgroundprimitive component. Thanks @NgoKnows!v35.4.5Compare Source
#1765 - Adds "cross" symbol for
VictoryScatterand thePointprimitive.#1766 - Allows the
binprop onVictoryHistogramto accept arrays of negative numbers. Thanks @NgoKnows!v35.4.4Compare Source
v35.4.3Compare Source
Portaltypev35.4.2Compare Source
defaultEventstoVictoryTooltiptypes. Thanks @beccanelson!v35.4.1Compare Source
VictoryTooltiptypes to allow users to set single dimensions for thecenterpropv35.4.0Compare Source
Support for Global Events
This release adds a concept of global events that are attached to
windowrather than to any of the elements rendered by Victory components. Global events are only supported for "parent" events that would normally be attached tosvgelements rendered by Victory's containerComponents. Events that should be global can be flagged by includingonGlobalin the name of the event handler. So, for example, useonGlobalMouseUprather thanonMouseUpto create a global mouse up handler.VictoryBrushContainer uses Global Events
VictoryBrushContainernow uses global events in itsdefaultEventsso that brushing continues even as the user's mouse moves outside of the chart area.v35.3.5Compare Source
roleprop forVictoryContainerv35.3.4Compare Source
VictoryAnimationwhen there are no active subscriptions. Thanks @noVerity!Object.keyswith lodashkeysfor consistency.v35.3.3Compare Source
v35.3.2Compare Source
VictoryCursorContainerfor smoother movement. Thanks @Alexander-AJ-Berman!v35.3.1Compare Source
#1724 Fixes a regression introduced in
35.3.0affecting charts whose dimensions are updated via auseEffecthook#1723 - Avoids unnecessary re-renders caused by empty events. Thanks @Hypnosphi!
v35.3.0Compare Source
json-safe-stringifyinVictorySharedEventsv35.2.0Compare Source
Accessibility Improvements
#1708 - This PR adds
ariaLabelto Victory's primitive components (VictoryLabel,Area,Baretc.). This new prop can take a string or a function that expected to return a string, and addsaria-labelattributes to svg elements Victory renders. This PR also addstabIndexandaria-labelprops toVictoryClipContainer, and creates a newgroupContainer,VictoryAccessibleGroup, which renders agtag and an optionaldesctag along with its other children.VictoryAccessibleGroupalso takesaria-labelandaria-describedbyprops. Thanks @ljones87 for all the hard work on this new feature!#1709 - Adds default
onFocusandonBlurevent handlers toVictoryTooltipso that users can trigger tooltips by tabbing through the chart elements whentabIndexis set.Bug fixes for labels and tooltips
VictoryVoronoiContainerrenders, includingtext,style,flyoutStyle,widthandheightangleprop onVictoryLabeldatumrather than coordinate.v35.1.1Compare Source
aria-labelledbyandaria-describedbyprops toVictoryContainer. Thanks @elliotdickison!v35.1.0Compare Source
preserveAspectRatioprop toVictoryContainer, and usesheight: "100%"rather thanheight: "auto", giving users finer control over how Victory's svgs are positioned and scaled within their containers.v35.0.9Compare Source
v35.0.8Compare Source
ouiaSafeprop onVictoryContainerv35.0.7Compare Source
VictoryContainer. Thanks @dlabrecq!v35.0.6Compare Source
v35.0.5Compare Source
#1648 - Fix a bug effecting
backgroundStyleswhen using functional styles. Thanks @chacestew!#1649 - update lodash dependency
v35.0.4Compare Source
v35.0.3Compare Source
v35.0.2Compare Source
TextSizeutility. Thanks @jlismore!v35.0.1Compare Source
v35.0.0Compare Source
Label and Theme Improvements!
This release introduces new label features and makes improvements to themes. This release includes breaking style changes. Please double check your label and tooltip styles when upgrading. Polar axes and pie charts may be particularly impacted.
New Features!
VictoryLabelnow supports label backgrounds, which are rendered asrectelements behind your labels. Backgrounds are styled via the newbackgroundStyleprop onVictoryLabel. This prop may be given as a style object, or an array of objects for styling multi-line labels. Background elements are sized for their corresponding text elements, but padding may also be added with thebackgroundPaddingprop, which accepts a single number, an object with values for "top", "bottom", "left" and "right", or an array of either of these for adding background padding to multi-line labels.VictoryTooltiphas a newflyoutPaddingprop that may be used to add padding between the edge of the flyout and the label within it. TheflyoutPaddingprop may be given as a single number of as an object with values for "top", "bottom", "left" and "right". This is a breaking change, asstyle.paddingno longer adds padding between the flyout and its label. Both of Victory's built-in themes have been altered so that tooltips getflyoutPadding={5}by default.VictoryPienow supports thelabelPlacementprop used in polar charts. Possible values are "vertical" "parallel" and "perpendicular". When not given, vertical labels are rendered as before.Themes now support
polarAxis,polarDependentAxis, andpolarIndependentAxisnamespaces that are merges with the less specificaxis,dependentAxis, andindependentAxisthemes as appropriate.Improvements
Changes Victory's default branch from
mastertomain🖤Textsizeapproximations have changed, and are much more accurate in most cases. This may be a breaking change for layouts that depended on approximated text sizeTooltip themes are now correctly merged with label styles and props.
VictoryPolarAxiselements are now rendered relative to the origin independently, rather than being translated as a group. This allows for correct positioning of elements withinVictoryPortalThis may be a breaking change for custom components inVictoryPolarAxisCorrects the
labelPositionprop onVictoryPie(previouslystartAngleandendAnglewere inverted) This is a breaking changeAlters
materialandgreyscalethemes. The following theme updates may cause breaking style changesboxplotandcandlestickpolarDependentAxissettings to thematerialthemetooltipstyles override label styles on all other theme namespaces. This means that tooltips pointers will now all start exactly at the data element they correspond to by default. To alter this behavior, either 1) provide a different theme, 2) alter padding in via label styles like so:<VictoryBar
style={{ labels: { padding: 5 } }}
labelComponent={}
/>
or
<VictoryBar
labelComponent={
<VictoryTooltip style={{ padding: 5 }} />
}
/>
Associated PRs
v34.3.12Compare Source
-#1620 - Allow granular
voronoiPadding. Thanks @dlabrecq!-#1607 - Add missing containerRef type. Thanks @NgoKnows!
v34.3.11Compare Source
v34.3.10Compare Source
#1604 - Fixes offsets for groups of stacked bars. Thanks @cneltyn!
#1599 - Fixes a bug causing incorrect cursor behavior
onMouseLeave. Thanks @NgoKnows!v34.3.9Compare Source
sharedEventsto improve performance in evented containers. Thanks @NgoKnows!v34.3.8Compare Source
v34.3.7Compare Source
v34.3.6Compare Source
VictoryVoronoiContainerVictoryVoronoiContainerfrom rendering tooltips with empty textv34.3.5Compare Source
-#1575 - Allow the
idprop forVictoryLabelto be given as a function. Thanks @amyboyd!v34.3.4Compare Source
d3-scaleandreact-fast-compareforvictory-histogram. Thanks @Mike-Dax!v34.3.3Compare Source
backgroundComponenttypev34.3.2Compare Source
victory-histogramdependencyv34.3.1Compare Source
-#1620 - Allow granular
voronoiPadding. Thanks @dlabrecq!-#1607 - Add missing containerRef type. Thanks @NgoKnows!
v34.3.0Compare Source
VictoryHistogramcomponent. Huge thanks to @NgoKnows for this new feature!Histogram bins may be defined with the
binprop, which takes either an array of bin edges, or a single number which corresponds to an approximate number of bins.VictoryHistogramis meant to work with continuous data, and expects a data prop as an array of objects with x values. By default, histogram bins will be laid out with no spaces between bins, but the optionalbinSpacingprop may be provided to change this behavior. Additional documentation and examples will be coming soon.v34.2.2Compare Source
backgroundComponentforVictoryChartthat will be rendered ifVictoryChart'sstylecomponent includesbackgroundstyles. TheBackgroundcomponent renders arectfor cartesian charts and acirclefor polar charts that is correctly sized and positioned to fill the entire range of the chart. Thanks @maddles and @wparsons!v34.2.1Compare Source
domainprop defined for a single dimension.domainPaddingto not be applied to stacked and grouped charts withdomainprops defined.v34.2.0Compare Source
Update typescript types for all Victory components. A huge thanks to @maddles @wparsons and @kale-stew for this work. This release includes the following PRs
#1557, #1556, #1554, #1552, #1551, #1550, #1547, #1546, #1543, #1538, #1536, #1535, #1534, #1533, #1532, #1530,#1529, #1528, #1527, #1526, #1525, #1524, #1522, #1521, #1520, #1519, #1515, #1514, #1512, #1510, #1508
v34.1.3Compare Source
v34.1.2Compare Source
v34.1.1Compare Source
VictoryCharttypesv34.1.0Compare Source
definitely-typedproject so that we can maintain them more easily going forwardv34.0.1Compare Source
activePointsprop toVictoryTooltipwhichVictoryVoronoiContainersupplies to itslabelComponent. Thanks @jotak!v34.0.0Compare Source
Breaking Changes
This version uses the context API introduced in
react@16.3.0v33.1.7Compare Source
v33.1.6Compare Source
stringMapcomputation when data is preformatted (i.e. data uses has_xand_yvalues and accessors). Thanks @na9da!v33.1.5Compare Source
mouseMoveThresholdprop forVictoryBrushContainerto prevent accidental redraws. Thanks @Hypnosphi!VictoryBrushContaineronMouseLeavev33.1.4Compare Source
labelPositionprop onVictoryPiev33.1.3Compare Source
VictoryBrushAreawhen axes are inverted. Thanks @Hypnosphi!defaultBrushAreaprop inVictoryBrushContainer. When this option is selected, clicking outside of the brush area will pan the brush to a the area the user clicked without resizing the brush. Thanks @Hypnosphi!v33.1.2Compare Source
VictoryChartdoes not override axis orientations defined in themes.onBrushEnddomain callback.allowZoomprop. Thanks @Hypnosphi!v33.1.1Compare Source
delaunay-findto0.0.4to correct incorrect nearest values for sets of points with collinear values. Corrects bugs inVictoryVoronoiContainerv33.1.0Compare Source
v33.0.6Compare Source
#1401 - Fixes a bug affecting automatic candle coloring
#1402 - Fixes a bug affecting user-provided
containerRefcallbacksv33.0.5Compare Source
interpolationprop. Thanks @sanniassin!v33.0.4Compare Source
1384 - Fixes a bug affecting functional
cornerRadiusonVictoryTooltip1385 - Adds
pointerOrientationprop onVictoryTooltipto make it possible to control which side of the tooltip the pointer extends from independent of which side of the data point the entire flyout is oriented towards. This prop only became sensible with the addition ofcenterandcenterOffsetprops added invictory@33.0.0v33.0.3Compare Source
padAngleprop inVictoryPiev33.0.2Compare Source
VictoryPiev33.0.1Compare Source
textis evaluated before any other functional props forVictoryLabelso it may be used to determine things like style, etc.v33.0.0Compare Source
Breaking Changes
Changes for functional props and styles:
Related PR: #1360
Functional props like
labelsand functional styles will now be called with a single argument instead ofdatumandactive. The argument passed to functional props and styles will be an object containing all the props that control the rendering of the the target the prop applies to. Including things likedatum,active,index,data,scale, etc. We hope this will give users a lot more flexibility and control. In most cases, this change should be very straightforward to applyold:
new
Gotchas:
cornerRadiusfunction that depends onbarWidth, do not also makebarWidtha function of some other prop.yandx, andtickFormat. The arguments for these props have not changed.Changes for
VictoryCandlesticklabelsRelated PR: #1295
VictoryCandlesticknow has granular support for labels corresponding to each portion of the candle. The currentlabelsandlabelComponentprops will be joined by new props corresponding to each part of the candle.New props
lowLabelslowLabelComponenthighLabelshighLabelComponentopenLabelsopenLabelComponentcloseLabelscloseLabelComponentThis will be a breaking change affecting the positioning of the default
label. In earlier versions, the default label was positioned above the candle, it will now be positioned next to the center of the candle.To use older label positioning, use
highLabels/highLabelComponentrather thanlabel/labelComponent. If you are using tooltips withVictoryCandlestick, you will need to register a custom event to trigger yourhighLabelstooltip:example:
The
styleprop forVictoryCandlesticknow also has namespaces for the new labels in addition to the currentlabelsnamespace. When bothlabelsand specific label styles (e.g.highLabels) are provided, the styles will be mergedChanges for
VictoryVoronoiContainerRelated PR: #1371
Before this version
VictoryVoronoiContainerhad limited functionality for mouse-following tooltips, and for constraining a tooltip to the chart area, but it was only usable for multi-point tooltips (withvoronoiDimension), and was not user configurable. This version aims to correct these limitations:mouseFollowTooltips: This new boolean prop onVictoryVoronoiContainerdetermines whether the labels should follow the mouse position or snap into place. (Note that in charts usingvoronoiDimension, the tooltip still follows the mouse in the non-voronoiDimension, as demonstrated in the charts below (both withvoronoiDimension="x")mouseFollowLabels={true}mouseFollowTooltips={false}VictoryVoronoiContainerwill no longer be constrained to the chart area by default. Instead, add theconstrainToVisibleAreaprop toVictoryTooltipto enable this behavior for both multi-point and single point tooltips:example:
Changes for
VictoryTooltipandVictoryLabelRelated PR:#1371
The changes we wanted to make to support new behaviors in
VictoryVoronoiContainerrequired some changes toVictoryTooltipandVictoryLabelNew props for
VictoryTooltip:constrainToVisibleAreais a boolean prop that, when true, will alter the position of the tooltip so that it exactly fits within the svg Victory renders. The tooltip's center will be moved, but the pointer wi