Bootstrap Typeahead 组件_综合

Bootstrap 中的 Typeahead 组件就是通常所说的自动完成 AutoComplete，功能很强大，但是，使用上并不太方便。这里我们将介绍一下这个组件的使用。

第一，简单使用

首先，最简单的使用方式，就是直接在标记中声明，通过 data-provide="typeahead"　来声明这是一个 typeahead 组件，通过 data-source= 来提供数据。当然了，你还必须提供 bootstrap-typeahead.js 脚本。

<html>
<head>
<link href="bootstrap.min.css" rel="stylesheet" type="text/css" />
</head>
<body><div style="margin: 50px 50px">
<label for="product_search">Product Search: </label>
<input id="product_search" type="text" data-provide="typeahead"data-source='["Deluxe Bicycle", "Super Deluxe Trampoline", "Super Duper Scooter"]'>
</div><script src="js/jquery-1.8.3.min.js"></script>
<script src="js/bootstrap-typeahead.js"></script></body>
</html>

第二，使用脚本填充数据

通常，我们使用脚本来填充数据，那么，页面可以变成如下的形式。

<html>
<head>
<link href="bootstrap.min.css" rel="stylesheet" type="text/css" />
</head>
<body><div style="margin: 50px 50px">
<label for="product_search">Product Search: </label>
<input id="product_search" type="text" data-provide="typeahead">
</div><script src="js/jquery-1.8.3.min.js"></script>
<script src="js/bootstrap-typeahead.js"></script><script>
$(document).ready(function($) {// Workaround for bug in mouse item selection$.fn.typeahead.Constructor.prototype.blur = function() {var that = this;setTimeout(function () { that.hide() }, 250);};$('#product_search').typeahead({source: function(query, process) {return ["Deluxe Bicycle", "Super Deluxe Trampoline", "Super Duper Scooter"];}});
})
</script></body>
</html>

注意，我们提供了一个 source 函数来提供数据，这个函数接收两个参数，第一个参数 query 表示用户的输入，第二个参数是 process 函数，这个 process 函数是 typeahead 提供的，用来处理我们的数据。

如果你希望通过 Ajax 调用从服务器端获取匹配的数据，那么，在异步完成的处理函数中，你需要获取一个匹配的字符串数组，然后，将这个数组作为参数，调用 process 函数。

第三，支持 Ajax 获取数据

说了半天，数据都是从本地获取的，到底如何从服务器端获取数据呢？

其实很简单，在 source 函数中，自己调用 Ajax 方法来获取数据，主要注意的是，在获取数据之后，调用 typeahead 的 process 函数处理即可。

$('#product_search').typeahead({source: function (query, process) {var parameter = {query: query};$.post('@Url.Action("AjaxService")', parameter, function (data) {process(data);});}
});

当然了，在服务器上，你需要创建一个服务来提供数据，这里，我们演示使用随机数来生成一组随机数据的方法。

public ActionResult AjaxService(string query)
{System.Collections.ArrayList list= new System.Collections.ArrayList();System.Random random = new Random();for (int i = 0; i < 20; i++){string item  = string.Format("{0}{1}", query, random.Next(10000));list.Add(item);}return this.Json(list);
}

第四，使用 highlighter 和 updater

除了使用 source 函数之外，还可以使用 highlighter 函数来特别处理匹配项目的显示，使用 updater 函数，在选择了某个匹配项之后，做出一些后继的处理。

默认的 highlighter 是这样实现的，item 是匹配的项目，找到匹配的部分之后，使用 <strong> 加粗了。

highlighter: function (item) {var query = this.query.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g, '\\$&')return item.replace(new RegExp('(' + query + ')', 'ig'), function ($1, match) {return '<strong>' + match + '</strong>'})
}

而 updater 的默认实现就更加简单了。

updater: function (item) {return item
}

我们可以重写这两个函数，来实现自定义的处理。

