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

ThreatFixerButton: Add tooltips #40065

Closed
wants to merge 25 commits into from

Conversation

dkmyta
Copy link
Contributor

@dkmyta dkmyta commented Nov 5, 2024

Description

Adds tooltips for the various states of the ThreatFixerButton component, as per designs.

Something to consider: Does this cover ever potential threat/fixer option?

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?

  • No

Testing instructions:

  • Checkout this branch
  • Load storybook with cd projects/js-packages/storybook && npm run storybook:dev
  • View the Threats Fixer Button and the Threats Data Views component
  • Review the various button states and ensure they display and react according to designs
  • Review the code and ensure the implementation is correct

Screenshots

Screen Shot on 2024-11-06 at 14-52-12

Screen Shot on 2024-11-06 at 14-40-10

Screen Shot on 2024-11-06 at 14-40-29

Screen Shot on 2024-11-06 at 14-40-49

Screen Shot on 2024-11-06 at 14-41-15

Screen Shot on 2024-11-06 at 14-41-38 (1)

Screen Shot on 2024-11-06 at 14-42-03

Screen Shot on 2024-11-06 at 14-42-25

Screen Shot on 2024-11-06 at 14-42-55

Screen Shot on 2024-11-06 at 14-43-17

Screen Shot on 2024-11-06 at 14-43-35

Screen Shot on 2024-11-06 at 14-52-43

Screen Shot on 2024-11-06 at 14-44-35

Copy link
Contributor

github-actions bot commented Nov 5, 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!

Copy link
Contributor

github-actions bot commented Nov 6, 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/components/threat-fixer-button-tooltips 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/components/threat-fixer-button-tooltips
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/components/threat-fixer-button-tooltips
    

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

Base automatically changed from add/components/threats-data-view to trunk November 6, 2024 16:33
@dkmyta dkmyta self-assigned this Nov 6, 2024
@dkmyta dkmyta marked this pull request as ready for review November 7, 2024 16:38
@nateweller nateweller self-requested a review November 8, 2024 18:05
Copy link
Contributor

@nateweller nateweller left a comment

Choose a reason for hiding this comment

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

The hover-able area is rendering below the actual button:

Screenshot 2024-11-08 at 11 08 33 AM

@nateweller
Copy link
Contributor

nateweller commented Nov 8, 2024

The designs appear to use the Tooltip component from @wordpress/components. Could we use that component directly?

https://wordpress.github.io/gutenberg/?path=/docs/components-tooltip--docs

image

@dkmyta
Copy link
Contributor Author

dkmyta commented Nov 8, 2024

The hover-able area is rendering below the actual button:

In my initial testing, having the IconTooltip wrapper overlap the button will disable the button actions.

The designs appear to use the Tooltip component from @wordpress/components

I was under the impression we wanted the Tooltip hover-able, which I do not believe is a functionality of the core option.

@dkmyta
Copy link
Contributor Author

dkmyta commented Nov 12, 2024

Closing in favour of #40111

@dkmyta dkmyta closed this Nov 12, 2024
@dkmyta dkmyta deleted the add/components/threat-fixer-button-tooltips branch November 12, 2024 18:06
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