Skip to content

improve accessibility of disabled seo scores#22047

Merged
leonidasmi merged 11 commits intotrunkfrom
451-improve-ux-and-accessibility-of-yoast-seo-scores-column-heading-in-widget-table
Feb 20, 2025
Merged

improve accessibility of disabled seo scores#22047
leonidasmi merged 11 commits intotrunkfrom
451-improve-ux-and-accessibility-of-yoast-seo-scores-column-heading-in-widget-table

Conversation

@vraja-pro
Copy link
Copy Markdown
Contributor

@vraja-pro vraja-pro commented Feb 17, 2025

Context

Summary

This PR can be summarized in the following changelog entry:

  • Improves accessibility for disabled SEO score in the Top 5 most popular content table of the unreleased site kit integration.

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:

  • Enable the google site kit feature flag:
define( 'YOAST_SEO_GOOGLE_SITE_KIT_FEATURE', true );
  • Connect site kit and see the "Top 5 most popular content" table.
  • Turn on the Voiceover screenreader.
  • Check for urls that are not analysed, check you get the tooltip for not analysed.
  • Check that the screen reader reads the tooltip.
  • For urls that are not editable or for urls that are editable but don't have indexable yet, check you get the We can’t provide an SEO score for this page. tooltip.
  • Check that the screen reader reads the tooltip and also mention that this score is disabled.
  • Disable SEO analysis on Yoast SEO->Settings.
  • Check the Yoast SEO score table header has dotted underline.
  • Hover the header and check you get the tooltip for disabled SEO score.
  • Check that the screen reader reads the tooltip.
  • [ ] Check the screenreader read the X int he table as "Disabled".
  • Disable indexable by adding the code:
add_filter( 'Yoast\WP\SEO\should_index_indexables', '__return_false' );
  • Check the Yoast SEO score table header has dotted underline.
  • Hover the header and check you get the tooltip for disabled indexables.
  • Check that the screen reader reads the tooltip.
  • Check the screenreader read the X int he table as "Disabled".

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 Improve UX and accessibility of Yoast SEO scores column heading in widget table

@vraja-pro vraja-pro added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Feb 17, 2025
@coveralls
Copy link
Copy Markdown

coveralls commented Feb 17, 2025

Pull Request Test Coverage Report for Build 9807cd52a959b8fa6077924a3e7da0c0563d048e

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

  • 15 of 15 (100.0%) changed or added relevant lines in 2 files are covered.
  • 1603 unchanged lines in 45 files lost coverage.
  • Overall coverage decreased (-1.3%) to 53.372%

Files with Coverage Reduction New Missed Lines %
admin/class-option-tabs-formatter.php 1 0.0%
packages/js/src/general/initialize.js 1 0.0%
src/actions/configuration/first-time-configuration-action.php 1 91.84%
src/dashboard/domain/content-types/content-types-list.php 1 15.38%
src/generated/assets/externals.php 1 0.0%
src/generated/assets/languages.php 1 0.0%
src/generators/breadcrumbs-generator.php 1 64.23%
src/integrations/blocks/structured-data-blocks.php 1 16.0%
src/integrations/settings-integration.php 1 28.26%
admin/class-admin-editor-specific-replace-vars.php 2 85.71%
Totals Coverage Status
Change from base Build 711656c237bc76273e323a92b5c22383c654a26f: -1.3%
Covered Lines: 30287
Relevant Lines: 57499

💛 - Coveralls

Copy link
Copy Markdown
Contributor

@leonidasmi leonidasmi left a comment

Choose a reason for hiding this comment

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

CR: 🏗️ (some comments inline)

Also, I think we need to take care of this requirement from UX:

Ensure the cursor changes to help when hovering over the heading

Also, I have some reservations whether the tooltip is properly centered vertically:
image
it might need to be moved a bit to the top?

Comment thread packages/js/src/dashboard/components/widget-table.js Outdated
Comment thread packages/js/src/dashboard/components/widget-table.js Outdated
Comment thread packages/js/src/dashboard/widgets/top-pages-widget.js Outdated
Comment thread packages/js/src/dashboard/widgets/top-pages-widget.js Outdated
@vraja-pro
Copy link
Copy Markdown
Contributor Author

As for the position of the tooltip, I'm waiting for UX feedback.

Copy link
Copy Markdown
Contributor

@leonidasmi leonidasmi left a comment

Choose a reason for hiding this comment

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

CR + Acceptance is ✅

@leonidasmi leonidasmi added this to the 24.7 milestone Feb 20, 2025
@leonidasmi leonidasmi merged commit 6632fd6 into trunk Feb 20, 2025
@leonidasmi leonidasmi deleted the 451-improve-ux-and-accessibility-of-yoast-seo-scores-column-heading-in-widget-table branch February 20, 2025 12:00
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.

3 participants