README

typeahead.js

受twitter.com的自动完成搜索功能启发，typeahead.js是一个灵活的JavaScript库，为构建强大的自动完成功能提供了坚实的基础。

typeahead.js库由两个组件组成：建议引擎Bloodhound和UI视图Typeahead。建议引擎负责计算给定查询的建议。UI视图负责渲染建议和处理DOM交互。这两个组件都可以单独使用，但一起使用时，可以提供丰富的自动完成体验。

入门指南

如何获取typeahead.js取决于您。

首选方法

• 使用Bower安装：$ bower install typeahead.js

其他方法

• 下载最新版本的zipball.
• 单独下载最新版本的dist文件
  • bloodhound.js（独立的建议引擎）
  • typeahead.jquery.js（独立的UI视图）
  • typeahead.bundle.js（bloodhound.js + typeahead.jquery.js）
  • typeahead.bundle.min.js

注意： bloodhound.js和typeahead.jquery.js都依赖于jQuery 1.9+。

文档

• Typeahead文档
• Bloodhound文档

示例

有关typeahead.js的一些实际示例，请访问示例页面。

浏览器支持

• Chrome
• Firefox 3.5+
• Safari 4+
• Internet Explorer 8+
• Opera 11+

注意：typeahead.js未在移动浏览器上测试。

客户支持

有关typeahead.js的一般问题，请在@typeahead上发推文。

有关技术问题，您应该在Stack Overflow上发布一个问题，并使用typeahead.js标签。

问题

发现了一个错误？请在此GitHub上创建一个问题！

https://github.com/twitter/typeahead.js/issues

版本控制

为了提高透明度和对发布周期的洞察，发布将按照以下格式进行编号

<major>.<minor>.<patch>

并按照以下指南构建

• 破坏向后兼容性会导致主要版本升级
• 不破坏向后兼容性的新功能会导致次要版本升级
• 错误修复和杂项更改会导致补丁版本升级

有关语义版本控制更多信息，请访问http://semver.org/。

测试

测试是用Jasmine编写的，并使用Karma运行。要使用PhantomJS运行测试套件，请运行$ npm test。

开发者

如果您打算为typeahead.js做出贡献，请务必阅读贡献指南。对于新贡献者来说，标注为入门级的问题是一个良好的起点。入门级问题通常需要较小的更改，并给开发者一个机会在承担更具挑战性的工作之前更好地熟悉typeahead.js。

为了构建和测试typeahead.js，您需要安装其开发依赖项（$ npm install）并安装grunt-cli（$ npm install -g grunt-cli）。以下是开发中可能用到的Grunt任务的概述。

• grunt build – 从源代码构建typeahead.js。
• grunt lint – 运行源代码和测试文件通过JSHint。
• grunt watch – 当源文件被修改时，重新构建typeahead.js。
• grunt server – 在localhost:8888上从typeahead.js的根目录提供文件。这对于使用test/playground.html进行调试/测试很有用。
• grunt dev – 并行运行grunt watch和grunt server。

维护者

• Jake Harding

  • @JakeHarding
  • GitHub

• 你呢？

作者

• Jake Harding

  • @JakeHarding
  • GitHub

• Veljko Skarich

  • @vskarich
  • GitHub

• Tim Trueman

  • @timtrueman
  • GitHub

许可证

版权所有 2013 Twitter，Inc。

许可协议：MIT License