Charts- 81: Leaderboard chart supports custom label for greater flexibility. #44751

halfo · 2025-08-12T09:16:14Z

Proposed changes:

We can pass a JSX.Element as label to enable more customization. It’s common for labels to include pre/post icons, custom styles etc. This approach makes the label for customizable and flexible.

Added another boolean prop withOverlayLabel which overlays the label on top of each corresponding bar.
- Image with custom label and withOverlayLabel.
- Image with withOverlayLabel and withComparison.
- Image with withOverlayLabel.

Note that the --bar-border custom CSS property has been introduced to control the border of each bar. While a custom CSS property may be less discoverable than a prop, this is a niche use case, and we can always introduce it as a prop if needed.

Also, the bar height is determined by the label’s height, while its width is based on currentShare and the overall width of the leaderboard component.

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:

Launch the storybook for chart.
Visit http://localhost:50240/?path=/story/js-packages-charts-types-leaderboard-chart--custom-label

github-actions · 2025-08-12T09:17:07Z

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 add/charts-81-leaderboard-chart-supports-custom-label branch.
To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack add/charts-81-leaderboard-chart-supports-custom-label

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-08-12T09:17:14Z

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!

jp-launch-control · 2025-08-12T09:29:36Z

Code Coverage Summary

Coverage changed in 1 file.

File	Coverage	Δ%	Δ Uncovered
projects/js-packages/charts/src/components/leaderboard-chart/leaderboard-chart.tsx	24/25 (96.00%)	-4.00%	1 ❤️‍🩹

Full summary · PHP report · JS report

kangzj · 2025-08-14T03:42:08Z

Currently, there’s no way to change the bar’s border-radius. While it’s possible to target the bar with a CSS selector, that exposes internal implementation details. Should we support a custom CSS property like --bar-border-radius, add a dedicated prop, or both?

Happy not to add additional props and I think we don't need that at the stage. We could use the border radius in the design for bars when the pictures are in place.

Both changes in this PR were made with future requests in mind. I’m not yet sure if I’ve been overthinking this, or if I should have designed it so that providing just one or two props would give the desired output, as the following.

I prefer to start simple 🙂

image
We can achieve the ticket’s request by providing customized label, changing primary color and border radius.

Let's fully achieve that as a story to showcase it.

Nikschavan

Looks great! Added non-blocking suggestions

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

kangzj · 2025-08-14T23:34:48Z

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

+		{ typeof entry.label === 'string' ? <Text>{ entry.label }</Text> : entry.label }
+
+		<div className={ styles.progressContainer }>
+			<ProgressBar


It seems ProgressBar wouldn't satisfy the needs here, so we should probably just use our custom implementation in ProgressBarWithOverlayLabel.

Thanks @kangzj. I created this ticket to address this.

kangzj

LGTM! Nice one 👍

One nitpick:

When withOverlayLabel is true and the data has images, we probably want to the images with the start of the progress bars.

kangzj · 2025-08-14T23:38:32Z

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

+		border-radius: var(--bar-border, 9999px);
+		z-index: -1; /* places it behind the label */
+
+		transition: width 0.3s ease-in-out;


Let's not use animation yet.

halfo added 3 commits August 12, 2025 03:11

CHARTS-81: Support passing a JSX element as a label.

fd48fb4

CHARTS-81: Refactor single bar to a new component.

0ac663c

CHARTS-81: Create overlay label base component.

042dc64

github-actions bot added [JS Package] Charts [Status] In Progress RNA labels Aug 12, 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 Aug 12, 2025

halfo requested a review from a team August 13, 2025 06:35

halfo added 2 commits August 13, 2025 19:18

CHARTS-81: Style the overlay label progress bar.

c6cc3cd

CHARTS-81: Add custom label story.

d8d5cea

halfo force-pushed the add/charts-81-leaderboard-chart-supports-custom-label branch from e88773d to bd5974a Compare August 13, 2025 13:19

