<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[59130] trunk: Interactivity API: Move interactivity-router i18n strings to Script Module data.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/59130">59130</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/59130","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>czapla</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-09-30 16:16:44 +0000 (Mon, 30 Sep 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/60647">#60647</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesinteractivityapiclasswpinteractivityapiphp">trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php</a></li>
<li><a href="#trunktestsphpunittestsinteractivityapiwpInteractivityAPIwprouterregionphp">trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPI-wp-router-region.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesinteractivityapiclasswpinteractivityapiphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php 2024-09-30 16:12:04 UTC (rev 59129)
+++ trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php 2024-09-30 16:16:44 UTC (rev 59130)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -200,6 +200,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Set client-side interactivity data.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Once in the browser, the state will be parsed and used to hydrate the client-side
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -296,6 +316,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function add_hooks() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'script_module_data_@wordpress/interactivity', array( $this, 'filter_script_module_interactivity_data' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'script_module_data_@wordpress/interactivity-router', array( $this, 'filter_script_module_interactivity_router_data' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -973,16 +994,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Outputs the markup for the top loading indicator and the screen reader
- * notifications during client-side navigations.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deprecated.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * This method prints a div element representing a loading bar visible during
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * navigation, as well as an aria-live region that can be read by screen
- * readers to announce navigation status.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * navigation.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 6.5.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.7.0
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function print_router_loading_and_screen_reader_markup() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function print_router_markup() {
</ins><span class="cx" style="display: block; padding: 0 10px"> echo <<<HTML
</span><span class="cx" style="display: block; padding: 0 10px"> <div
</span><span class="cx" style="display: block; padding: 0 10px"> class="wp-interactivity-router-loading-bar"
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -990,12 +1022,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> data-wp-class--start-animation="state.navigation.hasStarted"
</span><span class="cx" style="display: block; padding: 0 10px"> data-wp-class--finish-animation="state.navigation.hasFinished"
</span><span class="cx" style="display: block; padding: 0 10px"> ></div>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <div
- class="screen-reader-text"
- aria-live="polite"
- data-wp-interactive="core/router"
- data-wp-text="state.navigation.message"
- ></div>
</del><span class="cx" style="display: block; padding: 0 10px"> HTML;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1016,16 +1042,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'enter' === $mode && ! $this->has_processed_router_region ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->has_processed_router_region = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Initialize the `core/router` store.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Initialize the `core/router` store.
+ * If the store is not initialized like this with minimal
+ * navigation object, the interactivity-router script module
+ * errors.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->state(
</span><span class="cx" style="display: block; padding: 0 10px"> 'core/router',
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'navigation' => array(
- 'texts' => array(
- 'loading' => __( 'Loading page, please wait.' ),
- 'loaded' => __( 'Page Loaded.' ),
- ),
- ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'navigation' => new stdClass(),
</ins><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1035,7 +1061,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_style( 'wp-interactivity-router-animations' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Adds the necessary markup to the footer.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_action( 'wp_footer', array( $this, 'print_router_loading_and_screen_reader_markup' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_action( 'wp_footer', array( $this, 'print_router_markup' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsinteractivityapiwpInteractivityAPIwprouterregionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPI-wp-router-region.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPI-wp-router-region.php 2024-09-30 16:12:04 UTC (rev 59129)
+++ trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPI-wp-router-region.php 2024-09-30 16:16:44 UTC (rev 59130)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -102,7 +102,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::process_directives
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_wp_router_region_adds_loading_bar_aria_live_region_only_once() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_wp_router_region_adds_loading_bar_region_only_once() {
</ins><span class="cx" style="display: block; padding: 0 10px"> $html = '
</span><span class="cx" style="display: block; padding: 0 10px"> <div data-wp-router-region="region A">Interactive region</div>
</span><span class="cx" style="display: block; padding: 0 10px"> <div data-wp-router-region="region B">Another interactive region</div>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -125,9 +125,5 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $p = new WP_HTML_Tag_Processor( $footer );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( $p->next_tag( $query ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( $p->next_tag( $query ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $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 ) );
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>