/** * @param {Editor} editor * @param {String} url */ function register(editor, url) { // Tasklist UI buttons editor.ui.registry.addIcon('tasklist', ''); editor.ui.registry.addToggleButton('tasklist', { tooltip: 'Task list', icon: 'tasklist', active: false, onAction(api) { if (api.isActive()) { editor.execCommand('RemoveList'); } else { editor.execCommand('InsertUnorderedList', null, { 'list-item-attributes': { class: 'task-list-item', }, 'list-style-type': 'tasklist', }); } }, onSetup(api) { editor.on('NodeChange', event => { const parentListEl = event.parents.find(el => el.nodeName === 'LI'); const inList = parentListEl && parentListEl.classList.contains('task-list-item'); api.setActive(inList); }); } }); // Tweak existing bullet list button active state to not be active // when we're in a task list. const existingBullListButton = editor.ui.registry.getAll().buttons.bullist; existingBullListButton.onSetup = function(api) { editor.on('NodeChange', event => { const parentList = event.parents.find(el => el.nodeName === 'LI'); const inTaskList = parentList && parentList.classList.contains('task-list-item'); const inUlList = parentList && parentList.parentNode.nodeName === 'UL'; api.setActive(inUlList && !inTaskList); }); }; existingBullListButton.onAction = function() { // Cheeky hack to prevent list toggle action treating tasklists as normal // unordered lists which would unwrap the list on toggle from tasklist to bullet list. // Instead we quickly jump through an ordered list first if we're within a tasklist. if (elementWithinTaskList(editor.selection.getNode())) { editor.execCommand('InsertOrderedList', null, { 'list-item-attributes': {class: null} }); } editor.execCommand('InsertUnorderedList', null, { 'list-item-attributes': {class: null} }); }; // Tweak existing number list to not allow classes on child items const existingNumListButton = editor.ui.registry.getAll().buttons.numlist; existingNumListButton.onAction = function() { editor.execCommand('InsertOrderedList', null, { 'list-item-attributes': {class: null} }); }; // Setup filters on pre-init editor.on('PreInit', () => { editor.parser.addNodeFilter('li', function(nodes) { for (const node of nodes) { if (node.attributes.map.class === 'task-list-item') { parseTaskListNode(node); } } }); editor.serializer.addNodeFilter('li', function(nodes) { for (const node of nodes) { if (node.attributes.map.class === 'task-list-item') { serializeTaskListNode(node); } } }); }); // Handle checkbox click in editor editor.on('click', function(event) { const clickedEl = event.target; if (clickedEl.nodeName === 'LI' && clickedEl.classList.contains('task-list-item')) { handleTaskListItemClick(event, clickedEl, editor); event.preventDefault(); } }); } /** * @param {Element} element * @return {boolean} */ function elementWithinTaskList(element) { const listEl = element.closest('li'); return listEl && listEl.parentNode.nodeName === 'UL' && listEl.classList.contains('task-list-item'); } /** * @param {MouseEvent} event * @param {Element} clickedEl * @param {Editor} editor */ function handleTaskListItemClick(event, clickedEl, editor) { const bounds = clickedEl.getBoundingClientRect(); const withinBounds = event.clientX <= bounds.right && event.clientX >= bounds.left && event.clientY >= bounds.top && event.clientY <= bounds.bottom; // Outside of the task list item bounds mean we're probably clicking the pseudo-element. if (!withinBounds) { editor.undoManager.transact(() => { if (clickedEl.hasAttribute('checked')) { clickedEl.removeAttribute('checked'); } else { clickedEl.setAttribute('checked', 'checked'); } }); } } /** * @param {AstNode} node */ function parseTaskListNode(node) { // Force task list item class node.attr('class', 'task-list-item'); // Copy checkbox status and remove checkbox within editor for (const child of node.children()) { if (child.name === 'input') { if (child.attr('checked') === 'checked') { node.attr('checked', 'checked'); } child.remove(); } } } /** * @param {AstNode} node */ function serializeTaskListNode(node) { // Get checked status and clean it from list node const isChecked = node.attr('checked') === 'checked'; node.attr('checked', null); const inputAttrs = {type: 'checkbox', disabled: 'disabled'}; if (isChecked) { inputAttrs.checked = 'checked'; } // Create & insert checkbox input element const checkbox = new tinymce.html.Node.create('input', inputAttrs); checkbox.shortEnded = true; node.firstChild ? node.insert(checkbox, node.firstChild, true) : node.append(checkbox); } /** * @param {WysiwygConfigOptions} options * @return {register} */ export function getPlugin(options) { return register; }