Leaderboard chart: make theming consistent with other charts #45067

adamwoodnz · 2025-09-04T04:33:04Z

Fixes CHARTS-110: Leaderboard Chart: Make theming consistent with other charts

Proposed changes:

Updates the LeaderboardChart component to support Global Context theming, making it consistent with other chart types
Custom colors are still supported
Updates the shipped themes to better align with Woo Analytics and expectations for the default theme

Screenshots

Leaderboard	Chart Context

Other information:

Have you written new tests for your changes, if applicable?
Have you checked the E2E test CI results, and verified that your changes do not break them?
Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Go to http://localhost:50240/?path=/story/js-packages-charts-types-leaderboard-chart--default
Browse the stories and use the themeName control to switch theme
Do the same for the context stories http://localhost:50240/?path=/story/js-packages-charts-chart-context--default and http://localhost:50240/?path=/story/js-packages-charts-chart-context--with-color-overrides (LeaderboardChart doesn't have group functionality so those controls don't change anything)

github-actions · 2025-09-04T04:33:59Z

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack), and enable the charts-110-leaderboard-chart-make-theming-consistent-with-other-charts branch.
To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack charts-110-leaderboard-chart-make-theming-consistent-with-other-charts

Interested in more tips and information?

In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
Read more about our development workflow here: PCYsg-eg0-p2
Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

github-actions · 2025-09-04T04:34:11Z

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

✅ Include a description of your PR changes.
✅ Add a "[Status]" label (In Progress, Needs Review, ...).
✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
✅ Add testing instructions.
✅ Specify whether this PR includes any changes to data or privacy.
✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

Follow this PR Review Process:

Ensure all required checks appearing at the bottom of this PR are passing.
Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
You can use GitHub's Reviewers functionality to request a review.
When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

adamwoodnz · 2025-09-04T04:36:13Z

projects/js-packages/charts/src/components/leaderboard-chart/leaderboard-chart.module.scss

