Skip to content
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

Chart Library: Add Grid #40683

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

Chart Library: Add Grid #40683

wants to merge 23 commits into from

Conversation

annacmc
Copy link
Contributor

@annacmc annacmc commented Dec 19, 2024

Proposed changes:

This PR introduces a new grid control component

Changes Made:

Dependencies:

  • Added @visx/grid to dependencies.

Component:

  • Created a new grid control component

Storybook:

  • Adds a new storybook + stories to demonstrate usage of grid
  • Adds the new grid component to the barchart and makes it available on all

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:

  • Run pnpm install as dependencies have been added

  • In your Jetpack local env, navigate to the Storybook development environment:

    pnpm i
    cd projects/js-packages/storybook
    pnpm run storybook:dev
    
  • Find JS Packages/Charts/Grid Control in the sidebar

  • Verify the grids:

    • Renders correctly with sample data
    • Responds to different data sets via Storybook controls x,y,xy, and none
  • Find JS Packages/Charts/Bar Chart in the sidebar

    • check the bar chart renders with the new grid controls

@annacmc annacmc self-assigned this Dec 19, 2024
Copy link
Contributor

github-actions bot commented Dec 19, 2024

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 WordPress.com Simple 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, and enable the add/charts-library-grids branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.
  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack add/charts-library-grids
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/charts-library-grids
    

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

Copy link
Contributor

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 Team 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 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

@annacmc annacmc requested a review from grzegorz-cp December 19, 2024 12:00
@annacmc annacmc marked this pull request as ready for review December 22, 2024 21:00
@annacmc
Copy link
Contributor Author

annacmc commented Dec 23, 2024

Temporary any types were added to the grid control scale props with TODO comments, addressing type conflicts between ScaleBand (bar charts) and ScaleLinear (line charts) in visx.

Our previous approaches, including specific scale types, union types, and generic D3Scale types, either restricted reusability, caused further conflicts, or introduced unnecessary dependencies.

This interim solution (any types) ensures flexibility across chart types while deferring a more type-safe implementation to future iterations.

grzegorz-cp
grzegorz-cp previously approved these changes Dec 23, 2024
Copy link
Contributor

@grzegorz-cp grzegorz-cp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants