javascript - 如何自定义格式自动完成插件结果？

Question

我正在使用jQuery UI 自动完成插件。有没有办法在下拉结果中突出显示搜索字符序列？

例如，如果我将“foo bar”作为数据并输入“foo”，我将在下拉列表中得到“<strong>foo bar”，如下所示：

score 235 · Accepted Answer

是的，如果你猴子补丁自动完成，你可以。

在 jQuery UI v1.8rc3 中包含的自动完成小部件中，建议的弹出窗口是在自动完成小部件的 _renderMenu 函数中创建的。该函数定义如下：

_renderMenu: function( ul, items ) {
    var self = this;
    $.each( items, function( index, item ) {
        self._renderItem( ul, item );
    });
},

_renderItem 函数定义如下：

_renderItem: function( ul, item) {
    return $( "<li></li>" )
        .data( "item.autocomplete", item )
        .append( "<a>" + item.label + "</a>" )
        .appendTo( ul );
},

因此，您需要做的是用您自己的创建替换 _renderItem fn 以产生所需的效果。这种重新定义库中的内部函数的技术，我来学习称为猴子补丁。我是这样做的：

  function monkeyPatchAutocomplete() {

      // don't really need this, but in case I did, I could store it and chain
      var oldFn = $.ui.autocomplete.prototype._renderItem;

      $.ui.autocomplete.prototype._renderItem = function( ul, item) {
          var re = new RegExp("^" + this.term) ;
          var t = item.label.replace(re,"<span style='font-weight:bold;color:Blue;'>" + 
                  this.term + 
                  "</span>");
          return $( "<li></li>" )
              .data( "item.autocomplete", item )
              .append( "<a>" + t + "</a>" )
              .appendTo( ul );
      };
  }

调用该函数一次$(document).ready(...)。

现在，这是一个 hack，因为：

为列表中呈现的每个项目创建了一个正则表达式 obj。该正则表达式 obj 应该被重新用于所有项目。
没有用于格式化已完成部分的 CSS 类。这是一种内联样式。
这意味着如果您在同一页面上有多个自动完成，它们都会得到相同的处理。一个 CSS 样式可以解决这个问题。

...但它说明了主要技术，并且可以满足您的基本要求。

替代文字

更新的工作示例： http: //output.jsbin.com/qixaxinuhe

要保留匹配字符串的大小写，而不是使用键入字符的大小写，请使用以下行：

var t = item.label.replace(re,"<span style='font-weight:bold;color:Blue;'>" + 
          "$&" + 
          "</span>");

也就是说，从上面的原始代码开始，只需要替换this.term为"$&".

编辑
以上内容更改了页面上的每个自动完成小部件。如果您只想更改一个，请参阅以下问题：
如何在页面上修补 *just one* 自动完成实例？

score 65 · Accepted Answer

这也有效：

       $.ui.autocomplete.prototype._renderItem = function (ul, item) {
            item.label = item.label.replace(new RegExp("(?![^&;]+;)(?!<[^<>]*)(" + $.ui.autocomplete.escapeRegex(this.term) + ")(?![^<>]*>)(?![^&;]+;)", "gi"), "<strong>$1</strong>");
            return $("<li></li>")
                    .data("item.autocomplete", item)
                    .append("<a>" + item.label + "</a>")
                    .appendTo(ul);
        };

@Jörn Zaefferer 和 @Cheeso 的回复的组合。

score 8 · Accepted Answer

超级有帮助。谢谢你。+1。

这是一个按“字符串必须以术语开头”的简单版本：

function hackAutocomplete(){

    $.extend($.ui.autocomplete, {
        filter: function(array, term){
            var matcher = new RegExp("^" + term, "i");

            return $.grep(array, function(value){
                return matcher.test(value.label || value.value || value);
            });
        }
    });
}

hackAutocomplete();

score 7 · Accepted Answer

在这里，一个功能完整的例子：

