Charts: Add TrendIndicator component
Closes CHARTS-144
Proposed changes:
- Add new
TrendIndicatorcomponent for displaying directional trends with values - Support three directions:
up(green),down(red),neutral(gray) - Include arrow icon for up/down directions, no icon for neutral
- Export component and types from main package entry
- Add package.json export paths for tree-shaking support
Other information:
- [x] Have you written new tests for your changes, if applicable?
- [x] 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)?
Does this pull request change what data or activity we track or use?
No, it does not.
Testing instructions:
- Go to Storybook -> Charts -> Components -> Trend Indicator
- Test the three stories:
-
Up: Should display green arrow pointing up with "+14%" -
Down: Should display red arrow pointing down with "-5%" -
Neutral: Should display gray text "0%" with no icon
-
- Verify the component accepts
classNameandstyleprops for customization - Run tests:
pnpm test -- src/components/trend-indicator - Build package:
pnpm buildand verify trend-indicator outputs are generated
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-new-trend-indicatorbranch. - To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack add/charts-new-trend-indicator
Interested in more tips and information?
- In your local development environment, use the
jetpack rsynccommand 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
Thank you for your PR!
When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:
- :white_check_mark: Include a description of your PR changes.
- :white_check_mark: Add a "[Status]" label (In Progress, Needs Review, ...).
- :white_check_mark: Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
- :white_check_mark: Add testing instructions.
- :white_check_mark: Specify whether this PR includes any changes to data or privacy.
- :white_check_mark: 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 :robot:
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!
Code Coverage Summary
3 files are newly checked for coverage.
| File | Coverage |
|---|---|
| projects/js-packages/charts/src/components/trend-indicator/trend-indicator.tsx | 8/8 (100.00%) 💚 |
| projects/js-packages/charts/src/components/trend-indicator/index.ts | 0/0 (—%) 🤷 |