gitlab-org--gitlab-foss/app/assets/javascripts/search_autocomplete.js

433 lines
14 KiB
JavaScript
Raw Normal View History

2017-01-11 22:49:57 -05:00
/* eslint-disable comma-dangle, no-return-assign, one-var, no-var, no-underscore-dangle, one-var-declaration-per-line, no-unused-vars, no-cond-assign, consistent-return, object-shorthand, prefer-arrow-callback, func-names, space-before-function-paren, prefer-template, quotes, class-methods-use-this, no-unused-expressions, no-sequences, wrap-iife, no-lonely-if, no-else-return, no-param-reassign, vars-on-top, max-len */
((global) => {
const KEYCODE = {
ESCAPE: 27,
BACKSPACE: 8,
ENTER: 13,
UP: 38,
DOWN: 40
};
class SearchAutocomplete {
2016-09-09 12:57:59 -04:00
constructor({ wrap, optsEl, autocompletePath, projectId, projectRef } = {}) {
this.bindEventContext();
this.wrap = wrap || $('.search');
2016-09-09 12:57:59 -04:00
this.optsEl = optsEl || this.wrap.find('.search-autocomplete-opts');
this.autocompletePath = autocompletePath || this.optsEl.data('autocomplete-path');
this.projectId = projectId || (this.optsEl.data('autocomplete-project-id') || '');
this.projectRef = projectRef || (this.optsEl.data('autocomplete-project-ref') || '');
this.dropdown = this.wrap.find('.dropdown');
2016-07-24 16:45:11 -04:00
this.dropdownContent = this.dropdown.find('.dropdown-content');
this.locationBadgeEl = this.getElement('.location-badge');
this.scopeInputEl = this.getElement('#scope');
this.searchInput = this.getElement('.search-input');
this.projectInputEl = this.getElement('#search_project_id');
this.groupInputEl = this.getElement('#group_id');
this.searchCodeInputEl = this.getElement('#search_code');
this.repositoryInputEl = this.getElement('#repository_ref');
this.clearInput = this.getElement('.js-clear-input');
this.saveOriginalState();
// Only when user is logged in
2016-07-24 16:45:11 -04:00
if (gon.current_user_id) {
this.createAutocomplete();
}
this.searchInput.addClass('disabled');
this.saveTextLength();
this.bindEvents();
}
// Finds an element inside wrapper element
bindEventContext() {
this.onSearchInputBlur = this.onSearchInputBlur.bind(this);
this.onClearInputClick = this.onClearInputClick.bind(this);
this.onSearchInputFocus = this.onSearchInputFocus.bind(this);
this.onSearchInputClick = this.onSearchInputClick.bind(this);
this.onSearchInputKeyUp = this.onSearchInputKeyUp.bind(this);
this.onSearchInputKeyDown = this.onSearchInputKeyDown.bind(this);
}
getElement(selector) {
2016-07-24 16:45:11 -04:00
return this.wrap.find(selector);
}
2016-07-24 16:45:11 -04:00
saveOriginalState() {
2016-07-24 16:45:11 -04:00
return this.originalState = this.serializeState();
}
2016-07-24 16:45:11 -04:00
saveTextLength() {
2016-07-24 16:45:11 -04:00
return this.lastTextLength = this.searchInput.val().length;
}
2016-07-24 16:45:11 -04:00
createAutocomplete() {
2016-07-24 16:45:11 -04:00
return this.searchInput.glDropdown({
filterInputBlur: false,
filterable: true,
filterRemote: true,
highlight: true,
enterCallback: false,
filterInput: 'input#search',
search: {
fields: ['text']
},
id: this.getSearchText,
2016-07-24 16:45:11 -04:00
data: this.getData.bind(this),
selectable: true,
clicked: this.onClick.bind(this)
});
}
2016-07-24 16:45:11 -04:00
getSearchText(selectedObject, el) {
return selectedObject.id ? selectedObject.text : '';
}
getData(term, callback) {
2016-07-24 16:45:11 -04:00
var _this, contents, jqXHR;
_this = this;
if (!term) {
if (contents = this.getCategoryContents()) {
this.searchInput.data('glDropdown').filter.options.callback(contents);
this.enableAutocomplete();
}
return;
}
// Prevent multiple ajax calls
2016-07-24 16:45:11 -04:00
if (this.loadingSuggestions) {
return;
}
this.loadingSuggestions = true;
return jqXHR = $.get(this.autocompletePath, {
project_id: this.projectId,
project_ref: this.projectRef,
term: term
}, function(response) {
var data, firstCategory, i, lastCategory, len, suggestion;
// Hide dropdown menu if no suggestions returns
2016-07-24 16:45:11 -04:00
if (!response.length) {
_this.disableAutocomplete();
return;
}
data = [];
// List results
2016-07-24 16:45:11 -04:00
firstCategory = true;
for (i = 0, len = response.length; i < len; i += 1) {
2016-07-24 16:45:11 -04:00
suggestion = response[i];
// Add group header before list each group
2016-07-24 16:45:11 -04:00
if (lastCategory !== suggestion.category) {
if (!firstCategory) {
data.push('separator');
}
if (firstCategory) {
firstCategory = false;
}
data.push({
header: suggestion.category
});
lastCategory = suggestion.category;
}
data.push({
id: (suggestion.category.toLowerCase()) + "-" + suggestion.id,
category: suggestion.category,
text: suggestion.label,
url: suggestion.url
});
}
// Add option to proceed with the search
2016-07-24 16:45:11 -04:00
if (data.length) {
data.push('separator');
data.push({
text: "Result name contains \"" + term + "\"",
url: "/search?search=" + term + "&project_id=" + (_this.projectInputEl.val()) + "&group_id=" + (_this.groupInputEl.val())
});
}
return callback(data);
}).always(function() {
return _this.loadingSuggestions = false;
});
}
2016-07-24 16:45:11 -04:00
getCategoryContents() {
2016-11-11 12:56:47 -05:00
var dashboardOptions, groupOptions, issuesPath, items, mrPath, name, options, projectOptions, userId, userName, utils;
2016-07-24 16:45:11 -04:00
userId = gon.current_user_id;
2016-11-11 12:56:47 -05:00
userName = gon.current_username;
2016-07-24 16:45:11 -04:00
utils = gl.utils, projectOptions = gl.projectOptions, groupOptions = gl.groupOptions, dashboardOptions = gl.dashboardOptions;
if (utils.isInGroupsPage() && groupOptions) {
options = groupOptions[utils.getGroupSlug()];
} else if (utils.isInProjectPage() && projectOptions) {
options = projectOptions[utils.getProjectSlug()];
} else if (dashboardOptions) {
options = dashboardOptions;
}
issuesPath = options.issuesPath, mrPath = options.mrPath, name = options.name;
items = [
{
header: "" + name
}, {
text: 'Issues assigned to me',
2016-11-11 12:56:47 -05:00
url: issuesPath + "/?assignee_username=" + userName
2016-07-24 16:45:11 -04:00
}, {
text: "Issues I've created",
2016-11-11 12:56:47 -05:00
url: issuesPath + "/?author_username=" + userName
2016-07-24 16:45:11 -04:00
}, 'separator', {
text: 'Merge requests assigned to me',
2017-02-15 17:13:53 -05:00
url: mrPath + "/?assignee_username=" + userName
2016-07-24 16:45:11 -04:00
}, {
text: "Merge requests I've created",
2017-02-15 17:13:53 -05:00
url: mrPath + "/?author_username=" + userName
2016-07-24 16:45:11 -04:00
}
];
if (!name) {
items.splice(0, 1);
}
return items;
}
2016-07-24 16:45:11 -04:00
serializeState() {
2016-07-24 16:45:11 -04:00
return {
// Search Criteria
2016-07-24 16:45:11 -04:00
search_project_id: this.projectInputEl.val(),
group_id: this.groupInputEl.val(),
search_code: this.searchCodeInputEl.val(),
repository_ref: this.repositoryInputEl.val(),
scope: this.scopeInputEl.val(),
// Location badge
2016-07-24 16:45:11 -04:00
_location: this.locationBadgeEl.text()
};
}
2016-07-24 16:45:11 -04:00
bindEvents() {
2016-07-24 16:45:11 -04:00
this.searchInput.on('keydown', this.onSearchInputKeyDown);
this.searchInput.on('keyup', this.onSearchInputKeyUp);
this.searchInput.on('click', this.onSearchInputClick);
this.searchInput.on('focus', this.onSearchInputFocus);
this.searchInput.on('blur', this.onSearchInputBlur);
this.clearInput.on('click', this.onClearInputClick);
return this.locationBadgeEl.on('click', (function(_this) {
return function() {
return _this.searchInput.focus();
};
})(this));
}
2016-07-24 16:45:11 -04:00
enableAutocomplete() {
2016-07-24 16:45:11 -04:00
var _this;
// No need to enable anything if user is not logged in
2016-07-24 16:45:11 -04:00
if (!gon.current_user_id) {
return;
}
if (!this.dropdown.hasClass('open')) {
_this = this;
this.loadingSuggestions = false;
this.dropdown.addClass('open').trigger('shown.bs.dropdown');
return this.searchInput.removeClass('disabled');
}
}
2016-07-24 16:45:11 -04:00
// Saves last length of the entered text
onSearchInputKeyDown() {
2016-07-24 16:45:11 -04:00
return this.saveTextLength();
}
2016-07-24 16:45:11 -04:00
onSearchInputKeyUp(e) {
2016-07-24 16:45:11 -04:00
switch (e.keyCode) {
case KEYCODE.BACKSPACE:
// when trying to remove the location badge
2016-07-24 16:45:11 -04:00
if (this.lastTextLength === 0 && this.badgePresent()) {
this.removeLocationBadge();
}
// When removing the last character and no badge is present
2016-07-24 16:45:11 -04:00
if (this.lastTextLength === 1) {
this.disableAutocomplete();
}
// When removing any character from existin value
2016-07-24 16:45:11 -04:00
if (this.lastTextLength > 1) {
this.enableAutocomplete();
}
break;
case KEYCODE.ESCAPE:
this.restoreOriginalState();
break;
case KEYCODE.ENTER:
2016-08-19 12:17:17 -04:00
this.disableAutocomplete();
break;
2016-08-19 12:17:17 -04:00
case KEYCODE.UP:
case KEYCODE.DOWN:
2016-08-19 12:17:17 -04:00
return;
2016-07-24 16:45:11 -04:00
default:
// Handle the case when deleting the input value other than backspace
// e.g. Pressing ctrl + backspace or ctrl + x
2016-07-24 16:45:11 -04:00
if (this.searchInput.val() === '') {
this.disableAutocomplete();
} else {
// We should display the menu only when input is not empty
2016-07-24 16:45:11 -04:00
if (e.keyCode !== KEYCODE.ENTER) {
this.enableAutocomplete();
}
}
}
this.wrap.toggleClass('has-value', !!e.target.value);
}
2016-07-24 16:45:11 -04:00
// Avoid falsy value to be returned
onSearchInputClick(e) {
2016-07-24 16:45:11 -04:00
return e.stopImmediatePropagation();
}
2016-07-24 16:45:11 -04:00
onSearchInputFocus() {
2016-07-24 16:45:11 -04:00
this.isFocused = true;
this.wrap.addClass('search-active');
if (this.getValue() === '') {
return this.getData();
}
}
2016-07-24 16:45:11 -04:00
getValue() {
2016-07-24 16:45:11 -04:00
return this.searchInput.val();
}
2016-07-24 16:45:11 -04:00
2017-01-11 22:49:57 -05:00
onClearInputClick(e) {
2016-07-24 16:45:11 -04:00
e.preventDefault();
return this.searchInput.val('').focus();
}
2016-07-24 16:45:11 -04:00
2017-01-11 22:49:57 -05:00
onSearchInputBlur(e) {
2016-07-24 16:45:11 -04:00
this.isFocused = false;
this.wrap.removeClass('search-active');
// If input is blank then restore state
2016-07-24 16:45:11 -04:00
if (this.searchInput.val() === '') {
return this.restoreOriginalState();
}
}
2016-07-24 16:45:11 -04:00
addLocationBadge(item) {
2016-07-24 16:45:11 -04:00
var badgeText, category, value;
category = item.category != null ? item.category + ": " : '';
value = item.value != null ? item.value : '';
badgeText = "" + category + value;
this.locationBadgeEl.text(badgeText).show();
return this.wrap.addClass('has-location-badge');
}
2016-07-24 16:45:11 -04:00
hasLocationBadge() {
2016-07-24 16:45:11 -04:00
return this.wrap.is('.has-location-badge');
}
2016-07-24 16:45:11 -04:00
restoreOriginalState() {
2016-07-24 16:45:11 -04:00
var i, input, inputs, len;
inputs = Object.keys(this.originalState);
for (i = 0, len = inputs.length; i < len; i += 1) {
2016-07-24 16:45:11 -04:00
input = inputs[i];
this.getElement("#" + input).val(this.originalState[input]);
}
if (this.originalState._location === '') {
return this.locationBadgeEl.hide();
} else {
return this.addLocationBadge({
value: this.originalState._location
});
}
}
2016-07-24 16:45:11 -04:00
badgePresent() {
2016-07-24 16:45:11 -04:00
return this.locationBadgeEl.length;
}
2016-07-24 16:45:11 -04:00
resetSearchState() {
2016-07-24 16:45:11 -04:00
var i, input, inputs, len, results;
inputs = Object.keys(this.originalState);
results = [];
for (i = 0, len = inputs.length; i < len; i += 1) {
2016-07-24 16:45:11 -04:00
input = inputs[i];
// _location isnt a input
2016-07-24 16:45:11 -04:00
if (input === '_location') {
break;
}
results.push(this.getElement("#" + input).val(''));
}
return results;
}
2016-07-24 16:45:11 -04:00
removeLocationBadge() {
2016-07-24 16:45:11 -04:00
this.locationBadgeEl.hide();
this.resetSearchState();
this.wrap.removeClass('has-location-badge');
return this.disableAutocomplete();
}
2016-07-24 16:45:11 -04:00
disableAutocomplete() {
if (!this.searchInput.hasClass('disabled') && this.dropdown.hasClass('open')) {
this.searchInput.addClass('disabled');
this.dropdown.removeClass('open').trigger('hidden.bs.dropdown');
this.restoreMenu();
}
}
2016-07-24 16:45:11 -04:00
restoreMenu() {
2016-07-24 16:45:11 -04:00
var html;
html = "<ul> <li><a class='dropdown-menu-empty-link is-focused'>Loading...</a></li> </ul>";
return this.dropdownContent.html(html);
}
2016-07-24 16:45:11 -04:00
onClick(item, $el, e) {
2016-07-24 16:45:11 -04:00
if (location.pathname.indexOf(item.url) !== -1) {
if (!e.metaKey) e.preventDefault();
2016-07-24 16:45:11 -04:00
if (!this.badgePresent) {
if (item.category === 'Projects') {
this.projectInputEl.val(item.id);
this.addLocationBadge({
value: 'This project'
});
}
if (item.category === 'Groups') {
this.groupInputEl.val(item.id);
this.addLocationBadge({
value: 'This group'
});
}
}
$el.removeClass('is-active');
this.disableAutocomplete();
return this.searchInput.val('').focus();
}
}
}
2016-07-24 16:45:11 -04:00
global.SearchAutocomplete = SearchAutocomplete;
2016-07-24 16:45:11 -04:00
$(function() {
2016-08-25 20:17:17 -04:00
var $projectOptionsDataEl = $('.js-search-project-options');
var $groupOptionsDataEl = $('.js-search-group-options');
var $dashboardOptionsDataEl = $('.js-search-dashboard-options');
2016-08-25 20:17:17 -04:00
if ($projectOptionsDataEl.length) {
gl.projectOptions = gl.projectOptions || {};
2016-08-25 20:17:17 -04:00
var projectPath = $projectOptionsDataEl.data('project-path');
gl.projectOptions[projectPath] = {
2016-08-25 20:17:17 -04:00
name: $projectOptionsDataEl.data('name'),
issuesPath: $projectOptionsDataEl.data('issues-path'),
mrPath: $projectOptionsDataEl.data('mr-path')
};
}
2016-08-25 20:17:17 -04:00
if ($groupOptionsDataEl.length) {
gl.groupOptions = gl.groupOptions || {};
2016-08-25 20:17:17 -04:00
var groupPath = $groupOptionsDataEl.data('group-path');
gl.groupOptions[groupPath] = {
2016-08-25 20:17:17 -04:00
name: $groupOptionsDataEl.data('name'),
issuesPath: $groupOptionsDataEl.data('issues-path'),
mrPath: $groupOptionsDataEl.data('mr-path')
};
}
2016-08-25 20:17:17 -04:00
if ($dashboardOptionsDataEl.length) {
gl.dashboardOptions = {
2016-08-25 20:17:17 -04:00
issuesPath: $dashboardOptionsDataEl.data('issues-path'),
mrPath: $dashboardOptionsDataEl.data('mr-path')
};
}
});
})(window.gl || (window.gl = {}));