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

Components: Add optional hover support to the IconTooltip component #39916

Merged
merged 2 commits into from
Nov 6, 2024

Conversation

nateweller
Copy link
Contributor

@nateweller nateweller commented Oct 27, 2024

Originally removed in #26457, this PR restores the ability for IconTooltip components to show the tooltip on hover (enabled by a newhoverShow prop).

This change came from @dkmyta while working on #39754. We're hoping that by adding hover support to this component, we can use it in Jetpack Protect as well as in other scan components.

Proposed changes:

  • Adds an optional hoverShow prop to the IconTooltip component.
  • Registers onMouseEnter and onMouseLeave event listeners, which show and hide the tooltip when hoverShow is enabled.
  • Uses a timeout to provide a short delay before hiding the tooltip on mouse leave.

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

https://github.com/Automattic/jetpack-scan-team/issues/1475

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

No

Testing instructions:

  • Review and test the IconTooltip component's storybooks: cd projects/js-packages/storybook && npm run storybook:dev

Screenshots:

Screenshot 2024-10-27 at 1 54 46 PM

@nateweller nateweller added the [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it label Oct 27, 2024
Copy link
Contributor

github-actions bot commented Oct 27, 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 update/components/icon-tooltip-hover 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 update/components/icon-tooltip-hover
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/components/icon-tooltip-hover
    

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

github-actions bot commented Oct 27, 2024

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 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!

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Oct 27, 2024
@nateweller nateweller added [Status] Needs Team Review and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Oct 27, 2024
@nateweller nateweller requested review from jsnmoon, thingalon, a team and dognose24 October 27, 2024 19:46
@nateweller nateweller force-pushed the update/components/icon-tooltip-hover branch from 81d25c6 to 18277d1 Compare October 28, 2024 20:55
@nateweller nateweller force-pushed the update/components/icon-tooltip-hover branch from 18277d1 to 0802197 Compare October 29, 2024 16:46
Copy link
Contributor

@jsnmoon jsnmoon left a comment

Choose a reason for hiding this comment

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

Looks good and works well 👍

@nateweller nateweller merged commit 449cd07 into trunk Nov 6, 2024
73 checks passed
@nateweller nateweller deleted the update/components/icon-tooltip-hover branch November 6, 2024 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[JS Package] Components RNA [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.

3 participants