README

typeahead.js

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

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

入门指南

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

首选方法

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

其他方法

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

注意：both bloodhound.js and 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

版本控制

为了透明度和了解我们的发布周期，版本号将按照以下格式进行编号

<主要>.<次要>.<补丁>

并遵循以下准则

• 破坏向后兼容性会增加主要版本号
• 没有破坏向后兼容性的新功能会增加次要版本号
• 错误修复和杂项更改会增加补丁版本号

有关语义化版本控制的更多信息，请访问 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 许可协议