Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-23 01:27:36 +01:00
Code Issues Projects Releases Wiki Activity

Interactivity API: Move interactivity-router i18n strings to Script Module data.

Browse Source 
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.
Built from https://develop.svn.wordpress.org/trunk@59130


git-svn-id: http://core.svn.wordpress.org/trunk@58526 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
czapla 2024-09-30 16:18:17 +00:00
parent c2580f3c20
commit 245519d952
2 changed files with 47 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
wp-includes/interactivity-api/class-wp-interactivity-api.php
View File

@ -199,6 +199,26 @@ final class WP_Interactivity_API {
_deprecated_function( __METHOD__, '6.7.0' ); _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. * Set client-side interactivity data.
* *
@ -296,6 +316,7 @@ final class WP_Interactivity_API {
*/ */
public function add_hooks() { 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', 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 * Deprecated.
* 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.
* *
* @since 6.5.0 * @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() { 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 echo <<<HTML
<div <div
class="wp-interactivity-router-loading-bar" class="wp-interactivity-router-loading-bar"
@ -990,12 +1022,6 @@ CSS;
data-wp-class--start-animation="state.navigation.hasStarted" data-wp-class--start-animation="state.navigation.hasStarted"
data-wp-class--finish-animation="state.navigation.hasFinished" data-wp-class--finish-animation="state.navigation.hasFinished"
></div> ></div>
<div
class="screen-reader-text"
aria-live="polite"
data-wp-interactive="core/router"
data-wp-text="state.navigation.message"
></div>
HTML; HTML;
} }
@ -1016,16 +1042,16 @@ HTML;
if ( 'enter' === $mode && ! $this->has_processed_router_region ) { if ( 'enter' === $mode && ! $this->has_processed_router_region ) {
$this->has_processed_router_region = true; $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( $this->state(
'core/router', 'core/router',
array( array(
'navigation' => array( 'navigation' => new stdClass(),
'texts' => array(
'loading' => __( 'Loading page, please wait.' ),
'loaded' => __( 'Page Loaded.' ),
),
),
) )
); );
@ -1035,7 +1061,7 @@ HTML;
wp_enqueue_style( 'wp-interactivity-router-animations' ); wp_enqueue_style( 'wp-interactivity-router-animations' );
// Adds the necessary markup to the footer. // 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' ) );
} }
} }

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.7-alpha-59129'; $wp_version = '6.7-alpha-59130';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.