<!doctype html>
<html>
<head>
<meta charset="UTF-8">
<title>Autocomplete - jQuery</title>
<link rel="stylesheet" href="http://code.jquery.com/ui/1.10.2/themes/smoothness/jquery-ui.css">
</head>
<body>
<form id="form1" name="form1" method="post" action="">
  <label for="search"></label>
  <input type="text" name="search" id="search" />
</form>

<script src="http://code.jquery.com/jquery-1.9.1.js"></script>
<script src="http://code.jquery.com/ui/1.10.2/jquery-ui.js"></script>
<script>
$(function(){

$.ui.autocomplete.prototype._renderItem = function (ul, item) {
    item.label = item.label.replace(new RegExp("(?![^&;]+;)(?!<[^<>]*)(" + $.ui.autocomplete.escapeRegex(this.term) + ")(?![^<>]*>)(?![^&;]+;)", "gi"), "<strong>$1</strong>");
    return $("<li></li>")
            .data("item.autocomplete", item)
            .append("<a>" + item.label + "</a>")
            .appendTo(ul);
};


var availableTags = [
    "JavaScript",
    "ActionScript",
    "C++",
    "Delphi",
    "Cobol",
    "Java",
    "Ruby",
    "Python",
    "Perl",
    "Groove",
    "Lisp",
    "Pascal",
    "Assembly",
    "Cliper",
];

$('#search').autocomplete({
    source: availableTags,
    minLength: 3
});


});
</script>
</body>
</html>

希望这可以帮助

score 6 · Accepted Answer

jQueryUI 1.9.0 改变了 _renderItem 的工作方式。

下面的代码考虑了这一变化，还显示了我是如何使用 Jörn Zaefferer 的 jQuery Autocomplete 插件进行高亮匹配的。它将突出显示整个搜索词中的所有单个词。

自从开始使用 Knockout 和 jqAuto 后，我发现这是一种更容易设置结果样式的方法。

function monkeyPatchAutocomplete() {
   $.ui.autocomplete.prototype._renderItem = function (ul, item) {

      // Escape any regex syntax inside this.term
      var cleanTerm = this.term.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');

      // Build pipe separated string of terms to highlight
      var keywords = $.trim(cleanTerm).replace('  ', ' ').split(' ').join('|');

      // Get the new label text to use with matched terms wrapped
      // in a span tag with a class to do the highlighting
      var re = new RegExp("(" + keywords + ")", "gi");
      var output = item.label.replace(re,  
         '<span class="ui-menu-item-highlight">$1</span>');

      return $("<li>")
         .append($("<a>").html(output))
         .appendTo(ul);
   };
};

$(function () {
   monkeyPatchAutocomplete();
});

score 3 · Accepted Answer

为了更简单的方法，试试这个：

$('ul: li: a[class=ui-corner-all]').each (function (){      
 //grab each text value 
 var text1 = $(this).text();     
 //grab user input from the search box
 var val = $('#s').val()
     //convert 
 re = new RegExp(val, "ig") 
 //match with the converted value
 matchNew = text1.match(re);
 //Find the reg expression, replace it with blue coloring/
 text = text1.replace(matchNew, ("<span style='font-weight:bold;color:green;'>")  + matchNew +    ("</span>"));

    $(this).html(text)
});
  }

score 3 · Accepted Answer

这是 Ted de Koning 解决方案的重演。这包括：

不区分大小写的搜索
查找多次出现的搜索字符串