<html>
<head>
<link href="bootstrap.min.css" rel="stylesheet" type="text/css" />
</head>
<body><div style="margin: 50px 50px">
<label for="product_search">Product Search: </label>
<input id="product_search" type="text" data-provide="typeahead">
</div><script src="js/jquery-1.8.3.min.js"></script>
<script src="js/bootstrap-typeahead.js"></script><script>
$(document).ready(function($) {// Workaround for bug in mouse item selection$.fn.typeahead.Constructor.prototype.blur = function() {var that = this;setTimeout(function () { that.hide() }, 250);};$('#product_search').typeahead({source: function(query, process) {return ["Deluxe Bicycle", "Super Deluxe Trampoline", "Super Duper Scooter"];},highlighter: function(item) {return "==>" + item + "<==";},updater: function(item) {console.log("'" + item + "' selected.");return item;
}
});
})
</script>
</body>
</html>

第五，使用对象数据

实际上，你的数据可能是一组对象而不是一个字符串数组，下面的例子中，我们使用一个产品对象的数组来说明，每个产品对象有一个 id 编号，还有名称 name 和价格 price .

<html>
<head><link href="~/Content/dist/css/bootstrap.min.css" rel="stylesheet" />
</head>
<body><div style="margin: 50px 50px"><label for="product_search">Product Search: </label><input id="product_search" type="text" data-provide="typeahead"></div><script src="~/Content/dist/js/jquery.js"></script><script src="~/Content/dist/js/bootstrap-typeahead.js"></script><script src="~/Content/dist/js/underscore-min.js"></script><script>$(document).ready(function ($) {// Workaround for bug in mouse item selection
            $.fn.typeahead.Constructor.prototype.blur = function () {var that = this;setTimeout(function () { that.hide() }, 250);};var products = [{id: 0,name: "Deluxe Bicycle",price: 499.98},{id: 1,name: "Super Deluxe Trampoline",price: 134.99},{id: 2,name: "Super Duper Scooter",price: 49.95}];$('#product_search').typeahead({source: function (query, process) {var results = _.map(products, function (product) {return product.name;});process(results);},highlighter: function (item) {return "==>" + item + "<==";},updater: function (item) {console.log("'" + item + "' selected.");return item;}});})</script></body>
</html>

第六，高级用法

我们希望能够在提示中显示产品的更加详细的信息。

首先，修改我们的 source 函数，原来这个函数返回一个字符串的数组，现在我们返回一个产品 id 的数组，但是，process 函数期望得到一个字符串数组的参数，所以，我们将每个 id 都转换为字符串类型。

然后，typeahead 组件就会调用 matcher 函数来检查用户的输入是否与某个项目匹配，你可以使用产品的 id 在产品列表中获取产品对象，然后检查产品的名称与用户的输入是否匹配。

默认的 matcher 直接使用用户的输入来匹配，我们如果使用 id 的话，显然不能匹配，我们需要重写 matcher 函数。

matcher 接收一个当前项目的字符串，用户当前的输入为 this.query，匹配返回 true, 否则返回 false. 默认的 matcher 如下：

, matcher: function (item) {return ~item.toLowerCase().indexOf(this.query.toLowerCase())
}

将它重写为永远匹配，直接返回 true。而在 highlighter 中将显示结果替换为希望的产品名称和价格组合。在下一步的 highlighter 中，我们使用 Underscore 组件中的 find 方法，通过产品的 id 在产品列表中获取产品对象，然后，显示产品名称和价格的组合。

highlighter: function (id) {var product = _.find(products, function (p) {return p.id == id;});return product.name + " ($" + product.price + ")";
}

默认的 updater 直接返回当前匹配的内容，我们这里是一个 id, 需要重写。

updater: function (item) {return item
}

在用户选择之后，typeahead 将会调用 updater 函数，我们通过产品的 id 在产品列表中获取产品对象，然后

最后，updater 函数返回一个产品名称的字符串，为输入框提供内容。setSelectedProduct 是我们的一个自定义函数。

updater: function (id) {var product = _.find(products, function (p) {return p.id == id;});that.setSelectedProduct(product);return product.name;
}

下面是全部的代码。

