Skip to content

Interactivity API: Use a11y Script Module in Gutenberg #65123

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
sirreal merged 16 commits into from
Sep 17, 2024
Merged

Interactivity API: Use a11y Script Module in Gutenberg #65123

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
29999f8
Use @wordpress/a11y to announce to screen readers
sirreal Sep 6, 2024
2d5317d
Only use a11y module in GUTENBERG_PLUGIN
sirreal Sep 6, 2024
8409612
Add interacitivty-router script dependency on a11y
sirreal Sep 6, 2024
3afbd51
Load translated strings using script module data passing
sirreal Sep 6, 2024
771e61c
Fix i18n domain to use Core translations.
sirreal Sep 12, 2024
1019f5b
Add extra fallback in case a11y module does not load
sirreal Sep 12, 2024
adbfd46
Fix lints
sirreal Sep 12, 2024
85a7d02
Remove extra fallback
sirreal Sep 12, 2024
6a21c9c
Update package lock
sirreal Sep 12, 2024
f64d420
Add comment to gutenberg_register_interactivity_script_module_data_hooks
sirreal Sep 16, 2024
0b7e978
Remove ariaLive param from a11yAnnounce
sirreal Sep 16, 2024
63a1ffa
Move loaded data state out of texts object
sirreal Sep 16, 2024
71515b6
Improve a11yAnnounce param type
sirreal Sep 16, 2024
325249f
Rename function a11ySpeak
sirreal Sep 16, 2024
c9f0940
Add store type to allow texts
sirreal Sep 17, 2024
85821fd
Add fallback for localized texts
sirreal Sep 17, 2024
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
Prev Previous commit
Next Next commit
Fix lints
  • Loading branch information
@sirreal
sirreal committed Sep 17, 2024
commit adbfd46eed5aae2a518c2e7470b9cbaf872a70bc
29 changes: 16 additions & 13 deletions lib/interactivity-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ function gutenberg_reregister_interactivity_script_modules() {
'@wordpress/interactivity-router',
gutenberg_url( '/build-module/interactivity-router/index.min.js' ),
array(
array( 'id' => '@wordpress/a11y', 'import' => 'dynamic' ),
array(
'id' => '@wordpress/a11y',
'import' => 'dynamic',
),
'@wordpress/interactivity',
),
$default_version
Expand All @@ -34,18 +37,18 @@ function gutenberg_reregister_interactivity_script_modules() {
add_action( 'init', 'gutenberg_reregister_interactivity_script_modules' );

function gutenberg_register_interactivity_script_module_data_hooks() {
if ( ! has_filter( 'script_module_data_@wordpress/interactivity-router', array( wp_interactivity(), 'filter_script_module_interactivity_router_data' ) ) ) {
add_filter(
'script_module_data_@wordpress/interactivity-router',
function ( $data ) {
if ( ! isset( $data['i18n'] ) ) {
$data['i18n'] = array();
}
$data['i18n']['loading'] = __( 'Loading page, please wait.', 'default' );
$data['i18n']['loaded'] = __( 'Page Loaded.', 'default' );
return $data;
if ( ! has_filter( 'script_module_data_@wordpress/interactivity-router', array( wp_interactivity(), 'filter_script_module_interactivity_router_data' ) ) ) {
add_filter(
'script_module_data_@wordpress/interactivity-router',
function ( $data ) {
if ( ! isset( $data['i18n'] ) ) {
$data['i18n'] = array();
}
);
}
$data['i18n']['loading'] = __( 'Loading page, please wait.', 'default' );
$data['i18n']['loaded'] = __( 'Page Loaded.', 'default' );
return $data;
}
);
}
}
add_action( 'after_setup_theme', 'gutenberg_register_interactivity_script_module_data_hooks', 20 );
Copy link
Member Author

@sirreal sirreal Sep 17, 2024

Choose a reason for hiding this comment

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

With the latest changes to use the localized fallback strings (passed via Interactivity API), if I disable this filter it correctly uses the those strings as a fallback.

#65129 proposes adding this filter to Core.