From c137e90bea426c2eba6cdb33728e52490f19661c Mon Sep 17 00:00:00 2001 From: Jon Surrell Date: Fri, 6 Sep 2024 16:08:06 +0200 Subject: [PATCH 1/7] Add interactivity-router translations via script module data --- .../class-wp-interactivity-api.php | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/src/wp-includes/interactivity-api/class-wp-interactivity-api.php b/src/wp-includes/interactivity-api/class-wp-interactivity-api.php index 1213a5c097440..f8740136a1778 100644 --- a/src/wp-includes/interactivity-api/class-wp-interactivity-api.php +++ b/src/wp-includes/interactivity-api/class-wp-interactivity-api.php @@ -199,6 +199,26 @@ public function print_client_interactivity_data() { _deprecated_function( __METHOD__, '6.7.0' ); } + /** + * Set client-side interactivity-router data. + * + * Once in the browser, the state will be parsed and used to hydrate the client-side + * interactivity stores and the configuration will be available using a `getConfig` utility. + * + * @since 6.7.0 + * + * @param array $data Data to filter. + * @return array Data for the Interactivity Router script module. + */ + public function filter_script_module_interactivity_router_data( array $data ): array { + if ( ! isset( $data['i18n'] ) ) { + $data['i18n'] = array(); + } + $data['i18n']['loading'] = __( 'Loading page, please wait.' ); + $data['i18n']['loaded'] = __( 'Page Loaded.' ); + return $data; + } + /** * Set client-side interactivity data. * @@ -296,6 +316,7 @@ public function register_script_modules() { */ public function add_hooks() { add_filter( 'script_module_data_@wordpress/interactivity', array( $this, 'filter_script_module_interactivity_data' ) ); + add_filter( 'script_module_data_@wordpress/interactivity-router', array( $this, 'filter_script_module_interactivity_router_data' ) ); } /** From 0d310f387120bd5d79d2f5380d9ed24f007e1dce Mon Sep 17 00:00:00 2001 From: Jon Surrell Date: Fri, 20 Sep 2024 21:31:32 +0200 Subject: [PATCH 2/7] Remove iAPI-specific screen reader text This reverts commit c6fcf75e5ea98c8148ff1b46aa8bf61e98ac451d. --- .../interactivity-api/class-wp-interactivity-api.php | 6 ------ 1 file changed, 6 deletions(-) diff --git a/src/wp-includes/interactivity-api/class-wp-interactivity-api.php b/src/wp-includes/interactivity-api/class-wp-interactivity-api.php index f8740136a1778..1f4c5aeb9efba 100644 --- a/src/wp-includes/interactivity-api/class-wp-interactivity-api.php +++ b/src/wp-includes/interactivity-api/class-wp-interactivity-api.php @@ -1011,12 +1011,6 @@ class="wp-interactivity-router-loading-bar" data-wp-class--start-animation="state.navigation.hasStarted" data-wp-class--finish-animation="state.navigation.hasFinished" > -
HTML; } From 252648f676d96f3ad8c6894d3ea56ee2b33c6788 Mon Sep 17 00:00:00 2001 From: Jon Surrell Date: Fri, 20 Sep 2024 21:33:05 +0200 Subject: [PATCH 3/7] Remove localized strings from state --- .../class-wp-interactivity-api.php | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/src/wp-includes/interactivity-api/class-wp-interactivity-api.php b/src/wp-includes/interactivity-api/class-wp-interactivity-api.php index 1f4c5aeb9efba..eab85e6b361da 100644 --- a/src/wp-includes/interactivity-api/class-wp-interactivity-api.php +++ b/src/wp-includes/interactivity-api/class-wp-interactivity-api.php @@ -1031,19 +1031,6 @@ private function data_wp_router_region_processor( WP_Interactivity_API_Directive if ( 'enter' === $mode && ! $this->has_processed_router_region ) { $this->has_processed_router_region = true; - // Initialize the `core/router` store. - $this->state( - 'core/router', - array( - 'navigation' => array( - 'texts' => array( - 'loading' => __( 'Loading page, please wait.' ), - 'loaded' => __( 'Page Loaded.' ), - ), - ), - ) - ); - // Enqueues as an inline style. wp_register_style( 'wp-interactivity-router-animations', false ); wp_add_inline_style( 'wp-interactivity-router-animations', $this->get_router_animation_styles() ); From c03c18bcf5bf6c4c2a26edb9145e822858602e5b Mon Sep 17 00:00:00 2001 From: Jon Surrell Date: Tue, 24 Sep 2024 12:24:19 +0200 Subject: [PATCH 4/7] Remove interactivity router screen reader test --- .../wpInteractivityAPI-wp-router-region.php | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/tests/phpunit/tests/interactivity-api/wpInteractivityAPI-wp-router-region.php b/tests/phpunit/tests/interactivity-api/wpInteractivityAPI-wp-router-region.php index 8d8cdb6228d2e..d6deab48ab141 100644 --- a/tests/phpunit/tests/interactivity-api/wpInteractivityAPI-wp-router-region.php +++ b/tests/phpunit/tests/interactivity-api/wpInteractivityAPI-wp-router-region.php @@ -102,7 +102,7 @@ public function test_wp_router_region_missing() { * * @covers ::process_directives */ - public function test_wp_router_region_adds_loading_bar_aria_live_region_only_once() { + public function test_wp_router_region_adds_loading_bar_region_only_once() { $html = '
Interactive region
Another interactive region
@@ -125,9 +125,5 @@ public function test_wp_router_region_adds_loading_bar_aria_live_region_only_onc $p = new WP_HTML_Tag_Processor( $footer ); $this->assertTrue( $p->next_tag( $query ) ); $this->assertFalse( $p->next_tag( $query ) ); - $query = array( 'class_name' => 'screen-reader-text' ); - $p = new WP_HTML_Tag_Processor( $footer ); - $this->assertTrue( $p->next_tag( $query ) ); - $this->assertFalse( $p->next_tag( $query ) ); } } From 531dea99338dfad3c9f393836800b1c85de56463 Mon Sep 17 00:00:00 2001 From: Jon Surrell Date: Tue, 24 Sep 2024 13:36:03 +0200 Subject: [PATCH 5/7] Revert "Remove localized strings from state" This reverts commit 2d8401fbe376bc77fb5c51d8991b61e6b27ca2c6. --- .../class-wp-interactivity-api.php | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/wp-includes/interactivity-api/class-wp-interactivity-api.php b/src/wp-includes/interactivity-api/class-wp-interactivity-api.php index eab85e6b361da..1f4c5aeb9efba 100644 --- a/src/wp-includes/interactivity-api/class-wp-interactivity-api.php +++ b/src/wp-includes/interactivity-api/class-wp-interactivity-api.php @@ -1031,6 +1031,19 @@ private function data_wp_router_region_processor( WP_Interactivity_API_Directive if ( 'enter' === $mode && ! $this->has_processed_router_region ) { $this->has_processed_router_region = true; + // Initialize the `core/router` store. + $this->state( + 'core/router', + array( + 'navigation' => array( + 'texts' => array( + 'loading' => __( 'Loading page, please wait.' ), + 'loaded' => __( 'Page Loaded.' ), + ), + ), + ) + ); + // Enqueues as an inline style. wp_register_style( 'wp-interactivity-router-animations', false ); wp_add_inline_style( 'wp-interactivity-router-animations', $this->get_router_animation_styles() ); From f2ba5de198d26cdd3d46f045d0feb56c6d40e181 Mon Sep 17 00:00:00 2001 From: Jon Surrell Date: Tue, 24 Sep 2024 13:41:32 +0200 Subject: [PATCH 6/7] Restore some server-side init --- .../class-wp-interactivity-api.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/wp-includes/interactivity-api/class-wp-interactivity-api.php b/src/wp-includes/interactivity-api/class-wp-interactivity-api.php index 1f4c5aeb9efba..8bddf88489f36 100644 --- a/src/wp-includes/interactivity-api/class-wp-interactivity-api.php +++ b/src/wp-includes/interactivity-api/class-wp-interactivity-api.php @@ -1031,16 +1031,16 @@ private function data_wp_router_region_processor( WP_Interactivity_API_Directive if ( 'enter' === $mode && ! $this->has_processed_router_region ) { $this->has_processed_router_region = true; - // Initialize the `core/router` store. + /* + * Initialize the `core/router` store. + * If the store is not initialized like this with minimal + * navigation object, the interactivity-router script module + * errors. + */ $this->state( 'core/router', array( - 'navigation' => array( - 'texts' => array( - 'loading' => __( 'Loading page, please wait.' ), - 'loaded' => __( 'Page Loaded.' ), - ), - ), + 'navigation' => new stdClass(), ) ); From e7c6cfeb600d646c253ae94eb9c9dc2e2941a455 Mon Sep 17 00:00:00 2001 From: Jon Surrell Date: Thu, 26 Sep 2024 19:19:01 +0200 Subject: [PATCH 7/7] Rename method to reflect its new behavior The print_router_loading_and_screen_reader_markup method name was very specific about its behavior which has changed. Rename the method to a more descriptive name and update its documentation. --- .../interactivity-api/class-wp-interactivity-api.php | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/src/wp-includes/interactivity-api/class-wp-interactivity-api.php b/src/wp-includes/interactivity-api/class-wp-interactivity-api.php index 8bddf88489f36..e4dec8e262381 100644 --- a/src/wp-includes/interactivity-api/class-wp-interactivity-api.php +++ b/src/wp-includes/interactivity-api/class-wp-interactivity-api.php @@ -994,16 +994,14 @@ private function get_router_animation_styles(): string { } /** - * Outputs the markup for the top loading indicator and the screen reader - * notifications during client-side navigations. + * Outputs markup for the @wordpress/interactivity-router script module. * * This method prints a div element representing a loading bar visible during - * navigation, as well as an aria-live region that can be read by screen - * readers to announce navigation status. + * navigation. * - * @since 6.5.0 + * @since 6.7.0 */ - public function print_router_loading_and_screen_reader_markup() { + public function print_router_markup() { echo <<