@ckeditor/ckeditor5-list 42.0.2 → 43.0.0-alpha.0

package/src/listproperties/utils/config.js

@@ -0,0 +1,70 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module list/listproperties/utils/config
+ */
+import { toArray } from 'ckeditor5/src/utils.js';
+/**
+ * Normalizes {@link module:list/listconfig~ListPropertiesConfig} in the configuration of the list properties feature.
+ * The structure of normalized list properties options looks as follows:
+ *
+ * ```ts
+ * {
+ * 	styles: {
+ * 		listTypes: [ 'bulleted', 'numbered' ],
+ * 		useAttribute: false
+ * 	},
+ * 	startIndex: true,
+ * 	reversed: true
+ * }
+ * ```
+ *
+ * @param config The list properties {@link module:list/listconfig~ListPropertiesConfig config}.
+ * @returns An object with normalized list properties options.
+ */
+export function getNormalizedConfig(config) {
+    const { startIndex, reversed, styles } = config;
+    return {
+        styles: getNormalizedStylesConfig(styles),
+        startIndex: startIndex || false,
+        reversed: reversed || false
+    };
+}
+/**
+ * Normalizes styles in the configuration of the list properties feature.
+ * The structure of normalized list properties options looks as follows:
+ *
+ * ```ts
+ * {
+ * 	listTypes: [ 'bulleted', 'numbered' ],
+ * 	useAttribute: false
+ * }
+ * ```
+ *
+ * @param styles The list properties styles.
+ * @returns An object with normalized list properties styles.
+ */
+function getNormalizedStylesConfig(styles) {
+    const normalizedConfig = {
+        listTypes: ['bulleted', 'numbered'],
+        useAttribute: false
+    };
+    if (styles === true) {
+        return normalizedConfig;
+    }
+    if (!styles) {
+        normalizedConfig.listTypes = [];
+    }
+    else if (Array.isArray(styles) || typeof styles == 'string') {
+        normalizedConfig.listTypes = toArray(styles);
+    }
+    else {
+        normalizedConfig.listTypes = styles.listTypes ?
+            toArray(styles.listTypes) :
+            normalizedConfig.listTypes;
+        normalizedConfig.useAttribute = !!styles.useAttribute;
+    }
+    return normalizedConfig;
+}

package/src/todolist/todolistediting.js

@@ -50,15 +50,13 @@ export default class TodoListEditing extends Plugin {
         editor.commands.add('checkTodoList', new CheckTodoListCommand(editor));
         editing.view.addObserver(TodoCheckboxChangeObserver);
         model.schema.extend('$listItem', { allowAttributes: 'todoListChecked' });
-        model.schema.addAttributeCheck((context, attributeName) => {
+        model.schema.addAttributeCheck(context => {
             const item = context.last;
-            if (attributeName != 'todoListChecked') {
-                return;
-            }
+            // Don't allow `todoListChecked` attribute on elements which are not todo list items.
             if (!item.getAttribute('listItemId') || item.getAttribute('listType') != 'todo') {
                 return false;
             }
-        });
+        }, 'todoListChecked');
         editor.conversion.for('upcast').add(dispatcher => {
             // Upcast of to-do list item is based on a checkbox at the beginning of a <li> to keep compatibility with markdown input.
             dispatcher.on('element:input', todoItemInputConverter());