Skip to content

Adjusts the popover component #22326

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

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

Conversation

Jordi-PV
Copy link
Contributor

@Jordi-PV Jordi-PV commented Jun 2, 2025

Context

  • To apply improvements to the popover component previously added to the ui-library by this PR.

Summary

This PR can be summarized in the following changelog entry:

  • [@yoast/ui-library non-user-facing] Improves the popover component in the ui-library.

Relevant technical choices:

  • The wai-aria attributes have been removed and can be added by the user by means of the spread props.
  • The style rules to position the popover for RTL apply the mirroring layout behaviour, flipping the position of the popover (see the desing file).
  • The popover component is a state controlled component (meaning the parent component (ie button) owns the visibility state and decides when the popover should be shown.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Checkout to this branch in the wordpress-seo repo.
  • In your terminal run: yarn workspace @yoast/ui-library storybook to open the storybook on your local server.
  • Under the Components section on the left sidebar, look for the Popover component.
  • Click the Show code button at the bottom-right side of the 'Docs' page to see the React code for the component.
    image
  • Test the different position of the popover by changing the position in the select menu options.
  • Change the direction to RTL on the top menu.
  • Test the different position of the popover by changing the position in the select menu options.
  • Try adding a different text by filling in the Edit string... field in the children argument.
  • Toggle the hasBackdrop prop to see the popover with a backdrop.
  • Toggle the popover isVisible prop to hide and show the popover.
  • Check the Accessibility tab in all stories and confirm that there are not Violations or Incomplete results.
    image

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 #22260

@Jordi-PV Jordi-PV requested a review from a team as a code owner June 2, 2025 09:36
@Jordi-PV Jordi-PV added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Jun 2, 2025
@Jordi-PV Jordi-PV linked an issue Jun 2, 2025 that may be closed by this pull request
Copy link

github-actions bot commented Jun 5, 2025

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.

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.

Adjust the popover component
1 participant