README

corejs-typeahead

这是对twitter.com的自动补全搜索库typeahead.js的维护分支。

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

入门指南

如何获取typeahead.js由您决定

• 使用Bower安装：$ bower install corejs-typeahead

• 使用npm安装：$ npm install corejs-typeahead

• 使用composer安装：$ composer require corejavascript/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标签。

问题

发现了bug？请在GitHub上创建一个问题！

github.com/corejavascript/typeahead.js/issues

版本控制

为了透明度和对我们发布周期的深入了解，版本号将采用以下格式

<主版本>.<次版本>.<修补程序>

并遵循以下准则

• 破坏向后兼容性将增加主版本
• 不破坏向后兼容性的新功能增加次版本
• 错误修复和杂项更改增加修补程序

有关语义版本控制更多信息，请访问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。

维护者

• CoreJS 合作伙伴

• 你呢？

作者

• Jake Harding

  • @JakeHarding
  • GitHub

• Veljko Skarich

  • @vskarich
  • GitHub

• Tim Trueman

  • @timtrueman
  • GitHub

许可证

版权所有 2013 Twitter, Inc。

许可协议 MIT License