refactor: `PolarGrid` to function component by akamfoad · Pull Request #3471 · recharts/recharts

akamfoad · 2023-03-21T19:13:30Z

Description

rm: JSDoc eslint rule in favor of typescript

JSDoc is great for documenting code in JS, but since the library built with typescript natively, we shall use JSDoc only for documenting purposes. For everything related to typing is better to utilize TypeScript to keep the library source code consistent and correct. The ESLint rule for valid JSDoc comments have been removed since it requires all comments to have some properties that would be the duplicate of the TS types and adds maintenance overhead with no value. Also this rule has been deprecated 5y ago

refactor: `PolarGrid` to function component

Converted the PolarGrid component to functional component and converted the static functions to in-component functions, then refactored them out of the component itself. After that converted all outside functions which rendered JSX to be React components instead.

Related Issue

Motivation and Context

Refactoring library to be more maintainable - testing refactor-ability

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.

ckifer · 2023-03-21T19:39:51Z

Looks like the build is failing

ckifer

The rest looks good to me, but build is failing and lets keep the ESLint rule for now. Agreed with you, but we can modify in a different PR

Converted the PolarGrid component to functional component and converted the static functions to in-component functions, then refactored them out of the component itself. After that converted all outside functions which rendered JSX to be React components instead.

ckifer · 2023-03-22T20:42:30Z

I am hesitant to merge this one due to it existing in this map

recharts/src/chart/generateCategoricalChart.tsx

Lines 2140 to 2161 in e7858c9

    
           const map = { 
        
             CartesianGrid: { handler: this.renderGrid, once: true }, 
        
             ReferenceArea: { handler: this.renderReferenceElement }, 
        
             ReferenceLine: { handler: this.renderReferenceElement }, 
        
             ReferenceDot: { handler: this.renderReferenceElement }, 
        
             XAxis: { handler: this.renderXAxis }, 
        
             YAxis: { handler: this.renderYAxis }, 
        
             Brush: { handler: this.renderBrush, once: true }, 
        
             Bar: { handler: this.renderGraphicChild }, 
        
             Line: { handler: this.renderGraphicChild }, 
        
             Area: { handler: this.renderGraphicChild }, 
        
             Radar: { handler: this.renderGraphicChild }, 
        
             RadialBar: { handler: this.renderGraphicChild }, 
        
             Scatter: { handler: this.renderGraphicChild }, 
        
             Pie: { handler: this.renderGraphicChild }, 
        
             Funnel: { handler: this.renderGraphicChild }, 
        
             Tooltip: { handler: this.renderCursor, once: true }, 
        
             PolarGrid: { handler: this.renderPolarGrid, once: true }, 
        
             PolarAngleAxis: { handler: this.renderPolarAxis }, 
        
             PolarRadiusAxis: { handler: this.renderPolarAxis }, 
        
             Customized: { handler: this.renderCustomized }, 
        
           } as any;

This means that the static property displayName is used by the generateCategoricalChart function. That means more potential for bugs (imo) in the components in that map as compared to the others. Just a callout

akamfoad · 2023-03-23T01:35:42Z

@ckifer I understand, tbh I tried to refactor some other components but I hesitated too since it or some of it's static members were used in this function to generate the charts. I think we need to refactor that somehow, I might try again once more, will keep this map in mind for the next refactor.

ckifer · 2023-03-23T01:42:53Z

Totally agreed, the more I understand how it's working the more I consider it an anti-pattern.

Recharts in general needs an architectural deep dive and maybe some flow diagrams so we can figure out a decently replacement for the static member issue among others.

nikolasrieble · 2023-05-03T20:11:21Z

Please separate this into two PRs, one for the refactoring and one for the eslint rule. Both are separate concerns. Removing the eslint rule still seems a reasonable improvement.

akamfoad · 2023-05-04T07:39:00Z

@nikolasrieble I removed the ESLint change at the time, this PR only changes PolarGrid

ckifer

Overall looks good. Can we do the same kind of comparison as with Curve before merge?

ckifer · 2023-05-04T20:16:31Z

