-
Notifications
You must be signed in to change notification settings - Fork 11
/
jquery.mentionable.js
381 lines (349 loc) · 10.4 KB
/
jquery.mentionable.js
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
/*!
* jQuery Mentionable
*
* A jQuery plugin that enables the user to mention other people
*
* Copyright(c) 2011 Oozou Limited. by Warut Surapat <warut@oozou.com>
* MIT Licensed.
*
* http://www.oozou.com
* https://github.com/oozou/jquery-mentionable
*/
(function( $ ) {
var cachedName = "";
var fullCachedName = "";
var mentioningUser = false;
var textArea = null;
var container = null;
var userListWrapper = $("<ul id='mentioned-user-list'></ul>");
var userList = null;
var inputText = null;
var targetURL = null;
var onComplete = null;
var options = null;
var debugMode = false;
var debuggerBlock = "<div id='mentionable-debugger'></div>"
var caretStartPosition = 0;
var keyRespondingTimeOut = null;
var keyRespondTime = 500;
var listSize = 0;
var isUserFrameShown = false;
var KEY = {
BACKSPACE: 8,
DELETE: 46,
TAB: 9,
ENTER: 13,
ESCAPE: 27,
SPACE: 32,
PAGE_UP: 33,
PAGE_DOWN: 34,
END: 35,
HOME: 36,
LEFT: 37,
UP: 38,
RIGHT: 39,
DOWN: 40,
NUMPAD_ENTER: 108,
COMMA: 188,
ATSIGN: 64
};
/*
* make a textarea support user mentioning
*
* param usersURL A url to fire an ajax call to retrieve user list.
* param opts An options:
* (id) the id of the user list block.
* (minimumChar) the minimum number of character to trigger user data retrieval
* (parameterName) the query parameter name
* (position) the position of the list (right, bottom, left)
* param onCompleteFunction A callback function when user list is retrieved. Expected to be a user item generation.
*
*/
$.fn.mentionable = function(usersURL, opts, onCompleteFunction) {
textArea = this;
// remove other mentionable text area before enable current one
if($("textarea.mentionable-textarea").length){
$("textarea.mentionable-textarea").val("");
$("textarea.mentionable-textarea").off("keypress");
$("textarea.mentionable-textarea").off("keyup");
}
container = textArea.parent();
targetURL = usersURL;
options = $.extend({
"id" : "mentioned-user-list",
"minimumChar" : 2,
"parameterName" : "mentioning",
"position" : "bottom"
}, opts);
userListWrapper = $("<ul id='" + options.id + "'></ul>");
if(debugMode){
container.before(debuggerBlock);
}
this.keypress(function(e){
watchKey();
switch(e.keyCode){
case KEY.ATSIGN:
initNameCaching();
break;
case KEY.ENTER:
if(mentioningUser){
selectUser(userList.find("li.active"));
e.preventDefault();
}
hideUserFrame();
break;
case KEY.SPACE:
hideUserFrame();
break;
default:
// Firefox hacked!
// There is a problem on FF that @'s keycode returns 0.
// The case KEY.ATSIGN fails to catch, so we need to do it here instead
if(String.fromCharCode(e.charCode) == "@"){
initNameCaching();
}
else{
// append pressed character to cache
if(cachedName != ""){
cachedName += String.fromCharCode(e.charCode);
}
}
}
// if user typed any letter while the caret is not at the end
// completely remove the string behind the caret.
fullCachedName = cachedName;
});
this.keyup(function(e){
switch(e.keyCode){
case KEY.DELETE:
case KEY.BACKSPACE:
// delete or backspace key is pressed
cachedName = cachedName.substring(0, cachedName.length -1);
fullCachedName = cachedName;
if(cachedName==""){
hideUserFrame();
}
else{
watchKey();
}
break;
case KEY.ESCAPE:
hideUserFrame();
break;
case KEY.LEFT:
watchKey();
caretMoveLeft();
break;
case KEY.UP:
caretMoveUp();
break;
case KEY.RIGHT:
watchKey();
caretMoveRight();
break;
case KEY.DOWN:
caretMoveDown();
break;
}
});
};
/*
* initialize a cache that store the user name that is being mentioned
*/
function initNameCaching(){
caretStartPosition = currentCaretPosition();
cachedName = "@";
}
/*
* hide the user list frame, and clear some related stuffs
*/
function hideUserFrame(){
cachedName = "";
fullCachedName = "";
listSize = 0;
mentioningUser = false;
if(isUserFrameShown){
userList.remove();
isUserFrameShown = false;
}
}
/*
* show the user list frame
*/
function showUserFrame(){
container.append(userListWrapper);
mentioningUser = true;
userList = $("#" + options.id);
if(options.position == "left"){
userList.css("left", -1 * userList.outerWidth());
userList.css("top", 0);
}
else if(options.position == "right"){
userList.css("left", textArea.outerWidth());
userList.css("top", 0);
}
else if(options.position == "bottom"){
userList.css("left", 0);
userList.css("top", textArea.outerHeight());
userList.css("width", textArea.outerWidth());
}
userList.show();
isUserFrameShown = true;
}
/*
* replace @ with empyty string, then fire a request for user list
*/
function populateItems(keyword){
if(keyword.length > options.minimumChar){
if(!isUserFrameShown){
showUserFrame();
}
userList.html("");
var data = {};
if(keyword != undefined){
data[options.parameterName] = keyword.substring(1, keyword.length);
}
if(onComplete != undefined){
$.getJSON(targetURL, data, onComplete);
}
else{
$.getJSON(targetURL, data, function(data){
fillItems(data);
});
}
bindItemClicked();
}
}
/*
* fill user name and image as a list item in user list block
*/
function fillItems(data){
if(data.length > 0){
listSize = data.length;
$.each(data, function(key, value){
userList.append("<li><img src='" + value.image_url + "' /><span>" + value.name + "</span></li>");
});
userList.find("li:first-child").attr("class","active");
bindItemClicked();
}
else{
userList.append("<li>No user found</li>");
}
}
/*
* bind item clicked to all item in user list
*/
function bindItemClicked(){
// handle when user item is clicked.
var userListItems = userList.find("li");
userListItems.click(function(){
selectUser($(this));
});
}
/*
* perform an user selection by adding the selected user name
* to the text aprea
*/
function selectUser(userItem){
inputText = textArea.val();
replacedText = replaceString(caretStartPosition, caretStartPosition +
fullCachedName.length, inputText, "@" +
userItem.find("span").html());
textArea.focus();
textArea.val(replacedText);
hideUserFrame();
}
function caretMoveLeft(){
if(mentioningUser){
//remove last char from cachedName while maintaining the fullCachedName
if(cachedName != "@"){
cachedName = fullCachedName.substring(0, cachedName.length - 1);
}
else{
hideUserFrame();
}
}
}
function caretMoveRight(){
if(mentioningUser){
if(cachedName == fullCachedName){
hideUserFrame();
}
else{
//append to the tail the next character retrieved from fullCachedName
cachedName = fullCachedName.substring(0, cachedName.length + 1);
}
}
}
function caretMoveUp(){
currentUserItem = userList.find("li.active");
if(currentUserItem.index() != 0){
previousUserItem = currentUserItem.prev();
currentUserItem.attr("class","");
previousUserItem.attr("class","active");
userList.scrollTop(previousUserItem.index()*previousUserItem.outerHeight());
}
}
function caretMoveDown(){
currentUserItem = userList.find("li.active");
if(currentUserItem.index() != listSize-1){
nextUserItem = currentUserItem.next();
currentUserItem.attr("class","");
nextUserItem.attr("class","active");
userList.scrollTop(nextUserItem.index()*nextUserItem.outerHeight());
}
}
function debug(){
myDebugger = $("#mentionable-debugger");
myDebugger.html("<b>cache : </b>" + cachedName +" | <b>full cache : </b>" + fullCachedName);
}
/*
* return an integer of a curret caret position
*/
function currentCaretPosition(){
caretContainer = textArea[0];
return caretContainer.selectionStart;
}
/*
* replace a part of originalString from [from] to [to] position with addedString
* param from An integer of a begining position
* param to An itenger of an ending position
* param originalString An original string to be partialy replaced
* param addedString A string to be replaced
*/
function replaceString(from, to, originalString, addedString){
try{
if(from == 0){
return addedString + originalString.substring(to, originalString.length);
}
if(from != 0){
firstChunk = originalString.substring(0, from);
lastChunk = originalString.substring(to, originalString.length);
return firstChunk + addedString + lastChunk;
}
}
catch(error){
return originalString;
}
}
/*
* initialize the key timeout. It will observe the user interaction.
* If the user did not respond within a specific time, e.g. pausing typing,
* it will fire poplateItems()
*/
function watchKey(){
clearTimeout(keyRespondingTimeOut);
keyRespondingTimeOut = setTimeout(
function(){
populateItems(cachedName);
},
keyRespondTime
);
}
/*
* return a jquery object of the user list item that is in an active state
*/
function activeUserItemIndex(){
return userList.find("li.active").index();
}
})( jQuery );