From b12a1cfa4dce1c70469ead34a6fb53cf8998f57e Mon Sep 17 00:00:00 2001 From: Michal Czaplinski Date: Mon, 30 Sep 2024 16:16:44 +0000 Subject: [PATCH] Interactivity API: Move interactivity-router i18n strings to Script Module data. Moves the 'loading' and 'loaded' i18n strings for the `interactivity-router` to the script module data via the `script_module_data_@wordpress/interactivity-router` filter. Key changes: - Add the `filter_script_module_interactivity_router_data()` method, hooked into the `script_module_data_@wordpress/interactivity-router` filter, to set the `i18n` data with the 'loading' and 'loaded' messages. - Rename the `print_router_loading_and_screen_reader_markup()` method to `print_router_markup()` and remove the screen reader markup from it because it's no longer needed. - Deprecate the `print_router_loading_and_screen_reader_markup()` method. - Remove the `loading` and `loaded` strings from the `core/router` store state because they're no longer needed. - Initialize the `core/router` store with a minimal navigation object to prevent errors in the interactivity-router script module when the store is not properly initialized. - Update corresponding unit tests to reflect these changes. This change ensures that the `interactivity-router` i18n messages are localized in a single place and removes the need to initialize them in the `core/router` store state. Props jonsurrell, swissspidy, czapla, gziolo. See #60647. git-svn-id: https://develop.svn.wordpress.org/trunk@59130 602fd350-edb4-49c9-b593-d223f7449a82 --- .../class-wp-interactivity-api.php | 66 +++++++++++++------ .../wpInteractivityAPI-wp-router-region.php | 6 +- 2 files changed, 47 insertions(+), 25 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 1213a5c097..022bc08254 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 @@ final class WP_Interactivity_API { _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 @@ final class WP_Interactivity_API { */ 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' ) ); } /** @@ -973,16 +994,27 @@ CSS; } /** - * Outputs the markup for the top loading indicator and the screen reader - * notifications during client-side navigations. - * - * 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. + * Deprecated. * * @since 6.5.0 + * @deprecated 6.7.0 Use {@see WP_Interactivity_API::print_router_markup} instead. */ public function print_router_loading_and_screen_reader_markup() { + _deprecated_function( __METHOD__, '6.7.0', 'WP_Interactivity_API::print_router_markup' ); + + // Call the new method. + $this->print_router_markup(); + } + + /** + * Outputs markup for the @wordpress/interactivity-router script module. + * + * This method prints a div element representing a loading bar visible during + * navigation. + * + * @since 6.7.0 + */ + public function print_router_markup() { echo << -
HTML; } @@ -1016,16 +1042,16 @@ HTML; 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(), ) ); @@ -1035,7 +1061,7 @@ HTML; wp_enqueue_style( 'wp-interactivity-router-animations' ); // Adds the necessary markup to the footer. - add_action( 'wp_footer', array( $this, 'print_router_loading_and_screen_reader_markup' ) ); + add_action( 'wp_footer', array( $this, 'print_router_markup' ) ); } } 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 8d8cdb6228..d6deab48ab 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 @@ class Tests_WP_Interactivity_API_WP_Router_Region extends WP_UnitTestCase { * * @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 @@ class Tests_WP_Interactivity_API_WP_Router_Region extends WP_UnitTestCase { $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 ) ); } }