Deprecate suggest.js code

[Pedro Algarvio, aka, s0undt3ch <ufs@…>]

Although, trac itself does not make use of such a feature, I propose the following changes on suggest.js:

htdocs/js/suggest.js

@@ -56 +56 @@
 
     function hide() {
       if (timeout) clearTimeout(timeout);
-      input.removeClass("loading");
       if (results) {
         results.fadeOut("fast").remove();
         results = null;
@@ -76 +75 @@
     function select(li) {
       if (!li) li = $("<li>");
       else li = $(li);
-      var val = $.trim(li.text());
+      var val = $.trim(li.attr('realvalue') || li.text());
       prev = val;
       input.val(val);
       hide();
@@ -88 +87 @@
       if (val == prev) return;
       prev = val;
       if (val.length < minChars) { hide(); return; }
-      input.addClass("loading");
+      // Attach the input class tweaks right into the ajax callbacks
+      $(input).ajaxStart(function() {$(this).addClass('loading')});
+      $(input).ajaxComplete(function() {$(this).removeClass('loading')});
+
       var params = {};
       params[paramName] = val;
       $.get(url, params, function(data) {

What the following allows is to pass several html elements to display additional info while still allowing a specific value to the put on the input element.

Consider the following <ul>:

<ul>
  <li realvalue="pt_PT">
    <b>pt_PT</b><br/>
    <em>português (Portugal) (Portugal)<br/>
    Portuguese (Portugal)</em>
  </li>
  <li realvalue="pt">
    <b>pt</b><br/>
    <em>português<br/>
    Portuguese</em>
  </li>
  <li realvalue="pt_BR">
    <b>pt_BR</b><br/>
    <em>português (Brasil)<br/>
    Portuguese (Brazil)</em>
  </li>
</ul>

What's added to the <input/> is realvalue, yet, what's shown to the user has additional info.

Also, with this patch, the css class tweaking is attached to jQuery's ajax callbacks, providing additional and removal of class on the actual ajax calls, not somewhere near(in time).

I also started by saying that trac does not yet make use of this, but a plug I'm coding needs this; it's just a matter of not loading yet another js file in future releases, and providing some js also useful for plugins and not just trac.

[Pedro Algarvio, aka, s0undt3ch <ufs@…>]

Sorry, the correct patch is:

htdocs/js/suggest.js

@@ -56 +56 @@
 
     function hide() {
       if (timeout) clearTimeout(timeout);
-      input.removeClass("loading");
       if (results) {
         results.fadeOut("fast").remove();
         results = null;
@@ -76 +75 @@
     function select(li) {
       if (!li) li = $("<li>");
       else li = $(li);
-      var val = $.trim(li.text());
+      var val = $.trim(li.attr('realvalue') || li.text());
       prev = val;
       input.val(val);
       hide();
@@ -88 +87 @@
       if (val == prev) return;
       prev = val;
       if (val.length < minChars) { hide(); return; }
-      input.addClass("loading");
+      // Attach the input class tweaks right into the ajax callbacks
+      $(input).ajaxStart(function() {$(input).addClass('loading')});
+      $(input).ajaxComplete(function() {$(input).removeClass('loading')});
+
       var params = {};
       params[paramName] = val;
       $.get(url, params, function(data) {

Changed lines are:

$(input).ajaxStart(function() {$(input).addClass('loading')});
$(input).ajaxComplete(function() {$(input).removeClass('loading')});

Callbacks must be attached to input not this, else, all inputs which are suggest enabled, will have their classes tweaked.

[Pedro Algarvio, aka, s0undt3ch <ufs@…>]

Final change on patch:

htdocs/js/suggest.js

@@ -56 +56 @@
 
     function hide() {
       if (timeout) clearTimeout(timeout);
-      input.removeClass("loading");
       if (results) {
         results.fadeOut("fast").remove();
         results = null;
@@ -76 +75 @@
     function select(li) {
       if (!li) li = $("<li>");
       else li = $(li);
-      var val = $.trim(li.text());
+      var val = $.trim(li.attr('realvalue') || li.text());
       prev = val;
       input.val(val);
       hide();
@@ -89 +88 @@
       prev = val;
       if (val.length < minChars) { hide(); return; }
       input.addClass("loading");
+      input.ajaxComplete( function() { input.removeClass("loading"); });
       var params = {};
       params[paramName] = val;
       $.get(url, params, function(data) {

Why? Because if you have more than a single input where suggest is enabled, when sugest has run for more than one input, afterwards, all those inputs will have their classes tweaked. So, now, we add the classes ourselves, but removal works ok if attached to the callbacks, only attaching to .ajaxStart or .ajaxSend does not work, or I did not do it correctly.

[Thijs Triemstra <lists@…>]

This patch needs a review

[Christian Boos]

I don't think it's adequate to extend the suggest.js code, as this will be replaced by jQueryUI autocomplete (#9643).

So I'd rather not take the patch and mark suggest.js as deprecated in 0.13 and to be removed in 0.14.

[Remy Blank]

Preparing for 1.0.

[Christian Boos]

Deprecation warning added in r11081.

At some point in 1.1.x, we'll use more of jquery-ui…

[Ryan J Ollos]

#12169 created for replacing suggest.js.