At.js 自动补全库技术文档

1. 安装指南

在开始使用At.js之前，请确保您的项目中已经包含了以下依赖：

• jQuery (版本不低于1.7.0)
• Caret.js

您可以通过以下方式获取这些依赖：

• 使用npm或yarn等包管理工具进行安装。
• 直接在HTML文件中通过<script>标签引入jQuery和Caret.js的CDN链接。

接下来，您需要引入At.js的相关资源：

<link href="css/jquery.atwho.css" rel="stylesheet">
<script src="js/jquery.caret.js"></script>
<script src="js/jquery.atwho.js"></script>

确保这些资源正确地被引入到您的HTML页面中。

2. 项目的使用说明

At.js是一个自动补全提及、表情等内容的库，类似于在GitHub中看到的功能。它支持在textarea和HTML5的contentEditable元素上使用。

使用At.js非常简单，以下是一个基本的使用例子：

$('#inputor').atwho({
    at: "@",
    data: ['Peter', 'Tom', 'Anne']
});

在上面的代码中，#inputor是您希望绑定自动补全功能的输入框的ID，at选项定义了触发自动补全的字符（在这个例子中是@），data选项则是提供自动补全建议的数据数组。

3. 项目API使用文档

At.js提供了丰富的API，允许您自定义自动补全的行为。以下是一些常用的API选项：

• at: 触发自动补全的字符。
• data: 提供自动补全建议的数据源，可以是字符串数组，也可以是对象数组。
• callbacks: 一组可配置的回调函数，用于自定义数据处理器和模板渲染器。
• template: 自定义模板，用于格式化返回的数据。

更多API选项和详细说明，请查看项目的官方文档。

4. 项目安装方式

您可以通过以下几种方式安装At.js：

• 通过Bower安装：运行bower install jquery.atwho。
• 通过Component安装：运行component install ichord/At.js。
• 在Rails项目中使用gem：添加jquery-atwho-rails到您的Gemfile中。

请根据您的项目需求和偏好选择合适的安装方式。

以上就是关于At.js自动补全库的技术文档，希望对您的开发有所帮助。