|
| 1 | +**An autocompletion library to autocomplete mentions, smileys etc. just like on Github or Twitter!** [](https://travis-ci.org/ichord/At.js) |
| 2 | + |
| 3 | +#### Notice |
| 4 | + |
| 5 | +At.js now **depends on** [Caret.js](https://github.com/ichord/Caret.js). |
| 6 | + |
| 7 | +This branch has been updated to `v0.4.x`. Please read **CHANGELOG.md** for more details. |
| 8 | +English Documentation will keep improving. Maybe **you can do me a favor?** |
| 9 | + |
| 10 | +### Demo |
| 11 | + |
| 12 | +http://ichord.github.com/At.js |
| 13 | + |
| 14 | + |
| 15 | +### Features Preview |
| 16 | + |
| 17 | +* Supports HTML5 [**contentEditable**](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Content_Editable) elements (NOT include IE 8) |
| 18 | +* Can listen to any character and not just '@'. Can set up multiple listeners for different characters with different behavior and data |
| 19 | +* Listener events can be bound to multiple inputors. |
| 20 | +* Format returned data using templates |
| 21 | +* Keyboard controls in addition to mouse |
| 22 | + - `Tab` or `Enter` keys select the value |
| 23 | + - `Up` and `Down` navigate between values (and `Ctrl-P` and `Ctrl-N` also) |
| 24 | + - `Right` and `left` will re-search the keyword. |
| 25 | +* Custom data handlers and template renderers using a group of configurable callbacks |
| 26 | +* Supports AMD |
| 27 | + |
| 28 | +### Requirements |
| 29 | + |
| 30 | +* jQuery >= 1.7.0. |
| 31 | +* [Caret.js](https://github.com/ichord/Caret.js) |
| 32 | + (You can use `Component` or `Bower` to install it.) |
| 33 | + |
| 34 | +### Documentation |
| 35 | +https://github.com/ichord/At.js/wiki |
| 36 | + |
| 37 | +### Integrating with your Application |
| 38 | + |
| 39 | +Simply include the following files in your HTML and you are good to go. |
| 40 | + |
| 41 | +```html |
| 42 | +<link href="css/jquery.atwho.css" rel="stylesheet"> |
| 43 | +<script src="http://code.jquery.com/jquery.js"></script> |
| 44 | +<script src="js/jquery.caret.js"></script> |
| 45 | +<script src="js/jquery.atwho.js"></script> |
| 46 | +``` |
| 47 | + |
| 48 | +```javascript |
| 49 | +$('#inputor').atwho({ |
| 50 | + at: "@", |
| 51 | + data:['Peter', 'Tom', 'Anne'] |
| 52 | +}) |
| 53 | +``` |
| 54 | + |
| 55 | +#### Bower & Component |
| 56 | +For installing using Bower you can use `jquery.atwho` and for Component please use `ichord/At.js`. |
| 57 | + |
| 58 | +#### Rails |
| 59 | +You can include At.js in your `Rails` application using the gem [`jquery-atwho-rails`](https://github.com/ichord/jquery-atwho-rails). |
| 60 | + |
| 61 | + |
| 62 | +### Version History |
| 63 | + |
| 64 | +* branch `stable-v0.3` with tag `v0.3.3` |
| 65 | +* branch `stable-v0.2` with tag `v0.2.x` |
| 66 | +* branch `stable-v0.1.x` and tag `v0.1.7` |
| 67 | + |
| 68 | +### Core Team Members |
| 69 | + |
| 70 | +* [@ichord](https://twitter.com/_ichord) |
| 71 | + |
| 72 | +#### PS |
| 73 | +Let me know if you are using **At.js**. It will motivate me to work harder. |
| 74 | +And if you like **At.js**, just email me and add your website [here](https://github.com/ichord/At.js/wiki/Sites) |
| 75 | +Hope you like it, Thanks! :) |
| 76 | + |
| 77 | +--- |
| 78 | + |
| 79 | +Project is a member of the [OSS Manifesto](http://ossmanifesto.org/). |
0 commit comments