+  return (
+    <g className="recharts-polar-grid-concentric">
+      {polarRadius.map((entry: number, i: number) => {
+        const key = i;


nit: why assign a variable to i which is already defined?

Actually just to trick ESLint regarding the no-array-index-key rule, that otherwise shows a warning.

akamfoad · 2023-05-05T12:07:42Z

Of course @ckifer here it is:

recharts on refactor/polar-grid-component ➜ pixelmatch .\master-polar-grid.png .\refactored-polar-grid.png diff.png 0.1

matched in: 14.547ms
different pixels: 0
error: 0%

On `master`

On `akamfoad:refactor/polar-grid-component`

`Diff`

ckifer · 2023-05-05T14:19:58Z

Wonderful, thank you!

<h3>Snyk has created this PR to upgrade recharts from 2.5.0 to 2.6.0.</h3> :information_source: Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project. <hr/> - The recommended version is **1 version** ahead of your current version. - The recommended version was released **22 days ago**, on 2023-05-08. <details> <summary><b>Release notes</b></summary> <br/> <details> <summary>Package name: <b>recharts</b></summary> <ul> <li> <b>2.6.0</b> - <a href="https://snyk.io/redirect/github/recharts/recharts/releases/tag/v2.6.0">2023-05-08</a></br><h2>What's Changed</h2> <p>Storybook documentation updates as well as our first accessibility feature thanks to <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/julianna-langston/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/julianna-langston">@ julianna-langston</a> and some refactoring to function components!</p> <h3>Feat</h3> <ul> <li>[a11y] Keyboard navigation support for categorical charts by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/julianna-langston/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/julianna-langston">@ julianna-langston</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1679039594" data-permission-text="Title is private" data-url="recharts/recharts#3546" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3546/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3546">#3546</a> <ul> <li>See docs <a href="https://release--63da8268a0da9970db6992aa.chromatic.com/?path=/docs/api-accessibility--docs" rel="nofollow">here</a></li> </ul> </li> </ul> <h3>Fix</h3> <ul> <li>Update type for <code>equidistantPreserveStart</code> axis interval by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/frontier159/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/frontier159">@ frontier159</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1665853314" data-permission-text="Title is private" data-url="recharts/recharts#3511" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3511/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3511">#3511</a></li> <li>Stop focusing on tooltip when displayed - use event listeners instead by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/ArkaFred/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/ArkaFred">@ ArkaFred</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1666576070" data-permission-text="Title is private" data-url="recharts/recharts#3515" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3515/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3515">#3515</a></li> </ul> <h3>Docs</h3> <ul> <li>lots of storybook changes - <a href="https://release--63da8268a0da9970db6992aa.chromatic.com/" rel="nofollow">go check it out</a>! <ul> <li>Getting close to parity with existing docs on recharts.org</li> <li>Added accessibility add-on</li> <li>Added accessibility docs to go with the keyboard navigation support</li> <li>Storybook 7 stable</li> <li>Much more!</li> </ul> </li> </ul> <h3>Refactor</h3> <ul> <li>refactor: <code>Curve</code> to function component by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/akamfoad/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/akamfoad">@ akamfoad</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1635746753" data-permission-text="Title is private" data-url="recharts/recharts#3477" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3477/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3477">#3477</a></li> <li>refactor: <code>PolarGrid</code> to function component by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/akamfoad/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/akamfoad">@ akamfoad</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1634552898" data-permission-text="Title is private" data-url="recharts/recharts#3471" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3471/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3471">#3471</a></li> <li>refactor: <code>Cross</code> to component function by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/akamfoad/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/akamfoad">@ akamfoad</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1635686265" data-permission-text="Title is private" data-url="recharts/recharts#3475" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3475/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3475">#3475</a></li> <li>refactor: tooltip to function component by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/ckifer/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/ckifer">@ ckifer</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1573765245" data-permission-text="Title is private" data-url="recharts/recharts#3336" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3336/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3336">#3336</a></li> <li>fix: defaultProps of tooltip, fix viewBox by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/ckifer/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/ckifer">@ ckifer</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1682527991" data-permission-text="Title is private" data-url="recharts/recharts#3554" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3554/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3554">#3554</a></li> <li>refactor: <code>Text</code> to function component by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/akamfoad/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/akamfoad">@ akamfoad</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1630235362" data-permission-text="Title is private" data-url="recharts/recharts#3463" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3463/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3463">#3463</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/akamfoad/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/akamfoad">@ akamfoad</a> made their first contribution in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1633414419" data-permission-text="Title is private" data-url="recharts/recharts#3466" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3466/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3466">#3466</a></li> <li><a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/nicholasgcoles/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/nicholasgcoles">@ nicholasgcoles</a> made their first contribution in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1633478608" data-permission-text="Title is private" data-url="recharts/recharts#3467" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3467/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3467">#3467</a></li> <li><a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/linhuiw/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/linhuiw">@ linhuiw</a> made their first contribution in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1664182317" data-permission-text="Title is private" data-url="recharts/recharts#3508" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3508/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3508">#3508</a></li> <li><a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/frontier159/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/frontier159">@ frontier159</a> made their first contribution in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1665853314" data-permission-text="Title is private" data-url="recharts/recharts#3511" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3511/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3511">#3511</a></li> <li><a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/ArkaFred/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/ArkaFred">@ ArkaFred</a> made their first contribution in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1666576070" data-permission-text="Title is private" data-url="recharts/recharts#3515" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3515/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3515">#3515</a></li> <li><a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/julianna-langston/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/julianna-langston">@ julianna-langston</a> made their first contribution in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1671964677" data-permission-text="Title is private" data-url="recharts/recharts#3540" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3540/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3540">#3540</a></li> </ul> <p><strong>Full Changelog</strong>: <a class="commit-link" href="https://snyk.io/redirect/github/recharts/recharts/compare/v2.5.0...v2.6.0"><tt>v2.5.0...v2.6.0</tt></a></p> </li> <li> <b>2.5.0</b> - <a href="https://snyk.io/redirect/github/recharts/recharts/releases/tag/v2.5.0">2023-03-15</a></br><h2>What's Changed</h2> <h3>Feat</h3> <ul> <li><code>ResponsiveContainer</code>: <code>onResize</code> callback function by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/ckifer/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/ckifer">@ ckifer</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1582916569" data-permission-text="Title is private" data-url="recharts/recharts#3361" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3361/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3361">#3361</a></li> <li><code>XAxis</code>, <code>YAxis</code>: <code>includeHidden</code> prop - include all datapoints in domain calculation even when hidden by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/neefrehman/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/neefrehman">@ neefrehman</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1500101512" data-permission-text="Title is private" data-url="recharts/recharts#3103" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3103/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3103">#3103</a></li> <li><code>XAxis</code>, <code>YAxis</code>: new interval option <code>equidistantPreserveStart</code> by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/nikolasrieble/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/nikolasrieble">@ nikolasrieble</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1594785191" data-permission-text="Title is private" data-url="recharts/recharts#3392" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3392/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3392">#3392</a></li> </ul> <h3>Fix</h3> <ul> <li><code>ResponsiveContainer</code>: default min-width to 0 to override default auto behavior that breaks flexbox layouts by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/ckifer/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/ckifer">@ ckifer</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1594523953" data-permission-text="Title is private" data-url="recharts/recharts#3391" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3391/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3391">#3391</a></li> <li><code>Area</code>: Add missing 'data' type to Area component by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/ondrejvelisek/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/ondrejvelisek">@ ondrejvelisek</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1615470205" data-permission-text="Title is private" data-url="recharts/recharts#3443" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3443/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3443">#3443</a></li> <li><code>Brush</code>/<code>XAxis</code>: fix NaN regression when <code>interval={0}</code> by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/nikolasrieble/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/nikolasrieble">@ nikolasrieble</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1622213441" data-permission-text="Title is private" data-url="recharts/recharts#3454" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3454/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3454">#3454</a></li> <li><code>ReferenceArea</code>/<code>ReferenceLine</code>: revert regression where <code>ifOverflow</code> prop is not obeyed due to missing defaultProps by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/ckifer/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/ckifer">@ ckifer</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1622808868" data-permission-text="Title is private" data-url="recharts/recharts#3455" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3455/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3455">#3455</a></li> </ul> <h3>Docs</h3> <ul> <li>lots of storybook changes - <a href="https://master--63da8268a0da9970db6992aa.chromatic.com/" rel="nofollow">go check it out</a>!</li> </ul> <h3>Dependencies</h3> <ul> <li>chore: explicitly upgrade minor version of react-smooth by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/ckifer/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/ckifer">@ ckifer</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1597775617" data-permission-text="Title is private" data-url="recharts/recharts#3397" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3397/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3397">#3397</a></li> <li>chore: upgrade react-resize-detector to 8.x by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/ckifer/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/ckifer">@ ckifer</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1607429776" data-permission-text="Title is private" data-url="recharts/recharts#3418" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3418/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3418">#3418</a></li> </ul> <h3>Refactor</h3> <ul> <li>Refactoring: Adapt getTicks to increase reusability of code by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/nikolasrieble/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/nikolasrieble">@ nikolasrieble</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1595050186" data-permission-text="Title is private" data-url="recharts/recharts#3393" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3393/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3393">#3393</a></li> <li>Refactoring: Extract TicksUtils from CartesianAxis and add unit tests by <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/nikolasrieble/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/nikolasrieble">@ nikolasrieble</a> in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1593521268" data-permission-text="Title is private" data-url="recharts/recharts#3386" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3386/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3386">#3386</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/users/ondrejvelisek/hovercard" data-octo-click="hovercard-link-click" data-octo-dimensions="link_type:self" href="https://snyk.io/redirect/github/ondrejvelisek">@ ondrejvelisek</a> made their first contribution in <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1615470205" data-permission-text="Title is private" data-url="recharts/recharts#3443" data-hovercard-type="pull_request" data-hovercard-url="/recharts/recharts/pull/3443/hovercard" href="https://snyk.io/redirect/github/recharts/recharts/pull/3443">#3443</a></li> </ul> <p><strong>Full Changelog</strong>: <a class="commit-link" href="https://snyk.io/redirect/github/recharts/recharts/compare/v2.4.3...v2.5.0"><tt>v2.4.3...v2.5.0</tt></a></p> </li> </ul> from <a href="https://snyk.io/redirect/github/recharts/recharts/releases">recharts GitHub release notes</a> </details> </details> <details> <summary><b>Commit messages</b></summary> </br> <details> <summary>Package name: <b>recharts</b></summary> <ul> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/97e263529ed2d4b2d92a3190cd58e53cf8643e94">97e2635</a> 2.6.0</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/f6767977da79f456fc02c9a1e4336213615a66e5">f676797</a> chore: upgrade storybook to latest (#3570)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/1e7618343aa7c1ace1c30d1b4ca4df24f1c9f466">1e76183</a> refactor: `PolarGrid` to function component (#3471)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/37e1c64005ea5b9dba341ef6db806a4736de7550">37e1c64</a> refactor: `Curve` to function component (#3477)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/7eabe344c3cb49c1a45bddd436731621dae7e4aa">7eabe34</a> Storybook: Add Curve API stories and doc (#3566)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/ba86ca93e6fbcfdcf7c90bd285f0b5a42ec41772">ba86ca9</a> refactor: `Cross` to component function (#3475)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/09985ef90adcb4ac23209f4844565931851d2884">09985ef</a> [a11y] Keyboard navigation support for categorical charts (#3546)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/3eac95aca94fc350ba89687dd96a8f9a633cbf31">3eac95a</a> Storybook: Add Scatter API documentation (#3560)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/f9dc04c7f8ca7d464193e1460aa0fdd973943f15">f9dc04c</a> Storybook: Add ArgsTable with description per prop to BAR component (#3558)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/de3c046f37ba3ff68b71244cab19d0bce07a8bd5">de3c046</a> fix: defaultProps of tooltip, fix viewBox (#3554)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/a651f2cc5fad913853c8a6704ea62416742f26e3">a651f2c</a> fix(storybook): delay snapshot tests past animation time for consiste… (#3550)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/0b231b703bc7636795e4667c4b0db86b76eb26a6">0b231b7</a> refactor: tooltip to function component (#3336)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/e0f7d52f613df3f1c1b8c2e75cc271f92bdec76c">e0f7d52</a> Storybook: adjust arg table of ReferenceLine (#3530)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/a32f1ee85ecae4ccf18cd3352f164a707c737f03">a32f1ee</a> fix: cross storybook build (#3543)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/59669871ba1806f121960df2f0ef2be690c964b1">5966987</a> Add storybook examples for charts with fill patterns (#3541)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/1720700034b51bf319e96a78c014356beea4b8a8">1720700</a> Storybook: Add story for Cross (#3539)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/3da03cf176519d4b4aa60ca370a607848d67ed51">3da03cf</a> Address React syntax error message on Storybook welcome page (#3540)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/1058d1ca6850c3b38db73f9e23769996f0eb92a4">1058d1c</a> Storybook: add accessibility addon (#3535)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/7cf9fbc2215e0d3d5efe80e37fdd724a60e4bb84">7cf9fbc</a> Storybook: add args table to `CartesianAxis` (#3514)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/d043fc4045da1a047c6dffe399683bde7620b6d0">d043fc4</a> Storybook: Improve ArgsTables of api/chart stories (#3534)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/c6aeae53a3a97b68028475a7e1c035e1f8eb2a0e">c6aeae5</a> Storybook: Upgrade to 7.0.5 (#3531)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/77b7083b71f98fcda828f6d7da3ff9fae788ee33">77b7083</a> Storybook: add args table to `ComposedChart` (#3518)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/b9acdb148a5076e5208a06e8358bf504467aa2ca">b9acdb1</a> Storybook: add args table to `LineChart` (#3521)</li> <li><a href="https://snyk.io/redirect/github/recharts/recharts/commit/84664411421c132b6f537800ed58941a9688254b">8466441</a> Storybook: add args table to `RadarBarChart` (#3524)</li> </ul> <a href="https://snyk.io/redirect/github/recharts/recharts/compare/3e31520ce0a71dc48532f996900250396a135bcd...97e263529ed2d4b2d92a3190cd58e53cf8643e94">Compare</a> </details> </details> <hr/> **Note:** *You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.* For more information: <img src="https://api.segment.io/v1/pixel/track?data=eyJ3cml0ZUtleSI6InJyWmxZcEdHY2RyTHZsb0lYd0dUcVg4WkFRTnNCOUEwIiwiYW5vbnltb3VzSWQiOiI4ODM0YmI0Mi0xNzJkLTQxZGMtOGI2NC1lNTNlNGVlMDVkNGEiLCJldmVudCI6IlBSIHZpZXdlZCIsInByb3BlcnRpZXMiOnsicHJJZCI6Ijg4MzRiYjQyLTE3MmQtNDFkYy04YjY0LWU1M2U0ZWUwNWQ0YSJ9fQ==" width="0" height="0"/> 🧐 [View latest project report](https://app.snyk.io/org/scudette/project/76f4d127-566b-42ef-86f4-bdcbc92b90b4?utm_source=github&utm_medium=referral&page=upgrade-pr) 🛠 [Adjust upgrade PR settings](https://app.snyk.io/org/scudette/project/76f4d127-566b-42ef-86f4-bdcbc92b90b4/settings/integration?utm_source=github&utm_medium=referral&page=upgrade-pr) 🔕 [Ignore this dependency or unsubscribe from future upgrade PRs](https://app.snyk.io/org/scudette/project/76f4d127-566b-42ef-86f4-bdcbc92b90b4/settings/integration?pkg=recharts&utm_source=github&utm_medium=referral&page=upgrade-pr#auto-dep-upgrades)

ckifer requested changes Mar 21, 2023

View reviewed changes

Comment thread .eslintrc

akamfoad added 2 commits March 22, 2023 11:42

replace: JSDoc with regular comment

2388ad0

akamfoad force-pushed the refactor/polar-grid-component branch from d2d9d2b to 2388ad0 Compare March 22, 2023 08:53

ckifer added the refactor PRs that refactor existing code label Mar 31, 2023

ckifer approved these changes May 4, 2023

View reviewed changes

ckifer merged commit 1e76183 into recharts:master May 5, 2023

Uh oh!

Uh oh!

Conversation

akamfoad commented Mar 21, 2023

Description

rm: JSDoc eslint rule in favor of typescript

refactor: PolarGrid to function component

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

ckifer commented Mar 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ckifer left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ckifer commented Mar 22, 2023

Uh oh!

akamfoad commented Mar 23, 2023

Uh oh!

ckifer commented Mar 23, 2023

Uh oh!

nikolasrieble commented May 3, 2023

Uh oh!

akamfoad commented May 4, 2023

Uh oh!

ckifer left a comment

Choose a reason for hiding this comment

Uh oh!

ckifer May 4, 2023

Choose a reason for hiding this comment

Uh oh!

akamfoad May 5, 2023

Choose a reason for hiding this comment

Uh oh!

akamfoad commented May 5, 2023

On master

On akamfoad:refactor/polar-grid-component

Diff

Uh oh!

ckifer commented May 5, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

refactor: `PolarGrid` to function component

ckifer commented Mar 21, 2023 •

edited

Loading

On `master`

On `akamfoad:refactor/polar-grid-component`

`Diff`