summaryrefslogtreecommitdiffstats
path: root/apps/comments/js/vendor/At.js/README.md
blob: 551820afbb84a92f57d5d0264703b4128c69ee8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
**An autocompletion library to autocomplete mentions, smileys etc. just like on Github!**  
[![Build Status](https://travis-ci.org/ichord/At.js.png)](https://travis-ci.org/ichord/At.js)

#### Notice

At.js now **depends on** [Caret.js](https://github.com/ichord/Caret.js).  
Please read [**CHANGELOG.md**](CHANGELOG.md) for more details if you are going to update to new version.

### Demo
http://ichord.github.com/At.js

### Documentation
https://github.com/ichord/At.js/wiki

### Compatibility

* `textarea` - Chrome, Safari, Firefox, IE7+ (maybe IE6)
* `contentEditable` - Chrome, Safari, Firefox, IE9+

### Features Preview

* Support IE 7+ for **textarea**.
* Supports HTML5  [**contentEditable**](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Content_Editable) elements (NOT including IE 8)
* Can listen to any character and not just '@'. Can set up multiple listeners for different characters with different behavior and data
* Listener events can be bound to multiple inputors.
* Format returned data using templates
* Keyboard controls in addition to mouse
    - `Tab` or `Enter` keys select the value
    - `Up` and `Down` navigate between values (and `Ctrl-P` and `Ctrl-N` also)
    - `Right` and `left` will re-search the keyword.
* Custom data handlers and template renderers using a group of configurable callbacks
* Supports AMD

### Requirements

* jQuery >= 1.7.0.
* [Caret.js](https://github.com/ichord/Caret.js)
    (You can use `Component` or `Bower` to install it.)

### Integrating with your Application

Simply include the following files in your HTML and you are good to go.

```html
<link href="css/jquery.atwho.css" rel="stylesheet">
<script src="http://code.jquery.com/jquery.js"></script>
<script src="js/jquery.caret.js"></script>
<script src="js/jquery.atwho.js"></script>
```

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

#### Bower & Component
For installing using Bower you can use `jquery.atwho` and for Component please use `ichord/At.js`.

#### Rails
You can include At.js in your `Rails` application using the gem [jquery-atwho-rails](https://github.com/ichord/jquery-atwho-rails).

### Core Team Members

* [@ichord](https://twitter.com/_ichord) (twitter)