<!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>[58957] trunk/src/js/_enqueues/wp/updates.js: Plugins: Delay AJAX search until after 2 characters.</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/58957">58957</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/58957","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joedolson</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-08-30 22:15:59 +0000 (Fri, 30 Aug 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'>Plugins: Delay AJAX search until after 2 characters.
Prevent the AJAX search results from firing until after at least 2 characters have been typed into the search boxes. Toggle `autocomplete` value once AJAX is firing. Add a changeable minimum character threshold.
Props armandsdz, adamsilverstein, afercia, mklusak, finalwebsites, joedolson.
Fixes <a href="https://core.trac.wordpress.org/ticket/38211">#38211</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcjs_enqueueswpupdatesjs">trunk/src/js/_enqueues/wp/updates.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcjs_enqueueswpupdatesjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/_enqueues/wp/updates.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/_enqueues/wp/updates.js 2024-08-30 17:38:38 UTC (rev 58956)
+++ trunk/src/js/_enqueues/wp/updates.js 2024-08-30 22:15:59 UTC (rev 58957)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -142,6 +142,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp.updates.searchTerm = '';
</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">+ * Minimum number of characters before an ajax search is fired.
+ *
+ * @since 6.7.0
+ *
+ * @type {number}
+ */
+ wp.updates.searchMinCharacters = 2;
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Whether filesystem credentials need to be requested from the user.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.2.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2977,6 +2986,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $pluginInstallSearch.attr( 'aria-describedby', 'live-search-desc' );
</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">+ // Track the previous search string length.
+ var previousSearchStringLength = 0;
+ wp.updates.shouldSearch = function( searchStringLength ) {
+ var shouldSearch = searchStringLength >= wp.updates.searchMinCharacters ||
+ previousSearchStringLength > wp.updates.searchMinCharacters;
+ previousSearchStringLength = searchStringLength;
+ return shouldSearch;
+ };
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Handles changes to the plugin search box on the new-plugin page,
</span><span class="cx" style="display: block; padding: 0 10px"> * searching the repository dynamically.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2984,7 +3002,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $pluginInstallSearch.on( 'keyup input', _.debounce( function( event, eventtype ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var $searchTab = $( '.plugin-install-search' ), data, searchLocation;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var $searchTab = $( '.plugin-install-search' ), data, searchLocation,
+ searchStringLength = $pluginInstallSearch.val().length;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> data = {
</span><span class="cx" style="display: block; padding: 0 10px"> _ajax_nonce: wp.updates.ajaxNonce,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2995,6 +3014,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px"> searchLocation = location.href.split( '?' )[ 0 ] + '?' + $.param( _.omit( data, [ '_ajax_nonce', 'pagenow' ] ) );
</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 the autocomplete attribute, turning off autocomplete 1 character before ajax search kicks in.
+ if ( wp.updates.shouldSearch( searchStringLength ) ) {
+ $pluginInstallSearch.attr( 'autocomplete', 'off' );
+ } else {
+ $pluginInstallSearch.attr( 'autocomplete', 'on' );
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Clear on escape.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'keyup' === event.type && 27 === event.which ) {
</span><span class="cx" style="display: block; padding: 0 10px"> event.target.value = '';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3054,6 +3081,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $pluginSearch.length ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $pluginSearch.attr( 'aria-describedby', 'live-search-desc' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</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">@@ -3069,8 +3097,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> pagenow: pagenow,
</span><span class="cx" style="display: block; padding: 0 10px"> plugin_status: 'all'
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- queryArgs;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ queryArgs,
+ searchStringLength = $pluginSearch.val().length;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set the autocomplete attribute, turning off autocomplete 1 character before ajax search kicks in.
+ if ( wp.updates.shouldSearch( searchStringLength ) ) {
+ $pluginSearch.attr( 'autocomplete', 'off' );
+ } else {
+ $pluginSearch.attr( 'autocomplete', 'on' );
+ return;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Clear on escape.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'keyup' === event.type && 27 === event.which ) {
</span><span class="cx" style="display: block; padding: 0 10px"> event.target.value = '';
</span></span></pre>
</div>
</div>
</body>
</html>