gitlab-org--gitlab-foss/vendor/assets/javascripts/task_list.js

259 lines
8.8 KiB
JavaScript
Raw Normal View History

// The MIT License (MIT)
//
// Copyright (c) 2014 GitHub, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
// TaskList Behavior
//
2016-07-24 16:45:11 -04:00
/*= provides tasklist:enabled */
/*= provides tasklist:disabled */
/*= provides tasklist:change */
/*= provides tasklist:changed */
//
//
// Enables Task List update behavior.
//
// ### Example Markup
//
// <div class="js-task-list-container">
// <ul class="task-list">
// <li class="task-list-item">
// <input type="checkbox" class="js-task-list-item-checkbox" disabled />
// text
// </li>
// </ul>
// <form>
// <textarea class="js-task-list-field">- [ ] text</textarea>
// </form>
// </div>
//
// ### Specification
//
// TaskLists MUST be contained in a `(div).js-task-list-container`.
//
// TaskList Items SHOULD be an a list (`UL`/`OL`) element.
//
// Task list items MUST match `(input).task-list-item-checkbox` and MUST be
// `disabled` by default.
//
// TaskLists MUST have a `(textarea).js-task-list-field` form element whose
// `value` attribute is the source (Markdown) to be udpated. The source MUST
// follow the syntax guidelines.
//
// TaskList updates trigger `tasklist:change` events. If the change is
// successful, `tasklist:changed` is fired. The change can be canceled.
//
// jQuery is required.
//
// ### Methods
//
// `.taskList('enable')` or `.taskList()`
//
// Enables TaskList updates for the container.
//
// `.taskList('disable')`
//
// Disables TaskList updates for the container.
//
//# ### Events
//
// `tasklist:enabled`
//
// Fired when the TaskList is enabled.
//
// * **Synchronicity** Sync
// * **Bubbles** Yes
// * **Cancelable** No
// * **Target** `.js-task-list-container`
//
// `tasklist:disabled`
//
// Fired when the TaskList is disabled.
//
// * **Synchronicity** Sync
// * **Bubbles** Yes
// * **Cancelable** No
// * **Target** `.js-task-list-container`
//
// `tasklist:change`
//
// Fired before the TaskList item change takes affect.
//
// * **Synchronicity** Sync
// * **Bubbles** Yes
// * **Cancelable** Yes
// * **Target** `.js-task-list-field`
//
// `tasklist:changed`
//
// Fired once the TaskList item change has taken affect.
//
// * **Synchronicity** Sync
// * **Bubbles** Yes
// * **Cancelable** No
// * **Target** `.js-task-list-field`
//
// ### NOTE
//
// Task list checkboxes are rendered as disabled by default because rendered
// user content is cached without regard for the viewer.
2016-07-24 16:45:11 -04:00
(function() {
var codeFencesPattern, complete, completePattern, disableTaskList, disableTaskLists, enableTaskList, enableTaskLists, escapePattern, incomplete, incompletePattern, itemPattern, itemsInParasPattern, updateTaskList, updateTaskListItem,
indexOf = [].indexOf || function(item) { for (var i = 0, l = this.length; i < l; i++) { if (i in this && this[i] === item) return i; } return -1; };
incomplete = "[ ]";
complete = "[x]";
// Escapes the String for regular expression matching.
2016-07-24 16:45:11 -04:00
escapePattern = function(str) {
return str.replace(/([\[\]])/g, "\\$1").replace(/\s/, "\\s").replace("x", "[xX]");
};
incompletePattern = RegExp("" + (escapePattern(incomplete))); // escape square brackets
// match all white space
completePattern = RegExp("" + (escapePattern(complete))); // match all cases
2016-07-24 16:45:11 -04:00
// Pattern used to identify all task list items.
// Useful when you need iterate over all items.
2016-07-24 16:45:11 -04:00
itemPattern = RegExp("^(?:\\s*(?:>\\s*)*(?:[-+*]|(?:\\d+\\.)))\\s*(" + (escapePattern(complete)) + "|" + (escapePattern(incomplete)) + ")\\s+(?!\\(.*?\\))(?=(?:\\[.*?\\]\\s*(?:\\[.*?\\]|\\(.*?\\))\\s*)*(?:[^\\[]|$))");
// prefix, consisting of
// optional leading whitespace
// zero or more blockquotes
// list item indicator
// optional whitespace prefix
// checkbox
// is followed by whitespace
// is not part of a [foo](url) link
// and is followed by zero or more links
// and either a non-link or the end of the string
// Used to filter out code fences from the source for comparison only.
// http://rubular.com/r/x5EwZVrloI
// Modified slightly due to issues with JS
2016-07-24 16:45:11 -04:00
codeFencesPattern = /^`{3}(?:\s*\w+)?[\S\s].*[\S\s]^`{3}$/mg;
// ```
// followed by optional language
// whitespace
// code
// whitespace
// ```
// Used to filter out potential mismatches (items not in lists).
// http://rubular.com/r/OInl6CiePy
2016-07-24 16:45:11 -04:00
itemsInParasPattern = RegExp("^(" + (escapePattern(complete)) + "|" + (escapePattern(incomplete)) + ").+$", "g");
// Given the source text, updates the appropriate task list item to match the
// given checked value.
//
// Returns the updated String text.
2016-07-24 16:45:11 -04:00
updateTaskListItem = function(source, itemIndex, checked) {
var clean, index, line, result;
clean = source.replace(/\r/g, '').replace(codeFencesPattern, '').replace(itemsInParasPattern, '').split("\n");
index = 0;
result = (function() {
var i, len, ref, results;
ref = source.split("\n");
results = [];
for (i = 0, len = ref.length; i < len; i++) {
line = ref[i];
if (indexOf.call(clean, line) >= 0 && line.match(itemPattern)) {
index += 1;
if (index === itemIndex) {
line = checked ? line.replace(incompletePattern, complete) : line.replace(completePattern, incomplete);
}
}
results.push(line);
}
return results;
})();
return result.join("\n");
};
// Updates the $field value to reflect the state of $item.
// Triggers the `tasklist:change` event before the value has changed, and fires
// a `tasklist:changed` event once the value has changed.
2016-07-24 16:45:11 -04:00
updateTaskList = function($item) {
var $container, $field, checked, event, index;
$container = $item.closest('.js-task-list-container');
$field = $container.find('.js-task-list-field');
index = 1 + $container.find('.task-list-item-checkbox').index($item);
checked = $item.prop('checked');
event = $.Event('tasklist:change');
$field.trigger(event, [index, checked]);
if (!event.isDefaultPrevented()) {
$field.val(updateTaskListItem($field.val(), index, checked));
$field.trigger('change');
return $field.trigger('tasklist:changed', [index, checked]);
}
};
// When the task list item checkbox is updated, submit the change
2016-07-24 16:45:11 -04:00
$(document).on('change', '.task-list-item-checkbox', function() {
return updateTaskList($(this));
});
// Enables TaskList item changes.
2016-07-24 16:45:11 -04:00
enableTaskList = function($container) {
if ($container.find('.js-task-list-field').length > 0) {
$container.find('.task-list-item').addClass('enabled').find('.task-list-item-checkbox').attr('disabled', null);
return $container.addClass('is-task-list-enabled').trigger('tasklist:enabled');
}
};
// Enables a collection of TaskList containers.
2016-07-24 16:45:11 -04:00
enableTaskLists = function($containers) {
var container, i, len, results;
results = [];
for (i = 0, len = $containers.length; i < len; i++) {
container = $containers[i];
results.push(enableTaskList($(container)));
}
return results;
};
// Disable TaskList item changes.
2016-07-24 16:45:11 -04:00
disableTaskList = function($container) {
$container.find('.task-list-item').removeClass('enabled').find('.task-list-item-checkbox').attr('disabled', 'disabled');
return $container.removeClass('is-task-list-enabled').trigger('tasklist:disabled');
};
// Disables a collection of TaskList containers.
2016-07-24 16:45:11 -04:00
disableTaskLists = function($containers) {
var container, i, len, results;
results = [];
for (i = 0, len = $containers.length; i < len; i++) {
container = $containers[i];
results.push(disableTaskList($(container)));
}
return results;
};
$.fn.taskList = function(method) {
var $container, methods;
$container = $(this).closest('.js-task-list-container');
methods = {
enable: enableTaskLists,
disable: disableTaskLists
};
return methods[method || 'enable']($container);
};
}).call(this);