-
Notifications
You must be signed in to change notification settings - Fork 836
Charts: Simplify PieSemiCircleChart API to use children composition #45369
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
Draft
annacmc
wants to merge
5
commits into
trunk
Choose a base branch
from
charts-65-iterate-over-pie-and-piesemicircle-composition
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
b08ca0d
Remove label and note props from PieSemiCircleChart
annacmc a898fbe
Update PieSemiCircleChart test to use children composition
annacmc 0fa5155
Update PieSemiCircleChart stories to use children composition
annacmc baf39ee
Update chart-context stories to use PieSemiCircleChart children
annacmc 21d2e47
changelog
annacmc File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
4 changes: 4 additions & 0 deletions
4
...cts/js-packages/charts/changelog/charts-65-iterate-over-pie-and-piesemicircle-composition
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| Significance: minor | ||
| Type: changed | ||
|
|
||
| Charts: improve pie semi circle chart composition | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,7 +1,6 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||
| import { localPoint } from '@visx/event'; | ||||||||||||||||||||||||||||||||||||||||||||||||
| import { Group } from '@visx/group'; | ||||||||||||||||||||||||||||||||||||||||||||||||
| import { Pie } from '@visx/shape'; | ||||||||||||||||||||||||||||||||||||||||||||||||
| import { Text } from '@visx/text'; | ||||||||||||||||||||||||||||||||||||||||||||||||
| import { useTooltip, useTooltipInPortal } from '@visx/tooltip'; | ||||||||||||||||||||||||||||||||||||||||||||||||
| import clsx from 'clsx'; | ||||||||||||||||||||||||||||||||||||||||||||||||
| import { useCallback, useContext, useMemo } from 'react'; | ||||||||||||||||||||||||||||||||||||||||||||||||
|
|
@@ -46,18 +45,9 @@ export interface PieSemiCircleChartProps extends BaseChartProps< DataPointPercen | |||||||||||||||||||||||||||||||||||||||||||||||
| */ | ||||||||||||||||||||||||||||||||||||||||||||||||
| clockwise?: boolean; | ||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||
| /** | ||||||||||||||||||||||||||||||||||||||||||||||||
| * Label text to display above the chart | ||||||||||||||||||||||||||||||||||||||||||||||||
| */ | ||||||||||||||||||||||||||||||||||||||||||||||||
| label?: string; | ||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||
| /** | ||||||||||||||||||||||||||||||||||||||||||||||||
| * Note text to display below the label | ||||||||||||||||||||||||||||||||||||||||||||||||
| */ | ||||||||||||||||||||||||||||||||||||||||||||||||
| note?: string; | ||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||
| /** | ||||||||||||||||||||||||||||||||||||||||||||||||
| * Use the children prop to render additional elements on the chart. | ||||||||||||||||||||||||||||||||||||||||||||||||
| * Supports composition API with PieSemiCircleChart.SVG and PieSemiCircleChart.HTML components. | ||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||
| * Supports composition API with PieSemiCircleChart.SVG and PieSemiCircleChart.HTML components. | |
| * Supports composition API with PieSemiCircleChart.SVG and PieSemiCircleChart.HTML components. | |
| * | |
| * Usage examples: | |
| * 1. Render a title/note via children (Group/Text): | |
| * <PieSemiCircleChart ...> | |
| * <Group> | |
| * <Text x={width / 2} y={height / 2} textAnchor="middle"> | |
| * Chart Title | |
| * </Text> | |
| * </Group> | |
| * </PieSemiCircleChart> | |
| * | |
| * 2. Render a title/note via the SVG compound component: | |
| * <PieSemiCircleChart ...> | |
| * <PieSemiCircleChart.SVG> | |
| * <Group> | |
| * <Text x={width / 2} y={height / 2} textAnchor="middle"> | |
| * Chart Title | |
| * </Text> | |
| * </Group> | |
| * </PieSemiCircleChart.SVG> | |
| * </PieSemiCircleChart> |
Copilot uses AI. Check for mistakes.
Positive FeedbackNegative Feedback
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| import { render, screen, waitFor } from '@testing-library/react'; | ||
| import userEvent from '@testing-library/user-event'; | ||
| import { Group } from '@visx/group'; | ||
| import { Text } from '@visx/text'; | ||
| import { act } from 'react'; | ||
| import { GlobalChartsProvider } from '../../../providers'; | ||
| import PieSemiCircleChart from '../pie-semi-circle-chart'; | ||
|
|
@@ -35,13 +37,23 @@ describe( 'PieSemiCircleChart', () => { | |
| expect( segments ).toHaveLength( 2 ); | ||
| } ); | ||
|
|
||
| it( 'renders label and note when provided', () => { | ||
| const label = 'Chart Title'; | ||
| const note = 'Additional Info'; | ||
| renderPieChart( { data: mockData, label, note } ); | ||
| it( 'renders custom children content', () => { | ||
| renderPieChart( { | ||
| data: mockData, | ||
| children: ( | ||
| <Group> | ||
| <Text textAnchor="middle" y={ -40 }> | ||
| Chart Title | ||
| </Text> | ||
| <Text textAnchor="middle" y={ -20 }> | ||
| Additional Info | ||
| </Text> | ||
| </Group> | ||
| ), | ||
| } ); | ||
|
|
||
| expect( screen.getByText( label ) ).toBeInTheDocument(); | ||
| expect( screen.getByText( note ) ).toBeInTheDocument(); | ||
| expect( screen.getByText( 'Chart Title' ) ).toBeInTheDocument(); | ||
| expect( screen.getByText( 'Additional Info' ) ).toBeInTheDocument(); | ||
| } ); | ||
|
|
||
| it( 'shows legend when showLegend is true', () => { | ||
|
|
@@ -178,4 +190,89 @@ describe( 'PieSemiCircleChart', () => { | |
| ).toBeInTheDocument(); | ||
| } ); | ||
| } ); | ||
|
|
||
| describe( 'Composition API', () => { | ||
| it( 'renders children with SVG content', () => { | ||
| renderPieChart( { | ||
| data: mockData, | ||
| children: ( | ||
| <Group> | ||
| <Text textAnchor="middle" y={ -40 }> | ||
| Custom Title | ||
| </Text> | ||
| </Group> | ||
| ), | ||
| } ); | ||
|
|
||
| expect( screen.getByText( 'Custom Title' ) ).toBeInTheDocument(); | ||
| } ); | ||
|
|
||
| it( 'renders PieSemiCircleChart.SVG compound component', () => { | ||
| render( | ||
| <GlobalChartsProvider> | ||
| <PieSemiCircleChart data={ mockData }> | ||
| <PieSemiCircleChart.SVG> | ||
| <Group> | ||
| <Text textAnchor="middle" y={ -50 }> | ||
| SVG Component Title | ||
| </Text> | ||
| </Group> | ||
| </PieSemiCircleChart.SVG> | ||
| </PieSemiCircleChart> | ||
| </GlobalChartsProvider> | ||
| ); | ||
|
Comment on lines
+210
to
+223
|
||
|
|
||
| expect( screen.getByText( 'SVG Component Title' ) ).toBeInTheDocument(); | ||
| } ); | ||
|
|
||
| it( 'renders PieSemiCircleChart.HTML compound component', () => { | ||
| render( | ||
| <GlobalChartsProvider> | ||
| <PieSemiCircleChart data={ mockData }> | ||
| <PieSemiCircleChart.HTML> | ||
| <div data-testid="html-content">HTML Content</div> | ||
| </PieSemiCircleChart.HTML> | ||
| </PieSemiCircleChart> | ||
| </GlobalChartsProvider> | ||
| ); | ||
|
|
||
| expect( screen.getByTestId( 'html-content' ) ).toBeInTheDocument(); | ||
| expect( screen.getByText( 'HTML Content' ) ).toBeInTheDocument(); | ||
| } ); | ||
|
|
||
| it( 'renders mixed SVG and HTML compound components', () => { | ||
| render( | ||
| <GlobalChartsProvider> | ||
| <PieSemiCircleChart data={ mockData }> | ||
| <PieSemiCircleChart.SVG> | ||
| <Group> | ||
| <Text textAnchor="middle" y={ -50 }> | ||
| SVG Title | ||
| </Text> | ||
| </Group> | ||
| </PieSemiCircleChart.SVG> | ||
| <PieSemiCircleChart.HTML> | ||
| <div data-testid="footer">Chart Footer</div> | ||
| </PieSemiCircleChart.HTML> | ||
| </PieSemiCircleChart> | ||
| </GlobalChartsProvider> | ||
| ); | ||
|
|
||
| expect( screen.getByText( 'SVG Title' ) ).toBeInTheDocument(); | ||
| expect( screen.getByTestId( 'footer' ) ).toBeInTheDocument(); | ||
| } ); | ||
|
|
||
| it( 'renders Legend as compound component', () => { | ||
| render( | ||
| <GlobalChartsProvider> | ||
| <PieSemiCircleChart data={ mockData }> | ||
| <PieSemiCircleChart.Legend orientation="horizontal" /> | ||
| </PieSemiCircleChart> | ||
| </GlobalChartsProvider> | ||
| ); | ||
|
|
||
| expect( screen.getByText( 'Category A' ) ).toBeInTheDocument(); | ||
| expect( screen.getByText( 'Category B' ) ).toBeInTheDocument(); | ||
| } ); | ||
| } ); | ||
| } ); | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing the label and note props is a breaking API change. Please mark this as a breaking change in the changelog (e.g., Significance: major and/or Type: breaking-change) and include a brief migration note showing how to render labels via children (Group/Text or PieSemiCircleChart.SVG).
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think the semi-circle chart
labelandnoteprops are currently being used by any consumers, so I don't think it needs to be a significant/major change in the changelog. I'm open to having my mind changed on this, but at this time I don't think this feedback is necessary.