Skip to content

fix: accessibility fixes #266

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ahuseyn merged 2 commits into from
Jun 24, 2025
Merged

fix: accessibility fixes #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
688fe77
fix: accessibility fixes
ahuseyn Jun 24, 2025
c6ca1d1
test: update unit test
ahuseyn Jun 24, 2025
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
6 changes: 6 additions & 0 deletions plugins/hwp-previews/assets/css/hwp-previews.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
.settings_page_hwp-previews #poststuff .postbox .inside h2 {
font-size: 1.3em;
font-weight: 600;
padding-left: 0;
}

.hwp-previews-tag-cloud {
display: flex;
flex-wrap: wrap;
Expand Down
10 changes: 6 additions & 4 deletions plugins/hwp-previews/src/Admin/Settings/Fields/Field/Abstract_Settings_Field.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,12 +124,14 @@ public function settings_field_callback( array $args ): void {
$settings_key = $args['settings_key'] ?? HWP_PREVIEWS_SETTINGS_KEY;

printf(
'<div tabindex="0" aria-describedby="%2$s-tooltip" class="hwp-previews-tooltip">
'<span class="hwp-previews-tooltip">
<span class="dashicons dashicons-editor-help"></span>
<span id="%2$s-tooltip" class="tooltip-text description">%1$s</span>
</div>',
<span id="%2$s-%3$s-%4$s-tooltip" class="tooltip-text description">%1$s</span>
</span>',
esc_attr( $this->get_description() ),
esc_attr( $settings_key )
esc_attr( $settings_key ),
esc_attr( $post_type ),
esc_attr( $this->id ),
);

// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
Expand Down
2 changes: 1 addition & 1 deletion plugins/hwp-previews/src/Admin/Settings/Fields/Field/Checkbox_Field.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public function render_field( $option_value, $setting_key, $post_type ): string
: $this->default;

return sprintf(
'<input type="checkbox" name="%1$s[%2$s][%3$s]" value="1" %4$s class="%5$s" />',
'<input type="checkbox" name="%1$s[%2$s][%3$s]" aria-labelledby="%1$s-%2$s-%3$s-tooltip" value="1" %4$s class="%5$s" />',
esc_attr( $setting_key ),
esc_attr( $post_type ),
esc_attr( $this->id ),
Expand Down
2 changes: 1 addition & 1 deletion plugins/hwp-previews/src/Admin/Settings/Fields/Field/Text_Input_Field.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public function render_field( array $option_value, string $setting_key, string $


return sprintf(
'<input type="%1$s" name="%2$s[%3$s][%4$s]" value="%5$s" placeholder="%6$s" class="%7$s" />',
'<input type="%1$s" name="%2$s[%3$s][%4$s]" aria-labelledby="%2$s-%3$s-%4$s-tooltip" value="%5$s" placeholder="%6$s" class="%7$s" />',
$this->get_input_type(),
esc_attr( $setting_key ),
esc_attr( $post_type ),
Expand Down
8 changes: 4 additions & 4 deletions plugins/hwp-previews/src/Admin/Settings/Templates/settings-page-main.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@
<div class="wrap">
<h1><?php esc_html_e( 'HWP Previews Settings', 'hwp-previews' ); ?></h1>
<form method="post" action="options.php">
<h2 class="nav-tab-wrapper">
<nav class="nav-tab-wrapper">
<?php
foreach ( $hwp_previews_tabs as $hwp_previews_tab_key => $hwp_previews_tab_label ) {
$hwp_previews_tab_url = admin_url( 'admin.php?page=hwp-previews&tab=' . $hwp_previews_tab_key );
$hwp_previews_tab_class = add_cssclass( $hwp_previews_current_tab === $hwp_previews_tab_key ? 'nav-tab-active' : '', 'nav-tab' );
echo '<a href="' . esc_url( $hwp_previews_tab_url ) . '" class="' . esc_attr( $hwp_previews_tab_class ) . '">' . esc_html( $hwp_previews_tab_label ) . '</a>';
}
?>
</h2>
</nav>

<div id="poststuff">
<div id="post-body" class="metabox-holder columns-2">
Expand All @@ -45,7 +45,7 @@
<div id="postbox-container-1" class="postbox-container">
<div class="meta-box-sortables">
<div class="postbox">
<h2><?php esc_html_e( 'Available Preview URL Parameters', 'hwp-previews' ); ?></h2>
<h3><?php esc_html_e( 'Available Preview URL Parameters', 'hwp-previews' ); ?></h3>
<div class="inside">
<div class="hwp-previews-tag-cloud">
<?php foreach ( $hwp_previews_params as $hwp_previews_param_name => $hwp_previews_param_desc ) : ?>
Expand All @@ -59,7 +59,7 @@
</div>

<div class="postbox">
<h2><?php esc_html_e( 'Get Started With HWP Previews', 'hwp-previews' ); ?></h2>
<h3><?php esc_html_e( 'Get Started With HWP Previews', 'hwp-previews' ); ?></h3>
<div class="inside hwp-previews-docs">

<ul>
Expand Down
8 changes: 5 additions & 3 deletions plugins/hwp-previews/tests/wpunit/Admin/Settings/Fields/Field/CheckboxFieldTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,9 @@ public function test_render_field_checked(): void {
$post_type = 'post';

$expected_input_name = 'hwp_previews_settings[' . $post_type . '][in_iframe]';
$expceted_input_label = 'hwp_previews_settings-' . $post_type . '-in_iframe-tooltip';
$expected_css_class = 'custom-css-class';
$expected_output = '<input type="checkbox" name="' . $expected_input_name . '" value="1" checked=\'checked\' class="' . $expected_css_class . '" />';
$expected_output = '<input type="checkbox" name="' . $expected_input_name . '" aria-labelledby="' . $expceted_input_label . '" value="1" checked=\'checked\' class="' . $expected_css_class . '" />';

$rendered_output = $field->render_field($option_value, $setting_key, $post_type);

Expand All @@ -80,8 +81,9 @@ public function test_render_field_unchecked(): void {
$post_type = 'post';

$expected_input_name = 'hwp_previews_settings[' . $post_type . '][in_iframe]';
$expceted_input_label = 'hwp_previews_settings-' . $post_type . '-in_iframe-tooltip';
$expected_css_class = 'custom-css-class';
$expected_output = '<input type="checkbox" name="' . $expected_input_name . '" value="1" class="' . $expected_css_class . '" />';
$expected_output = '<input type="checkbox" name="' . $expected_input_name . '" aria-labelledby="' . $expceted_input_label . '" value="1" class="' . $expected_css_class . '" />';

$rendered_output = $field->render_field($option_value, $setting_key, $post_type);

Expand All @@ -99,7 +101,7 @@ public function test_render_field_without_css_class(): void {
$rendered_output = $field->render_field([], HWP_PREVIEWS_SETTINGS_KEY, 'page');

$this->assertEquals(
'<input type="checkbox" name="hwp_previews_settings[page][in_iframe]" value="1" class="" />',
'<input type="checkbox" name="hwp_previews_settings[page][in_iframe]" aria-labelledby="hwp_previews_settings-page-in_iframe-tooltip" value="1" class="" />',
$rendered_output
);
}
Expand Down
11 changes: 7 additions & 4 deletions plugins/hwp-previews/tests/wpunit/Admin/Settings/Fields/Field/TextInputFieldTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,11 @@ public function test_render_field_with_default_value() {

$rendered_output = $field->render_field( $option_value, $setting_key, $post_type );
$excepted_input_name = 'hwp_previews_settings[' . $post_type . '][preview_url]';
$expceted_input_label = 'hwp_previews_settings-' . $post_type . '-preview_url-tooltip';
$excepted_input_value = 'https://example.com/' . $post_type . '?preview=true&amp;post_id={ID}&amp;name={slug}';
$excepted_css_class = 'custom-css-class';

$expected_output = '<input type="text" name="' . $excepted_input_name . '" value="' . $excepted_input_value . '" placeholder="' . $excepted_input_value . '" class="' . $excepted_css_class . '" />';
$expected_output = '<input type="text" name="' . $excepted_input_name . '" aria-labelledby="' . $expceted_input_label . '" value="' . $excepted_input_value . '" placeholder="' . $excepted_input_value . '" class="' . $excepted_css_class . '" />';

$this->assertEquals( $expected_output, $rendered_output );
}
Expand All @@ -105,9 +106,10 @@ public function test_render_field_with_no_option_value() {

$rendered_output = $field->render_field( $option_value, $setting_key, $post_type );
$excepted_input_name = 'hwp_previews_settings[' . $post_type . '][preview_url]';
$expceted_input_label = 'hwp_previews_settings-' . $post_type . '-preview_url-tooltip';
$excepted_input_value = 'https://example.com/' . $post_type . '?preview=true&amp;post_id={ID}&amp;name={slug}';
$excepted_css_class = 'custom-css-class';
$expected_output = '<input type="text" name="' . $excepted_input_name . '" value="' . $excepted_input_value . '" placeholder="' . $excepted_input_value . '" class="' . $excepted_css_class . '" />';
$expected_output = '<input type="text" name="' . $excepted_input_name . '" aria-labelledby="' . $expceted_input_label . '" value="' . $excepted_input_value . '" placeholder="' . $excepted_input_value . '" class="' . $excepted_css_class . '" />';

$this->assertEquals( $expected_output, $rendered_output );
}
Expand All @@ -123,9 +125,10 @@ public function test_render_field_with_different_option_value_to_default_value()

$rendered_output = $field->render_field( $option_value, $setting_key, $post_type );
$excepted_input_name = 'hwp_previews_settings[' . $post_type . '][preview_url]';
$expceted_input_label = 'hwp_previews_settings-' . $post_type . '-preview_url-tooltip';
$default_value = 'https://example.com/' . $post_type . '?preview=true&amp;post_id={ID}&amp;name={slug}';
$excepted_css_class = 'custom-css-class';
$expected_output = '<input type="text" name="' . $excepted_input_name . '" value="' . $excepted_input_value . '" placeholder="' . $default_value . '" class="' . $excepted_css_class . '" />';
$expected_output = '<input type="text" name="' . $excepted_input_name . '" aria-labelledby="' . $expceted_input_label . '" value="' . $excepted_input_value . '" placeholder="' . $default_value . '" class="' . $excepted_css_class . '" />';

$this->assertEquals( $expected_output, $rendered_output );
}
Expand All @@ -141,7 +144,7 @@ public function test_render_field_without_css_class() {
$rendered_output = $field->render_field( [], HWP_PREVIEWS_SETTINGS_KEY, 'page' );

$this->assertEquals(
'<input type="text" name="hwp_previews_settings[page][preview_url]" value="" placeholder="" class="" />',
'<input type="text" name="hwp_previews_settings[page][preview_url]" aria-labelledby="hwp_previews_settings-page-preview_url-tooltip" value="" placeholder="" class="" />',
$rendered_output
);
}
Expand Down
11 changes: 7 additions & 4 deletions plugins/hwp-previews/tests/wpunit/Admin/Settings/Fields/Field/TextURLFieldTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,10 @@ public function test_render_field_with_default_value() {

$rendered_output = $field->render_field( $option_value, $setting_key, $post_type );
$excepted_input_name = 'hwp_previews_settings[' . $post_type . '][preview_url]';
$expceted_input_label = 'hwp_previews_settings-' . $post_type . '-preview_url-tooltip';
$excepted_input_value = 'https://example.com/' . $post_type . '?preview=true&amp;post_id={ID}&amp;name={slug}';
$excepted_css_class = 'custom-css-class';
$expected_output = '<input type="url" name="' . $excepted_input_name . '" value="' . $excepted_input_value . '" placeholder="' . $excepted_input_value . '" class="' . $excepted_css_class . '" />';
$expected_output = '<input type="url" name="' . $excepted_input_name . '" aria-labelledby="' . $expceted_input_label . '" value="' . $excepted_input_value . '" placeholder="' . $excepted_input_value . '" class="' . $excepted_css_class . '" />';

$this->assertEquals( $expected_output, $rendered_output );
}
Expand All @@ -106,9 +107,10 @@ public function test_render_field_with_no_option_value() {

$rendered_output = $field->render_field( $option_value, $setting_key, $post_type );
$excepted_input_name = 'hwp_previews_settings[' . $post_type . '][preview_url]';
$expceted_input_label = 'hwp_previews_settings-' . $post_type . '-preview_url-tooltip';
$excepted_input_value = 'https://example.com/' . $post_type . '?preview=true&amp;post_id={ID}&amp;name={slug}';
$excepted_css_class = 'custom-css-class';
$expected_output = '<input type="url" name="' . $excepted_input_name . '" value="' . $excepted_input_value . '" placeholder="' . $excepted_input_value . '" class="' . $excepted_css_class . '" />';
$expected_output = '<input type="url" name="' . $excepted_input_name . '" aria-labelledby="' . $expceted_input_label . '" value="' . $excepted_input_value . '" placeholder="' . $excepted_input_value . '" class="' . $excepted_css_class . '" />';

$this->assertEquals( $expected_output, $rendered_output );
}
Expand All @@ -124,9 +126,10 @@ public function test_render_field_with_different_option_value_to_default_value()

$rendered_output = $field->render_field( $option_value, $setting_key, $post_type );
$excepted_input_name = 'hwp_previews_settings[' . $post_type . '][preview_url]';
$expceted_input_label = 'hwp_previews_settings-' . $post_type . '-preview_url-tooltip';
$default_value = 'https://example.com/' . $post_type . '?preview=true&amp;post_id={ID}&amp;name={slug}';
$excepted_css_class = 'custom-css-class';
$expected_output = '<input type="url" name="' . $excepted_input_name . '" value="' . $excepted_input_value . '" placeholder="' . $default_value . '" class="' . $excepted_css_class . '" />';
$expected_output = '<input type="url" name="' . $excepted_input_name . '" aria-labelledby="' . $expceted_input_label . '" value="' . $excepted_input_value . '" placeholder="' . $default_value . '" class="' . $excepted_css_class . '" />';

$this->assertEquals( $expected_output, $rendered_output );
}
Expand All @@ -142,7 +145,7 @@ public function test_render_field_without_css_class() {
$rendered_output = $field->render_field( [], HWP_PREVIEWS_SETTINGS_KEY, 'page' );

$this->assertEquals(
'<input type="url" name="hwp_previews_settings[page][preview_url]" value="" placeholder="" class="" />',
'<input type="url" name="hwp_previews_settings[page][preview_url]" aria-labelledby="hwp_previews_settings-page-preview_url-tooltip" value="" placeholder="" class="" />',
$rendered_output
);
}
Expand Down
Loading