halfo force-pushed the add/charts-81-leaderboard-chart-supports-custom-label branch from bd5974a to fe22c94 Compare August 14, 2025 05:28

github-actions bot added the [Tests] Includes Tests label Aug 14, 2025

halfo force-pushed the add/charts-81-leaderboard-chart-supports-custom-label branch 2 times, most recently from fb3ee5a to 8f1112b Compare August 14, 2025 07:21

halfo added 2 commits August 14, 2025 13:28

CHARTS-81: Add sales by product story.

286018d

CHARTS-81: Add tests.

8b46036

halfo force-pushed the add/charts-81-leaderboard-chart-supports-custom-label branch from 8f1112b to a6f3d81 Compare August 14, 2025 07:29

halfo added the [Status] Needs Review This PR is ready for review. label Aug 14, 2025

halfo marked this pull request as ready for review August 14, 2025 09:43

halfo removed the [Status] In Progress label Aug 14, 2025

github-actions bot added [Status] In Progress and removed [Status] Needs Review This PR is ready for review. labels Aug 14, 2025

halfo added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Review This PR is ready for review. and removed [Status] In Progress labels Aug 14, 2025

halfo added 3 commits August 14, 2025 16:03

CHARTS-81: Give more control to customize a bar's border.

984c263

CHARTS-81: Fix type error.

a27099e

changelog

2aaf7f4

halfo force-pushed the add/charts-81-leaderboard-chart-supports-custom-label branch from 556cb22 to 2aaf7f4 Compare August 14, 2025 10:03

Nikschavan previously approved these changes Aug 14, 2025

View reviewed changes

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

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

CHARTS-81: Refactor story and improve naming.

6145347

halfo dismissed Nikschavan’s stale review via 6145347 August 14, 2025 12:40

CHARTS-81: Introduce WithOverlayLabel Story.

6864673

Nikschavan approved these changes Aug 14, 2025

View reviewed changes

kangzj reviewed Aug 14, 2025

View reviewed changes

kangzj approved these changes Aug 14, 2025

View reviewed changes

kangzj reviewed Aug 14, 2025

View reviewed changes

halfo merged commit 2734e4b into trunk Aug 18, 2025
86 checks passed

halfo deleted the add/charts-81-leaderboard-chart-supports-custom-label branch August 18, 2025 05:29

github-actions bot removed [Status] Needs Review This PR is ready for review. [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Aug 18, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Charts- 81: Leaderboard chart supports custom label for greater flexibility. #44751

Charts- 81: Leaderboard chart supports custom label for greater flexibility. #44751

Uh oh!

halfo commented Aug 12, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Aug 12, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Aug 12, 2025 •

edited

Loading

Uh oh!

jp-launch-control bot commented Aug 12, 2025 •

edited

Loading

Uh oh!

kangzj commented Aug 14, 2025

Uh oh!

Nikschavan left a comment

Uh oh!

Uh oh!

Uh oh!

kangzj Aug 14, 2025

Uh oh!

halfo Aug 18, 2025

Uh oh!

kangzj left a comment

Uh oh!

kangzj Aug 14, 2025

Uh oh!

Uh oh!

Uh oh!

Charts- 81: Leaderboard chart supports custom label for greater flexibility. #44751

Charts- 81: Leaderboard chart supports custom label for greater flexibility. #44751

Uh oh!

Conversation

halfo commented Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes:

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 Aug 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Code Coverage Summary

Uh oh!

kangzj commented Aug 14, 2025

Uh oh!

Nikschavan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kangzj Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

halfo Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

kangzj left a comment

Choose a reason for hiding this comment

Uh oh!

kangzj Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

halfo commented Aug 12, 2025 •

edited

Loading

github-actions bot commented Aug 12, 2025 •

edited

Loading

github-actions bot commented Aug 12, 2025 •

edited

Loading

jp-launch-control bot commented Aug 12, 2025 •

edited

Loading