Skip to content

427 add info button and tooltip#22009

Merged
vraja-pro merged 20 commits intotrunkfrom
427-add-info-button-and-tooltip
Feb 11, 2025
Merged

427 add info button and tooltip#22009
vraja-pro merged 20 commits intotrunkfrom
427-add-info-button-and-tooltip

Conversation

@vraja-pro
Copy link
Copy Markdown
Contributor

@vraja-pro vraja-pro commented Jan 31, 2025

Context

Summary

This PR can be summarized in the following changelog entry:

  • Adds info tooltip to the table widget.
  • [@yoast/ui-library 0.1.0 enhancement] Adjusts the tooltip container component for easier movement from trigger to the tooltip
  • [@yoast/ui-library 0.1.0 enhancement] Adds light variant to the tooltip element.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Set a development environment with site kit configured.
  • Go to Yoasy SEO->General
  • Check you see the table for top 5 most popular content.
  • Check the info icon in the top right corner matches the design:
  • Hover over the icon and check you see the info tooltip as in the design.
  • Check you can easily move from the icon to the tooltip.
  • Click on the button and check the tooltip stays even when not hovering on the icon.

UI Library - Tooltip container component

  • Spin the ui library storybook
  • Check the tooltip container component.
  • Check the tooltip is visible on hover and focus.
  • Check you can easily move from the trigger to the tooltip without it disappearing.

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes Add info button and tooltip

@vraja-pro vraja-pro added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Jan 31, 2025
@vraja-pro vraja-pro requested a review from a team as a code owner January 31, 2025 13:04
@coveralls
Copy link
Copy Markdown

coveralls commented Jan 31, 2025

Pull Request Test Coverage Report for Build 5079c8b234a9132de3e4f4dd25c05b4df6549179

Details

  • 16 of 16 (100.0%) changed or added relevant lines in 4 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 54.581%

Totals Coverage Status
Change from base Build 2d39f817ad47444fce9230e581a5710e9e3958b5: 0.0%
Covered Lines: 30320
Relevant Lines: 55974

💛 - Coveralls

@pls78
Copy link
Copy Markdown
Member

pls78 commented Feb 3, 2025

CR: ✅
Acc: ⚠️

  • Shouldn't we change the mouse pointer when hovering on the info icon? If we don't I'm afraid users won't get the fact they can click it to keep the tooltip open.
  • In storybook I think there's something funky going on in the Control column:
    Screenshot 2025-02-03 at 16 50 58

Comment thread packages/js/src/dashboard/components/most-popular-table.js Outdated
vraja-pro and others added 3 commits February 4, 2025 17:34
Comment thread packages/ui-library/src/components/tooltip-container/style.css
Comment thread packages/ui-library/src/components/tooltip-container/index.js Outdated
Comment thread packages/ui-library/src/components/tooltip-container/index.js Outdated
Comment thread packages/ui-library/src/elements/tooltip/index.js Outdated
Comment thread packages/ui-library/src/components/tooltip-container/index.js Outdated
@github-actions
Copy link
Copy Markdown

A merge conflict has been detected for the proposed code changes in this PR. Please resolve the conflict by either rebasing the PR or merging in changes from the base branch.

@github-actions
Copy link
Copy Markdown

A merge conflict has been detected for the proposed code changes in this PR. Please resolve the conflict by either rebasing the PR or merging in changes from the base branch.

Comment thread packages/ui-library/src/elements/tooltip/style.css Outdated
Copy link
Copy Markdown
Member

@pls78 pls78 left a comment

Choose a reason for hiding this comment

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

CR && Acc: ✅
I still have two minor things:
In the storybook, is it ok for the tooltip in the tooltip container to be like this (i.e. light on light)?
Screenshot 2025-02-11 at 12 45 43
2. . The Control column still seems off to me: is this how it should be?
Screenshot 2025-02-03 at 16 50 58

@vraja-pro vraja-pro merged commit 1859287 into trunk Feb 11, 2025
@vraja-pro vraja-pro deleted the 427-add-info-button-and-tooltip branch February 11, 2025 12:42
@vraja-pro vraja-pro added this to the 24.6 milestone Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants