gitlab-org--gitlab-foss/app/assets/javascripts/gl_dropdown.js.coffee

586 lines
16 KiB
CoffeeScript
Raw Normal View History

2016-03-07 10:37:35 -05:00
class GitLabDropdownFilter
BLUR_KEYCODES = [27, 40]
2016-03-31 03:55:12 -04:00
ARROW_KEY_CODES = [38, 40]
2016-03-18 12:53:15 -04:00
HAS_VALUE_CLASS = "has-value"
2016-03-07 10:37:35 -05:00
constructor: (@input, @options) ->
{
@filterInputBlur = true
} = @options
2016-03-07 10:37:35 -05:00
2016-03-18 12:53:15 -04:00
$inputContainer = @input.parent()
$clearButton = $inputContainer.find('.js-dropdown-input-clear')
2016-04-26 15:34:19 -04:00
@indeterminateIds = []
2016-04-26 14:05:21 -04:00
2016-03-18 12:53:15 -04:00
# Clear click
$clearButton.on 'click', (e) =>
e.preventDefault()
e.stopPropagation()
@input
.val('')
.trigger('keyup')
.focus()
2016-03-07 10:37:35 -05:00
# Key events
2016-03-08 04:09:39 -05:00
timeout = ""
2016-03-07 10:37:35 -05:00
@input.on "keyup", (e) =>
2016-03-31 03:55:12 -04:00
keyCode = e.which
return if ARROW_KEY_CODES.indexOf(keyCode) >= 0
2016-03-18 12:53:15 -04:00
if @input.val() isnt "" and !$inputContainer.hasClass HAS_VALUE_CLASS
$inputContainer.addClass HAS_VALUE_CLASS
else if @input.val() is "" and $inputContainer.hasClass HAS_VALUE_CLASS
$inputContainer.removeClass HAS_VALUE_CLASS
if keyCode is 13
return false
# Only filter asynchronously only if option remote is set
if @options.remote
clearTimeout timeout
timeout = setTimeout =>
blur_field = @shouldBlur keyCode
2016-03-07 10:37:35 -05:00
if blur_field and @filterInputBlur
@input.blur()
2016-03-07 10:37:35 -05:00
@options.query @input.val(), (data) =>
@options.callback(data)
, 250
else
@filter @input.val()
2016-03-07 10:37:35 -05:00
shouldBlur: (keyCode) ->
return BLUR_KEYCODES.indexOf(keyCode) >= 0
filter: (search_text) ->
data = @options.data()
2016-03-08 10:45:03 -05:00
2016-03-29 06:51:13 -04:00
if data?
results = data
2016-03-07 10:37:35 -05:00
if search_text isnt ''
2016-05-13 11:57:03 -04:00
# When data is an array of objects therefore [object Array] e.g.
# [
# { prop: 'foo' },
# { prop: 'baz' }
# ]
2016-05-11 20:38:43 -04:00
if _.isArray(data)
results = fuzzaldrinPlus.filter(data, search_text,
key: @options.keys
)
2016-05-13 11:57:03 -04:00
else
# If data is grouped therefore an [object Object]. e.g.
# {
# groupName1: [
# { prop: 'foo' },
# { prop: 'baz' }
# ],
# groupName2: [
# { prop: 'abc' },
# { prop: 'def' }
# ]
# }
if gl.utils.isObject data
results = {}
for key, group of data
tmp = fuzzaldrinPlus.filter(group, search_text,
key: @options.keys
)
if tmp.length
results[key] = tmp.map (item) -> item
2016-03-29 06:51:13 -04:00
@options.callback results
else
elements = @options.elements()
if search_text
elements.each ->
$el = $(@)
matches = fuzzaldrinPlus.match($el.text().trim(), search_text)
if matches.length
$el.show()
else
$el.hide()
else
elements.show()
2016-03-07 10:37:35 -05:00
class GitLabDropdownRemote
constructor: (@dataEndpoint, @options) ->
execute: ->
if typeof @dataEndpoint is "string"
@fetchData()
else if typeof @dataEndpoint is "function"
if @options.beforeSend
@options.beforeSend()
# Fetch the data by calling the data funcfion
2016-03-08 04:09:39 -05:00
@dataEndpoint "", (data) =>
2016-03-07 10:37:35 -05:00
if @options.success
@options.success(data)
if @options.beforeSend
@options.beforeSend()
# Fetch the data through ajax if the data is a string
fetchData: ->
$.ajax(
url: @dataEndpoint,
dataType: @options.dataType,
beforeSend: =>
if @options.beforeSend
@options.beforeSend()
success: (data) =>
if @options.success
@options.success(data)
)
class GitLabDropdown
LOADING_CLASS = "is-loading"
PAGE_TWO_CLASS = "is-page-two"
ACTIVE_CLASS = "is-active"
INDETERMINATE_CLASS = "is-indeterminate"
2016-03-31 03:55:12 -04:00
currentIndex = -1
2016-03-07 10:37:35 -05:00
FILTER_INPUT = '.dropdown-input .dropdown-input-field'
2016-03-07 10:37:35 -05:00
constructor: (@el, @options) ->
self = @
selector = $(@el).data "target"
@dropdown = if selector? then $(selector) else $(@el).parent()
# Set Defaults
{
# If no input is passed create a default one
2016-03-18 18:35:26 -04:00
@filterInput = @getElement(FILTER_INPUT)
2016-03-11 20:47:01 -05:00
@highlight = false
@filterInputBlur = true
} = @options
self = @
# If selector was passed
if _.isString(@filterInput)
2016-03-18 18:35:26 -04:00
@filterInput = @getElement(@filterInput)
searchFields = if @options.search then @options.search.fields else [];
2016-03-07 10:37:35 -05:00
if @options.data
2016-05-11 20:38:43 -04:00
# If we provided data
# data could be an array of objects or a group of arrays
if _.isObject(@options.data) and not _.isFunction(@options.data)
@fullData = @options.data
@parseData @options.data
else
# Remote data
@remote = new GitLabDropdownRemote @options.data, {
dataType: @options.dataType,
beforeSend: @toggleLoading.bind(@)
success: (data) =>
@fullData = data
2016-03-07 10:37:35 -05:00
@parseData @fullData
}
2016-03-07 10:37:35 -05:00
# Init filterable
2016-03-07 10:37:35 -05:00
if @options.filterable
2016-03-23 20:43:57 -04:00
@filter = new GitLabDropdownFilter @filterInput,
filterInputBlur: @filterInputBlur
remote: @options.filterRemote
query: @options.data
keys: searchFields
2016-03-29 06:51:13 -04:00
elements: =>
selector = '.dropdown-content li:not(.divider)'
2016-03-29 06:51:13 -04:00
if @dropdown.find('.dropdown-toggle-page').length
2016-03-29 06:51:13 -04:00
selector = ".dropdown-page-one #{selector}"
return $(selector)
data: =>
return @fullData
callback: (data) =>
2016-03-31 03:55:12 -04:00
currentIndex = -1
@parseData data
2016-03-07 10:37:35 -05:00
# Event listeners
@dropdown.on "shown.bs.dropdown", @opened
@dropdown.on "hidden.bs.dropdown", @hidden
@dropdown.on "click", ".dropdown-menu, .dropdown-menu-close", @shouldPropagate
@dropdown.on 'keyup', (e) =>
if e.which is 27 # Escape key
$('.dropdown-menu-close', @dropdown).trigger 'click'
if @dropdown.find(".dropdown-toggle-page").length
@dropdown.find(".dropdown-toggle-page, .dropdown-menu-back").on "click", (e) =>
e.preventDefault()
e.stopPropagation()
@togglePage()
2016-03-07 10:37:35 -05:00
if @options.selectable
2016-03-08 06:23:54 -05:00
selector = ".dropdown-content a"
if @dropdown.find(".dropdown-toggle-page").length
2016-03-08 06:23:54 -05:00
selector = ".dropdown-page-one .dropdown-content a"
@dropdown.on "click", selector, (e) ->
$el = $(@)
selected = self.rowClicked $el
2016-03-07 10:37:35 -05:00
if self.options.clicked
self.options.clicked(selected, $el, e)
2016-03-07 10:37:35 -05:00
2016-03-18 18:35:26 -04:00
# Finds an element inside wrapper element
getElement: (selector) ->
@dropdown.find selector
2016-03-07 10:37:35 -05:00
toggleLoading: ->
$('.dropdown-menu', @dropdown).toggleClass LOADING_CLASS
togglePage: ->
menu = $('.dropdown-menu', @dropdown)
if menu.hasClass(PAGE_TWO_CLASS)
if @remote
@remote.execute()
menu.toggleClass PAGE_TWO_CLASS
# Focus first visible input on active page
@dropdown.find('[class^="dropdown-page-"]:visible :text:visible:first').focus()
2016-03-07 10:37:35 -05:00
parseData: (data) ->
@renderedData = data
if @options.filterable and data.length is 0
# render no matching results
html = [@noResults()]
2016-05-11 20:38:43 -04:00
else
# Handle array groups
2016-05-13 11:57:03 -04:00
if gl.utils.isObject data
2016-05-11 20:38:43 -04:00
html = []
for name, groupData of data
# Add header for each group
html.push(@renderItem(header: name, name))
@renderData(groupData, name)
.map (item) ->
html.push item
else
# Render each row
html = @renderData(data)
2016-03-07 10:37:35 -05:00
# Render the full menu
full_html = @renderMenu(html.join(""))
@appendMenu(full_html)
2016-05-11 20:38:43 -04:00
renderData: (data, group = false) ->
2016-05-13 11:57:03 -04:00
data.map (obj, index) =>
2016-05-11 20:38:43 -04:00
return @renderItem(obj, group, index)
shouldPropagate: (e) =>
if @options.multiSelect
$target = $(e.target)
if not $target.hasClass('dropdown-menu-close') and not $target.hasClass('dropdown-menu-close-icon') and not $target.data('is-link')
e.stopPropagation()
return false
else
return true
2016-03-07 10:37:35 -05:00
opened: =>
@addArrowKeyEvent()
2016-04-26 15:34:19 -04:00
if @options.setIndeterminateIds
@options.setIndeterminateIds.call(@)
2016-04-26 14:05:21 -04:00
2016-04-26 15:34:19 -04:00
# Makes indeterminate items effective
2016-04-26 14:05:21 -04:00
if @fullData and @dropdown.find('.dropdown-menu-toggle').hasClass('js-filter-bulk-update')
@parseData @fullData
contentHtml = $('.dropdown-content', @dropdown).html()
if @remote && contentHtml is ""
2016-03-07 10:37:35 -05:00
@remote.execute()
2016-03-08 04:09:39 -05:00
if @options.filterable
@filterInput.focus()
2016-03-08 04:09:39 -05:00
2016-03-27 11:04:51 -04:00
@dropdown.trigger('shown.gl.dropdown')
2016-03-12 15:37:02 -05:00
hidden: (e) =>
@removeArrayKeyEvent()
2016-04-26 14:05:21 -04:00
$input = @dropdown.find(".dropdown-input-field")
2016-03-08 04:09:39 -05:00
if @options.filterable
$input
.blur()
.val("")
# Triggering 'keyup' will re-render the dropdown which is not always required
# specially if we want to keep the state of the dropdown needed for bulk-assignment
if not @options.persistWhenHide
$input.trigger("keyup")
2016-03-08 04:09:39 -05:00
if @dropdown.find(".dropdown-toggle-page").length
$('.dropdown-menu', @dropdown).removeClass PAGE_TWO_CLASS
2016-03-12 15:37:02 -05:00
if @options.hidden
@options.hidden.call(@,e)
2016-03-27 11:04:51 -04:00
@dropdown.trigger('hidden.gl.dropdown')
2016-03-07 10:37:35 -05:00
# Render the full menu
renderMenu: (html) ->
menu_html = ""
if @options.renderMenu
menu_html = @options.renderMenu(html)
else
menu_html = "<ul>#{html}</ul>"
return menu_html
# Append the menu into the dropdown
appendMenu: (html) ->
selector = '.dropdown-content'
if @dropdown.find(".dropdown-toggle-page").length
selector = ".dropdown-page-one .dropdown-content"
$(selector, @dropdown).html html
2016-03-07 10:37:35 -05:00
# Render the row
2016-05-11 20:38:43 -04:00
renderItem: (data, group = false, index = false) ->
2016-03-07 10:37:35 -05:00
html = ""
2016-03-24 18:13:09 -04:00
# Divider
return "<li class='divider'></li>" if data is "divider"
2016-03-24 18:13:09 -04:00
# Separator is a full-width divider
return "<li class='separator'></li>" if data is "separator"
2016-03-11 18:00:17 -05:00
# Header
return "<li class='dropdown-header'>#{data.header}</li>" if data.header?
2016-03-07 10:37:35 -05:00
if @options.renderRow
# Call the render function
2016-04-26 14:05:21 -04:00
html = @options.renderRow.call(@options, data, @)
2016-03-07 10:37:35 -05:00
else
if not selected
value = if @options.id then @options.id(data) else data.id
fieldName = @options.fieldName
field = @dropdown.parent().find("input[name='#{fieldName}'][value='#{value}']")
if field.length
selected = true
2016-03-11 13:39:28 -05:00
# Set URL
if @options.url?
url = @options.url(data)
else
2016-03-14 23:04:22 -04:00
url = if data.url? then data.url else '#'
2016-03-11 13:39:28 -05:00
# Set Text
if @options.text?
text = @options.text(data)
else
2016-03-11 13:39:28 -05:00
text = if data.text? then data.text else ''
2016-03-07 10:37:35 -05:00
cssClass = "";
if selected
cssClass = "is-active"
2016-03-11 20:47:01 -05:00
if @highlight
text = @highlightTextMatches(text, @filterInput.val())
2016-03-11 20:38:19 -05:00
2016-05-11 20:38:43 -04:00
if group
groupAttrs = "data-group='#{group}' data-index='#{index}'"
else
groupAttrs = ''
2016-03-31 03:55:12 -04:00
html = "<li>
2016-05-11 20:38:43 -04:00
<a href='#{url}' #{groupAttrs} class='#{cssClass}'>
2016-03-31 03:55:12 -04:00
#{text}
</a>
</li>"
2016-03-07 10:37:35 -05:00
return html
2016-03-11 20:38:19 -05:00
highlightTextMatches: (text, term) ->
occurrences = fuzzaldrinPlus.match(text, term)
2016-03-18 18:35:26 -04:00
text.split('').map((character, i) ->
if i in occurrences then "<b>#{character}</b>" else character
).join('')
2016-03-11 20:38:19 -05:00
2016-03-07 10:37:35 -05:00
noResults: ->
2016-04-05 04:07:40 -04:00
html = "<li class='dropdown-menu-empty-link'>
<a href='#' class='is-focused'>
No matching results.
</a>
</li>"
2016-03-07 10:37:35 -05:00
highlightRow: (index) ->
2016-03-23 20:44:24 -04:00
if @filterInput.val() isnt ""
selector = '.dropdown-content li:first-child a'
if @dropdown.find(".dropdown-toggle-page").length
selector = ".dropdown-page-one .dropdown-content li:first-child a"
@getElement(selector).addClass 'is-focused'
2016-03-07 10:37:35 -05:00
rowClicked: (el) ->
fieldName = @options.fieldName
if @renderedData
2016-05-11 20:38:43 -04:00
groupName = el.data('group')
if groupName
selectedIndex = el.data('index')
selectedObject = @renderedData[groupName][selectedIndex]
else
2016-05-13 11:57:03 -04:00
selectedIndex = el.closest('li').index()
2016-05-11 20:38:43 -04:00
selectedObject = @renderedData[selectedIndex]
value = if @options.id then @options.id(selectedObject, el) else selectedObject.id
field = @dropdown.parent().find("input[name='#{fieldName}'][value='#{value}']")
if el.hasClass(ACTIVE_CLASS)
el.removeClass(ACTIVE_CLASS)
field.remove()
# Toggle the dropdown label
if @options.toggleLabel
$(@el).find(".dropdown-toggle-text").text @options.toggleLabel
else
selectedObject
else if el.hasClass(INDETERMINATE_CLASS)
el.addClass ACTIVE_CLASS
el.removeClass INDETERMINATE_CLASS
2016-05-13 01:56:37 -04:00
if not value?
field.remove()
2016-05-13 01:56:37 -04:00
if not field.length and fieldName
@addInput(fieldName, value)
return selectedObject
2016-03-07 10:37:35 -05:00
else
if not @options.multiSelect or el.hasClass('dropdown-clear-active')
@dropdown.find(".#{ACTIVE_CLASS}").removeClass ACTIVE_CLASS
@dropdown.parent().find("input[name='#{fieldName}']").remove()
if !value?
field.remove()
# Toggle active class for the tick mark
el.addClass ACTIVE_CLASS
# Toggle the dropdown label
if @options.toggleLabel
2016-03-29 06:11:16 -04:00
$(@el).find(".dropdown-toggle-text").text @options.toggleLabel(selectedObject, el)
if value?
if !field.length and fieldName
@addInput(fieldName, value)
else
field.val value
2016-03-07 10:37:35 -05:00
return selectedObject
addInput: (fieldName, value)->
# Create hidden input for form
2016-05-31 17:11:46 -04:00
$input = $('<input>').attr('type', 'hidden')
.attr('name', fieldName)
.val(value)
2016-05-13 01:56:37 -04:00
if @options.inputId?
2016-05-13 01:56:37 -04:00
$input.attr('id', @options.inputId)
2016-05-13 01:56:37 -04:00
@dropdown.before $input
selectRowAtIndex: (e, index) ->
selector = ".dropdown-content li:not(.divider,.dropdown-header,.separator):eq(#{index}) a"
if @dropdown.find(".dropdown-toggle-page").length
selector = ".dropdown-page-one #{selector}"
# simulate a click on the first link
$el = $(selector, @dropdown)
if $el.length
e.preventDefault()
e.stopImmediatePropagation()
$(selector, @dropdown)[0].click()
addArrowKeyEvent: ->
ARROW_KEY_CODES = [38, 40]
$input = @dropdown.find(".dropdown-input-field")
selector = '.dropdown-content li:not(.divider,.dropdown-header,.separator)'
if @dropdown.find(".dropdown-toggle-page").length
selector = ".dropdown-page-one #{selector}"
$('body').on 'keydown', (e) =>
2016-03-31 03:55:12 -04:00
currentKeyCode = e.which
if ARROW_KEY_CODES.indexOf(currentKeyCode) >= 0
e.preventDefault()
2016-03-31 03:55:12 -04:00
e.stopImmediatePropagation()
2016-03-31 03:55:12 -04:00
PREV_INDEX = currentIndex
$listItems = $(selector, @dropdown)
2016-03-31 03:55:12 -04:00
# if @options.filterable
# $input.blur()
if currentKeyCode is 40
# Move down
2016-03-31 03:55:12 -04:00
currentIndex += 1 if currentIndex < ($listItems.length - 1)
else if currentKeyCode is 38
# Move up
2016-03-31 03:55:12 -04:00
currentIndex -= 1 if currentIndex > 0
2016-03-31 03:55:12 -04:00
@highlightRowAtIndex($listItems, currentIndex) if currentIndex isnt PREV_INDEX
return false
if currentKeyCode is 13 and currentIndex isnt -1
@selectRowAtIndex e, currentIndex
removeArrayKeyEvent: ->
$('body').off 'keydown'
highlightRowAtIndex: ($listItems, index) ->
# Remove the class for the previously focused row
$('.is-focused', @dropdown).removeClass 'is-focused'
# Update the class for the row at the specific index
$listItem = $listItems.eq(index)
2016-03-29 07:57:10 -04:00
$listItem.find('a:first-child').addClass "is-focused"
2016-03-24 06:26:15 -04:00
# Dropdown content scroll area
$dropdownContent = $listItem.closest('.dropdown-content')
2016-03-31 03:55:12 -04:00
dropdownScrollTop = $dropdownContent.scrollTop()
dropdownContentHeight = $dropdownContent.outerHeight()
dropdownContentTop = $dropdownContent.prop('offsetTop')
dropdownContentBottom = dropdownContentTop + dropdownContentHeight
2016-03-24 06:26:15 -04:00
# Get the offset bottom of the list item
2016-03-31 03:55:12 -04:00
listItemHeight = $listItem.outerHeight()
listItemTop = $listItem.prop('offsetTop')
listItemBottom = listItemTop + listItemHeight
2016-03-24 06:26:15 -04:00
if listItemBottom > dropdownContentBottom + dropdownScrollTop
2016-03-24 06:26:15 -04:00
# Scroll the dropdown content down
$dropdownContent.scrollTop(listItemBottom - dropdownContentBottom)
else if listItemTop < dropdownContentTop + dropdownScrollTop
# Scroll the dropdown content up
$dropdownContent.scrollTop(listItemTop - dropdownContentTop)
2016-03-24 06:26:15 -04:00
2016-03-07 10:37:35 -05:00
$.fn.glDropdown = (opts) ->
return @.each ->
if (!$.data @, 'glDropdown')
$.data(@, 'glDropdown', new GitLabDropdown @, opts)