Skip to content

A11y: distinct aria-label for SMTP page step-number landmarks (aria_complementary_labelled) #3370

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vivi-the-going-merry wants to merge 1 commit into
base: master
Choose a base branch
from
Open

A11y: distinct aria-label for SMTP page step-number landmarks (aria_complementary_labelled) #3370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions classes/controllers/FrmSMTPController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ protected function output_section_step_install() {

printf(
'<section class="step step-install">
<aside class="num">
<aside class="num" aria-label="%8$s">
%1$s
<i class="loader hidden"></i>
</aside>
Expand All @@ -255,7 +255,8 @@ protected function output_section_step_install() {
esc_attr( $step['plugin'] ),
esc_attr( $step['button_class'] ),
esc_attr( $step['button_action'] ),
esc_html( $step['button_text'] )
esc_html( $step['button_text'] ),
esc_attr__( 'Step 1', 'formidable' )
);
}

Expand Down Expand Up @@ -284,7 +285,7 @@ protected function output_section_step_setup() {

printf(
'<section class="step step-setup %1$s">
<aside class="num">
<aside class="num" aria-label="%8$s">
%2$s
<i class="loader hidden"></i>
</aside>
Expand All @@ -300,7 +301,8 @@ protected function output_section_step_setup() {
esc_html__( 'Select and configure your mailer.', 'formidable' ),
esc_url( admin_url( $this->config['smtp_settings'] ) ),
esc_attr( $step['button_class'] ),
esc_html( $step['button_text'] )
esc_html( $step['button_text'] ),
esc_attr__( 'Step 2', 'formidable' )
);
}

Expand Down
27 changes: 27 additions & 0 deletions tests/phpunit/base/FrmUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -843,4 +843,31 @@ protected function use_frm_role( $role ) {
break;
}
}

/**
* Assert that every <aside> tag in some rendered HTML has a non-empty aria-label.
* <aside> carries an implicit role="complementary", which the IBM Equal Access
* checker flags as unlabelled complementary content otherwise (aria_complementary_labelled).
*
* @since x.x
*
* @param string $html
* @param int $expected_count Required so an empty/short match list fails loudly instead of
* passing vacuously (assertNotContains passes on an empty array).
*
* @return void
*/
protected function assert_complementary_landmarks_are_labelled( $html, $expected_count ) {
preg_match_all( '/<aside\b[^>]*>/', $html, $matches );
$this->assertCount( $expected_count, $matches[0], 'Unexpected number of <aside> elements' );

$labels = array();

foreach ( $matches[0] as $aside_tag ) {
preg_match( '/aria-label="([^"]*)"/', $aside_tag, $label_match );
$labels[] = $label_match[1] ?? '';
}

$this->assertNotContains( '', $labels, 'Every complementary landmark needs a non-empty accessible name' );
}
}
16 changes: 16 additions & 0 deletions tests/phpunit/misc/test_FrmSMTPController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,20 @@ public function test_link_overrides_preexisting_utm_params_from_wp_mail_smtp() {
$this->assertStringNotContainsString( 'utm_campaign=liteplugin', $link, 'Our own campaign should override the pre-existing one' );
$this->assertStringContainsString( 'urllink=wpmailsmtp%2Ecom%2Flite%2Dupgrade', $link, 'The hand-obfuscated redirect target must survive the utm re-tagging untouched' );
}

/**
* The SMTP page renders two step-number <aside> badges (Install, Setup). Both need a
* non-empty accessible name or they violate the aria_complementary_labelled a11y rule.
*
* @covers FrmSMTPController::output
*/
public function test_output_has_labelled_complementary_landmarks() {
$controller = new FrmSMTPController();

ob_start();
$controller->output();
$html = ob_get_clean();

$this->assert_complementary_landmarks_are_labelled( $html, 2 );
}
}
Loading