-		background-color: var(--bar-color, #3858e9);
-
-		border-radius: var(--bar-border, 9999px);
+		border-radius: var(--a8c--charts--leaderboard--bar--border-radius, 9999px);


Namespace this custom var to avoid conflicts due to generic naming. Pattern follows that used in WordPress components.

jp-launch-control · 2025-09-04T04:45:58Z

Code Coverage Summary

Coverage changed in 2 files.

File	Coverage	Δ%	Δ Uncovered
projects/js-packages/charts/src/components/leaderboard-chart/leaderboard-chart.tsx	24/25 (96.00%)	-4.00%	1 ❤️‍🩹
projects/js-packages/charts/src/providers/chart-context/global-charts-provider.tsx	33/33 (100.00%)	0.00%	0 💚

Full summary · PHP report · JS report

adamwoodnz · 2025-09-04T04:50:14Z

projects/js-packages/charts/src/components/leaderboard-chart/leaderboard-chart.module.scss

-	.primaryBar {
-		--bar-color: var(--primary-color, #3858e9);
-	}
-
-	.secondaryBar {
-		--bar-color: var(--secondary-color, #66bdff);
-	}


These fallback colors are not consistent with the default theme (which is based on Jetpack colors), and the CSS approach isn't used elsewhere. I could see us using Design System variables (like --wpds--background--primary...) in future, but for now I think consistency is more important.

adamwoodnz · 2025-09-04T04:52:25Z

projects/js-packages/charts/src/components/leaderboard-chart/stories/index.stories.tsx

@@ -452,41 +439,6 @@ export const AdvancedFormatting: Story = {
 	},
 };

-// Themed stories


The themeName control works for all stories now, so these are redundant

adamwoodnz · 2025-09-04T04:54:32Z

projects/js-packages/charts/src/providers/theme/themes.ts

-		primaryColor: '#3858E9',
-		secondaryColor: '#80C8FF',
-		deltaColors: [ '#D63638', '#757575', '#008A20' ], // [negative, neutral, positive]
+		primaryColor: '#006DAB',
+		secondaryColor: '#98C8DF',
+		deltaColors: [ '#FF8C8F', '#757575', '#1F9828' ], // [negative, neutral, positive]


Changing these from the Woo colors to the Jetpack colors, to match the rest of the default theme colors. They look very out of place when all charts are using the same theme.

adamwoodnz · 2025-09-04T04:55:49Z

projects/js-packages/charts/src/providers/theme/themes.ts

+	colors: [
+		'#3858E9', // WooCommerce brand blue
+		'#66BDFF', // Light blue
+		'#873EFF', // Purple
+		'#7B90FF', // Periwinkle blue
+		'#EB6594', // Pink/rose
+	],


These are the colors from Next Woo Analytics, with the second and third colors switched, as the light blue seems to be the true secondary color looking at the widgets there.

Copilot

Pull Request Overview

This PR updates the LeaderboardChart component to use the Global Context theming system, making it consistent with other chart components. The change enables automatic theme integration while maintaining support for custom color overrides.

Updates LeaderboardChart to support Global Context theming and Legend composition
Modifies default theme colors to better align with Woo Analytics expectations
Removes hardcoded color values and integrates with the centralized theme system

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
leaderboard-chart.tsx	Refactored to use GlobalChartsProvider and resolveGroupColor for theme integration
leaderboard-chart.module.scss	Simplified CSS by removing color-specific classes and using inline styles
themes.ts	Updated default theme colors for leaderboard and expanded Woo theme color palette
stories/index.stories.tsx	Removed hardcoded colors from stories to demonstrate theme integration
theme-config.tsx	Added leaderboard theme configuration to custom theme example
chart-context/stories/index.stories.tsx	Added LeaderboardChart examples to chart context stories
changelog	Added changelog entry documenting the theme integration change

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

projects/js-packages/charts/src/components/leaderboard-chart/leaderboard-chart.tsx

adamwoodnz · 2025-09-04T22:39:44Z

projects/js-packages/charts/src/providers/chart-context/global-charts-provider.tsx

@@ -18,7 +19,7 @@ export const GlobalChartsProvider: FC< GlobalChartsProviderProps > = ( {
 } ) => {
 	const [ charts, setCharts ] = useState< Map< string, ChartRegistration > >( () => new Map() );

-	const providerTheme: ChartTheme = useMemo( () => ( { ...defaultTheme, ...theme } ), [ theme ] );
+	const providerTheme: ChartTheme = useMemo( () => mergeThemes( defaultTheme, theme ), [ theme ] );


Using a deepmerge ensures nested properties are preserved

adamwoodnz · 2025-09-04T22:40:30Z

projects/js-packages/charts/src/components/leaderboard-chart/leaderboard-chart.tsx

-/**
- * Default settings for LeaderboardChart component
- */
-const DEFAULT_LEADERBOARD_SETTINGS = {


These are guaranteed to come from the theme now that we're using the global theme

Co-authored-by: Copilot <[email protected]>

annacmc

Looking good and tests out well for me, love it! Just one small non-blocking question but otherwise nice job. Always a great feeling to remove more lines than you add 😄

annacmc · 2025-09-04T22:52:54Z

projects/js-packages/charts/src/components/leaderboard-chart/stories/index.stories.tsx

 		withComparison: true,
 		withOverlayLabel: true,
 		loading: false,
+		primaryColor: '#ddd',


Not a blocker, just curious to understand why we aren't using one of the default theme colours for the primaryColor here?

Yeah good question, the story needs a neutral or low opacity color to look good and I couldn't find one in the palette. Updated now to use a tint of the primary color like the design.

…ies defined

adamwoodnz changed the title ~~Charts 110 leaderboard chart make theming consistent with other charts~~ Leaderboard chart: make theming consistent with other charts Sep 4, 2025

adamwoodnz self-assigned this Sep 4, 2025

github-actions bot added [JS Package] Charts [Status] In Progress RNA labels Sep 4, 2025

github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Sep 4, 2025

adamwoodnz commented Sep 4, 2025

View reviewed changes

adamwoodnz force-pushed the charts-110-leaderboard-chart-make-theming-consistent-with-other-charts branch from 0717309 to f96d339 Compare September 4, 2025 04:47

adamwoodnz commented Sep 4, 2025

View reviewed changes

adamwoodnz added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it and removed [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Sep 4, 2025

adamwoodnz force-pushed the charts-110-leaderboard-chart-make-theming-consistent-with-other-charts branch 2 times, most recently from 771975c to db03cd6 Compare September 4, 2025 05:28

adamwoodnz requested a review from Copilot September 4, 2025 05:30

Copilot AI reviewed Sep 4, 2025

View reviewed changes

projects/js-packages/charts/src/components/leaderboard-chart/leaderboard-chart.tsx Show resolved Hide resolved

projects/js-packages/charts/src/components/leaderboard-chart/leaderboard-chart.tsx Outdated Show resolved Hide resolved

github-actions bot added the [Tests] Includes Tests label Sep 4, 2025

adamwoodnz commented Sep 4, 2025

View reviewed changes

adamwoodnz marked this pull request as ready for review September 4, 2025 22:46

adamwoodnz requested a review from a team September 4, 2025 22:46

adamwoodnz added 4 commits September 5, 2025 10:49

Use global chart context theme for LeaderboardChart colors

fd46e0f

Add changelog

e7f13e3

Update docs

63b062f

Revert adding composition api and responsive config

4b506aa

adamwoodnz and others added 5 commits September 5, 2025 10:49

Tidy up export

d1a36b3

Co-authored-by: Copilot <[email protected]>

Update image story color

4de7bc7

Fix test import

e4f5df4

Remove default settings now that they are guaranteed to come from theme

c80562a

Use deep merging for global context theme for consistency

d54f825

adamwoodnz force-pushed the charts-110-leaderboard-chart-make-theming-consistent-with-other-charts branch from e854358 to d54f825 Compare September 4, 2025 22:49

annacmc added the [Status] Needs Review This PR is ready for review. label Sep 4, 2025

annacmc previously approved these changes Sep 4, 2025

View reviewed changes

Revert updating Woo theme and instead update leaderboard chart settings

835f9dc

adamwoodnz dismissed annacmc’s stale review via 835f9dc September 4, 2025 23:32

adamwoodnz added 4 commits September 5, 2025 11:45

Rename settings colors for clarity

0f870f9

Update global context types to express that the theme has all propert…

d33a18e

…ies defined

Add remaining global context exports

a5845fe

Use a tint of the primary color in the label with image story

1305779

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Leaderboard chart: make theming consistent with other charts #45067

Leaderboard chart: make theming consistent with other charts #45067

Uh oh!

adamwoodnz commented Sep 4, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Sep 4, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Sep 4, 2025 •

edited

Loading

Uh oh!

adamwoodnz Sep 4, 2025

Uh oh!

jp-launch-control bot commented Sep 4, 2025 •

edited

Loading

Uh oh!

adamwoodnz Sep 4, 2025

Uh oh!

adamwoodnz Sep 4, 2025

Uh oh!

adamwoodnz Sep 4, 2025

Uh oh!

adamwoodnz Sep 4, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

adamwoodnz Sep 4, 2025

Uh oh!

adamwoodnz Sep 4, 2025

Uh oh!

annacmc left a comment

Uh oh!

annacmc Sep 4, 2025

Uh oh!

adamwoodnz Sep 5, 2025

Uh oh!

Uh oh!

Leaderboard chart: make theming consistent with other charts #45067

Are you sure you want to change the base?

Leaderboard chart: make theming consistent with other charts #45067

Uh oh!

Conversation

adamwoodnz commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes:

Screenshots

Other information:

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Uh oh!

github-actions bot commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jp-launch-control bot commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Coverage Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

annacmc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

adamwoodnz commented Sep 4, 2025 •

edited

Loading

github-actions bot commented Sep 4, 2025 •

edited

Loading

github-actions bot commented Sep 4, 2025 •

edited

Loading

jp-launch-control bot commented Sep 4, 2025 •

edited

Loading