summaryrefslogtreecommitdiff
path: root/resources/jquery/jquery.suggestions.js
blob: 28e2afc45c71e53faa4f62b16447f15e26705466 (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
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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
/**
 * This plugin provides a generic way to add suggestions to a text box.
 *
 * Usage:
 *
 * Set options:
 *		$( '#textbox' ).suggestions( { option1: value1, option2: value2 } );
 *		$( '#textbox' ).suggestions( option, value );
 * Get option:
 *		value = $( '#textbox' ).suggestions( option );
 * Initialize:
 *		$( '#textbox' ).suggestions();
 *
 * Options:
 *
 * fetch(query): Callback that should fetch suggestions and set the suggestions property.
 *      Executed in the context of the textbox
 *		Type: Function
 * cancel: Callback function to call when any pending asynchronous suggestions fetches
 *      should be canceled. Executed in the context of the textbox
 *		Type: Function
 * special: Set of callbacks for rendering and selecting
 *		Type: Object of Functions 'render' and 'select'
 * result: Set of callbacks for rendering and selecting
 *		Type: Object of Functions 'render' and 'select'
 * $region: jQuery selection of element to place the suggestions below and match width of
 *		Type: jQuery Object, Default: $(this)
 * suggestions: Suggestions to display
 *		Type: Array of strings
 * maxRows: Maximum number of suggestions to display at one time
 *		Type: Number, Range: 1 - 100, Default: 7
 * delay: Number of ms to wait for the user to stop typing
 *		Type: Number, Range: 0 - 1200, Default: 120
 * submitOnClick: Whether to submit the form containing the textbox when a suggestion is clicked
 *		Type: Boolean, Default: false
 * maxExpandFactor: Maximum suggestions box width relative to the textbox width. If set
 *      to e.g. 2, the suggestions box will never be grown beyond 2 times the width of the textbox.
 *		Type: Number, Range: 1 - infinity, Default: 3
 * expandFrom: Which direction to offset the suggestion box from.
 *      Values 'start' and 'end' translate to left and right respectively depending on the
 *      directionality of the current document, according to $( 'html' ).css( 'direction' ).
 *      Type: String, default: 'auto', options: 'left', 'right', 'start', 'end', 'auto'.
 * positionFromLeft: Sets expandFrom=left, for backwards compatibility
 *		Type: Boolean, Default: true
 * highlightInput: Whether to hightlight matched portions of the input or not
 *		Type: Boolean, Default: false
 */
( function ( $ ) {

$.suggestions = {
	/**
	 * Cancel any delayed maybeFetch() call and callback the context so
	 * they can cancel any async fetching if they use AJAX or something.
	 */
	cancel: function ( context ) {
		if ( context.data.timerID !== null ) {
			clearTimeout( context.data.timerID );
		}
		if ( $.isFunction( context.config.cancel ) ) {
			context.config.cancel.call( context.data.$textbox );
		}
	},

	/**
	 * Restore the text the user originally typed in the textbox, before it
	 * was overwritten by highlight(). This restores the value the currently
	 * displayed suggestions are based on, rather than the value just before
	 * highlight() overwrote it; the former is arguably slightly more sensible.
	 */
	restore: function ( context ) {
		context.data.$textbox.val( context.data.prevText );
	},

	/**
	 * Ask the user-specified callback for new suggestions. Any previous delayed
	 * call to this function still pending will be canceled. If the value in the
	 * textbox is empty or hasn't changed since the last time suggestions were fetched,
	 * this function does nothing.
	 * @param {Boolean} delayed Whether or not to delay this by the currently configured amount of time
	 */
	update: function ( context, delayed ) {
		// Only fetch if the value in the textbox changed and is not empty, or if the results were hidden
		// if the textbox is empty then clear the result div, but leave other settings intouched
		function maybeFetch() {
			if ( context.data.$textbox.val().length === 0 ) {
				context.data.$container.hide();
				context.data.prevText = '';
			} else if (
				context.data.$textbox.val() !== context.data.prevText ||
				!context.data.$container.is( ':visible' )
			) {
				if ( typeof context.config.fetch === 'function' ) {
					context.data.prevText = context.data.$textbox.val();
					context.config.fetch.call( context.data.$textbox, context.data.$textbox.val() );
				}
			}
		}

		// Cancels any delayed maybeFetch call, and invokes context.config.cancel.
		$.suggestions.cancel( context );

		if ( delayed ) {
			// To avoid many started/aborted requests while typing, we're gonna take a short
			// break before trying to fetch data.
			context.data.timerID = setTimeout( maybeFetch, context.config.delay );
		} else {
			maybeFetch();
		}
		$.suggestions.special( context );
	},

	special: function ( context ) {
		// Allow custom rendering - but otherwise don't do any rendering
		if ( typeof context.config.special.render === 'function' ) {
			// Wait for the browser to update the value
			setTimeout( function () {
				// Render special
				var $special = context.data.$container.find( '.suggestions-special' );
				context.config.special.render.call( $special, context.data.$textbox.val(), context );
			}, 1 );
		}
	},

	/**
	 * Sets the value of a property, and updates the widget accordingly
	 * @param property String Name of property
	 * @param value Mixed Value to set property with
	 */
	configure: function ( context, property, value ) {
		var newCSS,
			$autoEllipseMe, $result, $results, childrenWidth,
			i, expWidth, matchedText, maxWidth, text;

		// Validate creation using fallback values
		switch( property ) {
			case 'fetch':
			case 'cancel':
			case 'special':
			case 'result':
			case '$region':
			case 'expandFrom':
				context.config[property] = value;
				break;
			case 'suggestions':
				context.config[property] = value;
				// Update suggestions
				if ( context.data !== undefined ) {
					if ( context.data.$textbox.val().length === 0 ) {
						// Hide the div when no suggestion exist
						context.data.$container.hide();
					} else {
						// Rebuild the suggestions list
						context.data.$container.show();
						// Update the size and position of the list
						newCSS = {
							top: context.config.$region.offset().top + context.config.$region.outerHeight(),
							bottom: 'auto',
							width: context.config.$region.outerWidth(),
							height: 'auto'
						};

						// Process expandFrom, after this it is set to left or right.
						context.config.expandFrom = ( function ( expandFrom ) {
							var regionWidth, docWidth, regionCenter, docCenter,
								docDir = $( document.documentElement ).css( 'direction' ),
								$region = context.config.$region;

							// Backwards compatible
							if ( context.config.positionFromLeft ) {
								expandFrom = 'left';

							// Catch invalid values, default to 'auto'
							} else if ( $.inArray( expandFrom, ['left', 'right', 'start', 'end', 'auto'] ) === -1 ) {
								expandFrom = 'auto';
							}

							if ( expandFrom === 'auto' ) {
								if ( $region.data( 'searchsuggest-expand-dir' ) ) {
									// If the markup explicitly contains a direction, use it.
									expandFrom = $region.data( 'searchsuggest-expand-dir' );
								} else {
									regionWidth = $region.outerWidth();
									docWidth = $( document ).width();
									if ( ( regionWidth / docWidth  ) > 0.85 ) {
										// If the input size takes up more than 85% of the document horizontally
										// expand the suggestions to the writing direction's native end.
										expandFrom = 'start';
									} else {
										// Calculate the center points of the input and document
										regionCenter = $region.offset().left + regionWidth / 2;
										docCenter = docWidth / 2;
										if ( Math.abs( regionCenter - docCenter ) / docCenter < 0.10 ) {
											// If the input's center is within 10% of the document center
											// use the writing direction's native end.
											expandFrom = 'start';
										} else {
											// Otherwise expand the input from the closest side of the page,
											// towards the side of the page with the most free open space
											expandFrom = regionCenter > docCenter ? 'right' : 'left';
										}
									}
								}
							}

							if ( expandFrom === 'start' ) {
								expandFrom = docDir === 'rtl' ? 'right': 'left';

							} else if ( expandFrom === 'end' ) {
								expandFrom = docDir === 'rtl' ? 'left': 'right';
							}

							return expandFrom;

						}( context.config.expandFrom ) );

						if ( context.config.expandFrom === 'left' ) {
							// Expand from left
							newCSS.left = context.config.$region.offset().left;
							newCSS.right = 'auto';
						} else {
							// Expand from right
							newCSS.left = 'auto';
							newCSS.right = $( document ).width() - ( context.config.$region.offset().left + context.config.$region.outerWidth() );
						}

						context.data.$container.css( newCSS );
						$results = context.data.$container.children( '.suggestions-results' );
						$results.empty();
						expWidth = -1;
						$autoEllipseMe = $( [] );
						matchedText = null;
						for ( i = 0; i < context.config.suggestions.length; i++ ) {
							/*jshint loopfunc:true */
							text = context.config.suggestions[i];
							$result = $( '<div>' )
								.addClass( 'suggestions-result' )
								.attr( 'rel', i )
								.data( 'text', context.config.suggestions[i] )
								.mousemove( function () {
									context.data.selectedWithMouse = true;
									$.suggestions.highlight(
										context,
										$(this).closest( '.suggestions-results .suggestions-result' ),
										false
									);
								} )
								.appendTo( $results );
							// Allow custom rendering
							if ( typeof context.config.result.render === 'function' ) {
								context.config.result.render.call( $result, context.config.suggestions[i], context );
							} else {
								// Add <span> with text
								$result.append( $( '<span>' )
										.css( 'whiteSpace', 'nowrap' )
										.text( text )
									);
							}

							if ( context.config.highlightInput ) {
								matchedText = context.data.prevText;
							}

							// Widen results box if needed
							// New width is only calculated here, applied later
							childrenWidth = $result.children().outerWidth();
							if ( childrenWidth > $result.width() && childrenWidth > expWidth ) {
								// factor in any padding, margin, or border space on the parent
								expWidth = childrenWidth + ( context.data.$container.width() - $result.width() );
							}
							$autoEllipseMe = $autoEllipseMe.add( $result );
						}
						// Apply new width for results box, if any
						if ( expWidth > context.data.$container.width() ) {
							maxWidth = context.config.maxExpandFactor*context.data.$textbox.width();
							context.data.$container.width( Math.min( expWidth, maxWidth ) );
						}
						// autoEllipse the results. Has to be done after changing the width
						$autoEllipseMe.autoEllipsis( {
							hasSpan: true,
							tooltip: true,
							matchText: matchedText
						} );
					}
				}
				break;
			case 'maxRows':
				context.config[property] = Math.max( 1, Math.min( 100, value ) );
				break;
			case 'delay':
				context.config[property] = Math.max( 0, Math.min( 1200, value ) );
				break;
			case 'maxExpandFactor':
				context.config[property] = Math.max( 1, value );
				break;
			case 'submitOnClick':
			case 'positionFromLeft':
			case 'highlightInput':
				context.config[property] = value ? true : false;
				break;
		}
	},

	/**
	 * Highlight a result in the results table
	 * @param result <tr> to highlight: jQuery object, or 'prev' or 'next'
	 * @param updateTextbox If true, put the suggestion in the textbox
	 */
	highlight: function ( context, result, updateTextbox ) {
		var selected = context.data.$container.find( '.suggestions-result-current' );
		if ( !result.get || selected.get( 0 ) !== result.get( 0 ) ) {
			if ( result === 'prev' ) {
				if( selected.hasClass( 'suggestions-special' ) ) {
					result = context.data.$container.find( '.suggestions-result:last' );
				} else {
					result = selected.prev();
					if ( !( result.length && result.hasClass( 'suggestions-result' ) ) ) {
						// there is something in the DOM between selected element and the wrapper, bypass it
						result = selected.parents( '.suggestions-results > *' ).prev().find( '.suggestions-result' ).eq(0);
					}

					if ( selected.length === 0 ) {
						// we are at the beginning, so lets jump to the last item
						if ( context.data.$container.find( '.suggestions-special' ).html() !== '' ) {
							result = context.data.$container.find( '.suggestions-special' );
						} else {
							result = context.data.$container.find( '.suggestions-results .suggestions-result:last' );
						}
					}
				}
			} else if ( result === 'next' ) {
				if ( selected.length === 0 ) {
					// No item selected, go to the first one
					result = context.data.$container.find( '.suggestions-results .suggestions-result:first' );
					if ( result.length === 0 && context.data.$container.find( '.suggestions-special' ).html() !== '' ) {
						// No suggestion exists, go to the special one directly
						result = context.data.$container.find( '.suggestions-special' );
					}
				} else {
					result = selected.next();
					if ( !( result.length && result.hasClass( 'suggestions-result' ) ) ) {
						// there is something in the DOM between selected element and the wrapper, bypass it
						result = selected.parents( '.suggestions-results > *' ).next().find( '.suggestions-result' ).eq(0);
					}

					if ( selected.hasClass( 'suggestions-special' ) ) {
						result = $( [] );
					} else if (
						result.length === 0 &&
						context.data.$container.find( '.suggestions-special' ).html() !== ''
					) {
						// We were at the last item, jump to the specials!
						result = context.data.$container.find( '.suggestions-special' );
					}
				}
			}
			selected.removeClass( 'suggestions-result-current' );
			result.addClass( 'suggestions-result-current' );
		}
		if ( updateTextbox ) {
			if ( result.length === 0 || result.is( '.suggestions-special' ) ) {
				$.suggestions.restore( context );
			} else {
				context.data.$textbox.val( result.data( 'text' ) );
				// .val() doesn't call any event handlers, so
				// let the world know what happened
				context.data.$textbox.change();
			}
			context.data.$textbox.trigger( 'change' );
		}
	},

	/**
	 * Respond to keypress event
	 * @param key Integer Code of key pressed
	 */
	keypress: function ( e, context, key ) {
		var selected,
			wasVisible = context.data.$container.is( ':visible' ),
			preventDefault = false;

		switch ( key ) {
			// Arrow down
			case 40:
				if ( wasVisible ) {
					$.suggestions.highlight( context, 'next', true );
					context.data.selectedWithMouse = false;
				} else {
					$.suggestions.update( context, false );
				}
				preventDefault = true;
				break;
			// Arrow up
			case 38:
				if ( wasVisible ) {
					$.suggestions.highlight( context, 'prev', true );
					context.data.selectedWithMouse = false;
				}
				preventDefault = wasVisible;
				break;
			// Escape
			case 27:
				context.data.$container.hide();
				$.suggestions.restore( context );
				$.suggestions.cancel( context );
				context.data.$textbox.trigger( 'change' );
				preventDefault = wasVisible;
				break;
			// Enter
			case 13:
				context.data.$container.hide();
				preventDefault = wasVisible;
				selected = context.data.$container.find( '.suggestions-result-current' );
				if ( selected.length === 0 || context.data.selectedWithMouse ) {
					// if nothing is selected OR if something was selected with the mouse,
					// cancel any current requests and submit the form
					$.suggestions.cancel( context );
					context.config.$region.closest( 'form' ).submit();
				} else if ( selected.is( '.suggestions-special' ) ) {
					if ( typeof context.config.special.select === 'function' ) {
						context.config.special.select.call( selected, context.data.$textbox );
					}
				} else {
					if ( typeof context.config.result.select === 'function' ) {
						$.suggestions.highlight( context, selected, true );
						context.config.result.select.call( selected, context.data.$textbox );
					} else {
						$.suggestions.highlight( context, selected, true );
					}
				}
				break;
			default:
				$.suggestions.update( context, true );
				break;
		}
		if ( preventDefault ) {
			e.preventDefault();
			e.stopImmediatePropagation();
		}
	}
};
$.fn.suggestions = function () {

	// Multi-context fields
	var returnValue,
		args = arguments;

	$(this).each( function () {
		var context, key;

		/* Construction / Loading */

		context = $(this).data( 'suggestions-context' );
		if ( context === undefined || context === null ) {
			context = {
				config: {
					fetch: function () {},
					cancel: function () {},
					special: {},
					result: {},
					$region: $(this),
					suggestions: [],
					maxRows: 7,
					delay: 120,
					submitOnClick: false,
					maxExpandFactor: 3,
					expandFrom: 'auto',
					highlightInput: false
				}
			};
		}

		/* API */

		// Handle various calling styles
		if ( args.length > 0 ) {
			if ( typeof args[0] === 'object' ) {
				// Apply set of properties
				for ( key in args[0] ) {
					$.suggestions.configure( context, key, args[0][key] );
				}
			} else if ( typeof args[0] === 'string' ) {
				if ( args.length > 1 ) {
					// Set property values
					$.suggestions.configure( context, args[0], args[1] );
				} else if ( returnValue === null || returnValue === undefined ) {
					// Get property values, but don't give access to internal data - returns only the first
					returnValue = ( args[0] in context.config ? undefined : context.config[args[0]] );
				}
			}
		}

		/* Initialization */

		if ( context.data === undefined ) {
			context.data = {
				// ID of running timer
				timerID: null,

				// Text in textbox when suggestions were last fetched
				prevText: null,

				// Number of results visible without scrolling
				visibleResults: 0,

				// Suggestion the last mousedown event occured on
				mouseDownOn: $( [] ),
				$textbox: $(this),
				selectedWithMouse: false
			};

			context.data.$container = $( '<div>' )
				.css( 'display', 'none' )
				.addClass( 'suggestions' )
				.append(
					$( '<div>' ).addClass( 'suggestions-results' )
						// Can't use click() because the container div is hidden when the
						// textbox loses focus. Instead, listen for a mousedown followed
						// by a mouseup on the same div.
						.mousedown( function ( e ) {
							context.data.mouseDownOn = $( e.target ).closest( '.suggestions-results .suggestions-result' );
						} )
						.mouseup( function ( e ) {
							var $result = $( e.target ).closest( '.suggestions-results .suggestions-result' ),
								$other = context.data.mouseDownOn;

							context.data.mouseDownOn = $( [] );
							if ( $result.get( 0 ) !== $other.get( 0 ) ) {
								return;
							}
							// do not interfere with non-left clicks or if modifier keys are pressed (e.g. ctrl-click)
							if ( !( e.which !== 1 || e.altKey || e.ctrlKey || e.shiftKey || e.metaKey ) ) {
								$.suggestions.highlight( context, $result, true );
								context.data.$container.hide();
								if ( typeof context.config.result.select === 'function' ) {
									context.config.result.select.call( $result, context.data.$textbox );
								}
							}
							// but still restore focus to the textbox, so that the suggestions will be hidden properly
							context.data.$textbox.focus();
						} )
				)
				.append(
					$( '<div>' ).addClass( 'suggestions-special' )
						// Can't use click() because the container div is hidden when the
						// textbox loses focus. Instead, listen for a mousedown followed
						// by a mouseup on the same div.
						.mousedown( function ( e ) {
							context.data.mouseDownOn = $( e.target ).closest( '.suggestions-special' );
						} )
						.mouseup( function ( e ) {
							var $special = $( e.target ).closest( '.suggestions-special' ),
								$other = context.data.mouseDownOn;

							context.data.mouseDownOn = $( [] );
							if ( $special.get( 0 ) !== $other.get( 0 ) ) {
								return;
							}
							// do not interfere with non-left clicks or if modifier keys are pressed (e.g. ctrl-click)
							if ( !( e.which !== 1 || e.altKey || e.ctrlKey || e.shiftKey || e.metaKey ) ) {
								context.data.$container.hide();
								if ( typeof context.config.special.select === 'function' ) {
									context.config.special.select.call( $special, context.data.$textbox );
								}
							}
							// but still restore focus to the textbox, so that the suggestions will be hidden properly
							context.data.$textbox.focus();
						} )
						.mousemove( function ( e ) {
							context.data.selectedWithMouse = true;
							$.suggestions.highlight(
								context, $( e.target ).closest( '.suggestions-special' ), false
							);
						} )
				)
				.appendTo( $( 'body' ) );

			$(this)
				// Stop browser autocomplete from interfering
				.attr( 'autocomplete', 'off')
				.keydown( function ( e ) {
					// Store key pressed to handle later
					context.data.keypressed = e.which;
					context.data.keypressedCount = 0;

					switch ( context.data.keypressed ) {
						// This preventDefault logic is duplicated from
						// $.suggestions.keypress(), which sucks
						// Arrow down
						case 40:
							e.preventDefault();
							e.stopImmediatePropagation();
							break;
						// Arrow up, Escape and Enter
						case 38:
						case 27:
						case 13:
							if ( context.data.$container.is( ':visible' ) ) {
								e.preventDefault();
								e.stopImmediatePropagation();
							}
					}
				} )
				.keypress( function ( e ) {
					context.data.keypressedCount++;
					$.suggestions.keypress( e, context, context.data.keypressed );
				} )
				.keyup( function ( e ) {
					// Some browsers won't throw keypress() for arrow keys. If we got a keydown and a keyup without a
					// keypress in between, solve it
					if ( context.data.keypressedCount === 0 ) {
						$.suggestions.keypress( e, context, context.data.keypressed );
					}
				} )
				.blur( function () {
					// When losing focus because of a mousedown
					// on a suggestion, don't hide the suggestions
					if ( context.data.mouseDownOn.length > 0 ) {
						return;
					}
					context.data.$container.hide();
					$.suggestions.cancel( context );
				} );
		}

		// Store the context for next time
		$(this).data( 'suggestions-context', context );
	} );
	return returnValue !== undefined ? returnValue : $(this);
};

}( jQuery ) );