$.ui.autocomplete.prototype._renderItem = function (ul, item) {

    var sNeedle     = item.label;
    var iTermLength = this.term.length; 
    var tStrPos     = new Array();      //Positions of this.term in string
    var iPointer    = 0;
    var sOutput     = '';

    //Change style here
    var sPrefix     = '<strong style="color:#3399FF">';
    var sSuffix     = '</strong>';

    //Find all occurences positions
    tTemp = item.label.toLowerCase().split(this.term.toLowerCase());
    var CharCount = 0;
    tTemp[-1] = '';
    for(i=0;i<tTemp.length;i++){
        CharCount += tTemp[i-1].length;
        tStrPos[i] = CharCount + (i * iTermLength) + tTemp[i].length
    }

    //Apply style
    i=0;
    if(tStrPos.length > 0){
        while(iPointer < sNeedle.length){
            if(i<=tStrPos.length){
                //Needle
                if(iPointer == tStrPos[i]){
                    sOutput += sPrefix + sNeedle.substring(iPointer, iPointer + iTermLength) + sSuffix;
                    iPointer += iTermLength;
                    i++;
                }
                else{
                    sOutput += sNeedle.substring(iPointer, tStrPos[i]);
                    iPointer = tStrPos[i];
                }
            }
        }
    }


    return $("<li></li>")
        .data("item.autocomplete", item)
        .append("<a>" + sOutput + "</a>")
        .appendTo(ul);
};

score 2 · Accepted Answer

这是一个不需要任何正则表达式并且匹配标签中的多个结果的版本。

$.ui.autocomplete.prototype._renderItem = function (ul, item) {
            var highlighted = item.label.split(this.term).join('<strong>' + this.term +  '</strong>');
            return $("<li></li>")
                .data("item.autocomplete", item)
                .append("<a>" + highlighted + "</a>")
                .appendTo(ul);
};

score 1 · Accepted Answer

看看组合框演示，它包括结果突出显示：http: //jqueryui.com/demos/autocomplete/#combobox

那里使用的正则表达式也处理 html 结果。

score 1 · Accepted Answer

这是我的版本：

使用 DOM 函数而不是 RegEx 来破坏字符串/注入 span 标签
只有指定的自动完成受到影响，而不是全部
适用于 UI 版本 1.9.x

function highlightText(text, $node) {
    var searchText = $.trim(text).toLowerCase(),
        currentNode = $node.get(0).firstChild,
        matchIndex,
        newTextNode,
        newSpanNode;
    while ((matchIndex = currentNode.data.toLowerCase().indexOf(searchText)) >= 0) {
        newTextNode = currentNode.splitText(matchIndex);
        currentNode = newTextNode.splitText(searchText.length);
        newSpanNode = document.createElement("span");
        newSpanNode.className = "highlight";
        currentNode.parentNode.insertBefore(newSpanNode, currentNode);
        newSpanNode.appendChild(newTextNode);
    }
}
$("#autocomplete").autocomplete({
    source: data
}).data("ui-autocomplete")._renderItem = function (ul, item) {
    var $a = $("<a></a>").text(item.label);
    highlightText(this.term, $a);
    return $("<li></li>").append($a).appendTo(ul);
};

突出显示匹配的文本示例

score 1 · Accepted Answer

您可以使用以下代码：

库：

$.widget("custom.highlightedautocomplete", $.ui.autocomplete, {
    _renderItem: function (ul, item) {
        var $li = $.ui.autocomplete.prototype._renderItem.call(this,ul,item);
        //any manipulation with li
        return $li;
    }
});

和逻辑：

$('selector').highlightedautocomplete({...});

它创建了可以覆盖_renderItem而不覆盖_renderItem原始插件原型的自定义小部件。

在我的示例中还使用原始渲染函数来简化代码

如果您想在不同的地方使用具有不同自动完成视图的插件并且不想破坏您的代码，这一点很重要。

score 0 · Accepted Answer

如果您改为使用 3rd 方插件，它有一个突出显示选项： http ://docs.jquery.com/Plugins/Autocomplete/autocomplete#url_or_dataoptions

（见选项标签）

score 0 · Accepted Answer

要支持多个值，只需添加以下函数：

function getLastTerm( term ) {
  return split( term ).pop();
}

var t = String(item.value).replace(new RegExp(getLastTerm(this.term), "gi"), "<span class='ui-state-highlight'>$&</span>");

javascript - 如何自定义格式自动完成插件结果？

13 回答 13

Related

Reference