Skip to content

Charts: Ensure chart and legend combined height equals the specified height prop #43844

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

Open
wants to merge 3 commits into
base: trunk
Choose a base branch
from

Conversation

chihsuan
Copy link
Member

@chihsuan chihsuan commented Jun 9, 2025

Fixes CHARTS-30

Proposed changes:

When users set the height property for line/bar charts, they expect the chart and legend to be aligned with the container height, not just the chart height.

This PR dynamically measures the legend’s height and subtracts it from the chart area when rendering <XYChart />, so the total rendered height (chart + legend) matches the specified height prop.

The enhancement fixes layout issues that occur when charts are placed in fixed-height containers. For example, when a chart is placed in a container with a fixed height, the chart and legend may exceed the container height, causing the legend to be invisible.

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:

Before:
Screenshot 2025-06-09 at 15 48 15

After:
Screenshot 2025-06-09 at 15 58 49

Vertical legend:

I initially had concerns about potential layout shifts during chart rendering, but testing shows minimal impact. However, if layout shifts become problematic, we could consider adding an optional prop allowing consumers to specify an initial legend height to minimize any initial rendering adjustments.

Screen.Recording.2025-06-09.at.16.13.31.mov

Copy link
Contributor

github-actions bot commented Jun 9, 2025

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:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. 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!

@github-actions 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 Jun 9, 2025
chihsuan added 2 commits June 9, 2025 16:16
…t for dynamic height adjustment

update grid visibility settings in useBarChartOptions; enhance BaseLegend component with forwardRef for improved ref handling.
@chihsuan chihsuan force-pushed the charts-30-linebar-chart-height-prop-does-not-account-for-legend-height branch from 3e1e85e to 39b529d Compare June 9, 2025 08:16
Copy link

jp-launch-control bot commented Jun 9, 2025

Code Coverage Summary

Coverage changed in 2 files.

File Coverage Δ% Δ Uncovered
projects/js-packages/charts/src/components/bar-chart/bar-chart.tsx 22/25 (88.00%) 0.50% 0 💚
projects/js-packages/charts/src/components/line-chart/line-chart.tsx 54/66 (81.82%) 0.28% 0 💚

1 file is newly checked for coverage.

File Coverage
projects/js-packages/charts/src/components/shared/use-element-height.ts 12/12 (100.00%) 💚

Full summary · JS report

@chihsuan chihsuan 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] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Jun 9, 2025
@chihsuan chihsuan changed the title Charts: Ensure chart and legend combined height does not exceed specified height Charts: Ensure chart and legend combined height equals the specified height prop Jun 9, 2025
@chihsuan chihsuan requested a review from a team June 9, 2025 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[JS Package] Charts RNA [Status] Needs Review This PR is ready for review. [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant