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

427 add info button and tooltip #22009

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

Conversation

vraja-pro
Copy link
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, 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:

  • Use the following patch to see the widget table in the dashboard
    info-dummy-data.patch.
  • 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

coveralls commented Jan 31, 2025

Pull Request Test Coverage Report for Build 557765baca9041e958d9ce92ff2c01e25aef83d6

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 9 (0.0%) changed or added relevant lines in 3 files are covered.
  • 3 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.004%) to 54.535%

Changes Missing Coverage Covered Lines Changed/Added Lines %
packages/js/src/dashboard/components/info-tooltip.js 0 2 0.0%
packages/js/src/dashboard/components/table-widget.js 0 2 0.0%
packages/js/src/dashboard/components/most-popular-table.js 0 5 0.0%
Files with Coverage Reduction New Missed Lines %
packages/js/src/integrations-page/recommended-integrations.js 3 0.0%
Totals Coverage Status
Change from base Build fedc1b286bb15dc44c2150ae129cd3beba01321d: -0.004%
Covered Lines: 30186
Relevant Lines: 55779

💛 - Coveralls

@pls78
Copy link
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 on lines -5 to -10

--yst-display-tooltip: none;

&:hover, &:focus-within {
--yst-display-tooltip: inline-block;
}
Copy link
Member

Choose a reason for hiding this comment

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

This variable is used in the tooltip CSS:

display: var(--yst-display-tooltip, inline-block);

import Tooltip from "../../elements/tooltip";
import { useToggleState } from "../../hooks";

const GRACE_MRGIN = 10;
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
const GRACE_MRGIN = 10;
const GRACE_MARGIN = 10;

aria-describedby={ ariaDescribedby }
aria-disabled={ true }
onMouseEnter={ show }
Copy link
Member

Choose a reason for hiding this comment

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

Should this be onPointerEnter?

@@ -38,12 +45,14 @@ Tooltip.propTypes = {
children: PropTypes.node,
className: PropTypes.string,
position: PropTypes.oneOf( Object.keys( positionClassNameMap ) ),
variant: PropTypes.oneOf( [ "dark", "light" ] ),
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
variant: PropTypes.oneOf( [ "dark", "light" ] ),
variant: PropTypes.oneOf( Object.keys( variantClassNameMap ) ),

document.removeEventListener( "pointermove", handleMouseMove );
handleMouseMove.cancel();
};
}, [ show, hide, triggerRef, tooltipPosition, isVisible ] );
Copy link
Member

Choose a reason for hiding this comment

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

I don't think triggerRef every changes. Do you mean triggerRef.current to verify the DOM node / memory address?

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