<html>
<head><link href="~/Content/dist/css/bootstrap.min.css" rel="stylesheet" /></head>
<body><div style="margin: 50px 50px"><label for="product_search">Product Search: </label><input id="product_search" type="text" data-provide="typeahead"><div id="product" style="border-width: 1; padding: 5px; border-style: solid"></div></div><script src="~/Content/dist/js/jquery.js"></script><script src="~/Content/dist/js/bootstrap-typeahead.js"></script><script src="~/Content/dist/js/underscore-min.js"></script><script>$(document).ready(function ($) {// Workaround for bug in mouse item selection
            $.fn.typeahead.Constructor.prototype.blur = function () {var that = this;setTimeout(function () { that.hide() }, 250);};var products = [{id: 0,name: "Deluxe Bicycle",price: 499.98},{id: 1,name: "Super Deluxe Trampoline",price: 134.99},{id: 2,name: "Super Duper Scooter",price: 49.95}];var that = this;$('#product_search').typeahead({source: function (query, process) {$('#product').hide();var results = _.map(products, function (product) {return product.id + "";});process(results);},matcher: function (item) {return true;},highlighter: function (id) {var product = _.find(products, function (p) {return p.id == id;});return product.name + " ($" + product.price + ")";},updater: function (id) {var product = _.find(products, function (p) {return p.id == id;});that.setSelectedProduct(product);return product.name;}});$('#product').hide();this.setSelectedProduct = function (product) {$('#product').html("Purchase: <strong>" + product.name + " ($" + product.price + ")</strong>").show();}})</script></body>
</html>

参考资料

Twitter Boostrap Typeahead Tutorial

typeahead 下载地址

underscore 下载地址

typeahead()详解

参考官方README和其他一些博客的资料，可以了解typeahead函数可以接受的一些参数，这些参数可以通过指定标签属性来传递，也可以直接在JavaScript中给出。对于标签属性传递参数来说，需要在参数前加上data-，例如data-source="".

下表为官方README文档中参数表格的翻译版本：

Name	Type	Default	Description
source	array, function	[]	用来查询的数据源。可以是数组或字符串，一个带有name属性的JSON对象的数组集合，或者一个函数。函数可以接受两个参数，query代表输入框中你的输入值（即查询值）,process回调函数。The function may be used synchronously by returning the data source directly or asynchronously via the `process` callback's single argument.
items	number	8	下拉选项中出现条目的最大数量。也可以设置为“all”
minLength	number	1	出发下拉提示的最小长度字符串。可以设置为0，即使没有填写任何内容，也会出现提示。
showHintOnFocus	boolean or "all"	false	当输入框获得焦点时立刻显示提示。如果设置为true，显示所有匹配项。如果设置为“all”，显示所有提示，并不会按照当前文本过滤。当你需要一个组合框（Combo Box，由文本框和下拉框组成）功能时，可以考虑这个。
scrollHeight	number, function	0	Number of pixels the scrollable parent container scrolled down (scrolled out the viewport).
matcher	function	case insensitive	该函数用来确定匹配条目的规则。接受一个参数，item用于测试查询字符串是否匹配。通过当前查询字符串this.query。如果相匹配则返回true
sorter	function	exact match, case sensitive, case insensitive	该函数用来对结果进行排序。接受一个参数items并且具有typeahead实例的作用域，通过this.query得到当前查询。
updater	function	returns selected item	该函数用来返回选中的条目。接受一个item参数并且具有typeahead实例的作用域。
highlighter	function	highlights all default matches	用来高亮自动补全的结果。接受一个item参数并且拥有typeahead实例的作用域。应该返回html
displayText	function	item.name \|\| item	用来得到数据源的条目的文本表示。接受一个item参数并且拥有typeahead实例的作用域。应该返回一个字符串。
autoSelect	boolean	true	允许你决定是否自动选择第一个建议。关闭它意味着如果没有选择任何内容（或Enter或Tab），输入将不会清空。
afterSelect	function	$.noop()	选择一个条目后的回调函数。It gets the current active item in parameter if any.
delay	integer	0	在查找之间添加延迟
appendTo	jQuery element	null	默认情况下，菜单将会出现在输入元素的之后。使用这个选项来添加菜单到其他div。如果你想使用bootstrap的dropup或者dropdown-menu-right classes，就不要使用它
fitToElement	boolean	false	如果你希望菜单的大小与其所链接的输入的大小相同，置为true
addItem	JSON object	false	在list的最后添加一个条目，例如“New Entry”。这可能被用到，例如当一个条目在数据集中没有被找