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

package/build/translations/sr-latn.js

@@ -1 +1 @@
-!function(e){const i=e["sr-latn"]=e["sr-latn"]||{};i.dictionary=Object.assign(i.dictionary||{},{"Bulleted List":"Nabrajane liste","Bulleted list styles toolbar":"Traka sa alatkama za nabrajane liste",Circle:"Krug",Decimal:"Decimala","Decimal with leading zero":"Decimalni broj sa nulom na početku","Decrease list item indent":"",Disc:"Disk","Entering a to-do list":"","Increase list item indent":"","Invalid start index value.":"","Keystrokes that can be used in a list":"","Leaving a to-do list":"","List properties":"Navedite svojstva","Lower-latin":"Donji - latinski","Lower–roman":"Donji - rimski","Numbered List":"Lista sa brojevima","Numbered list styles toolbar":"Traka sa altakama za liste sa brojevima","Reversed order":"Obrnuti redosled",Square:"Kvadrat","Start at":"Početi u","Start index must be greater than 0.":"Početni indeks mora biti veći od 0.","To-do List":"Lista obaveza","Toggle the circle list style":"Uključite / isključite stil liste krugova","Toggle the decimal list style":"Uključi / isključi stil dekadne liste","Toggle the decimal with leading zero list style":"Prebaci decimalni znak sa vodećim stilom liste nula","Toggle the disc list style":"Uključite / isključite stil liste diskova","Toggle the lower–latin list style":"Uključite / isključite stil donje liste latinice","Toggle the lower–roman list style":"Uključite / isključite stil donje rimske liste","Toggle the square list style":"Uključite / isključite stil liste kvadrata","Toggle the upper–latin list style":"Uključite / isključite stil gornje liste latinice","Toggle the upper–roman list style":"Uključite / isključite stil gornje rimske liste","Upper-latin":"Gornji - latinski","Upper-roman":"Gornji - rimski"})}(window.CKEDITOR_TRANSLATIONS||(window.CKEDITOR_TRANSLATIONS={}));
+!function(e){const i=e["sr-latn"]=e["sr-latn"]||{};i.dictionary=Object.assign(i.dictionary||{},{"Bulleted List":"Nabrajane liste","Bulleted list styles toolbar":"Traka sa alatkama za nabrajane liste",Circle:"Krug",Decimal:"Decimala","Decimal with leading zero":"Decimalni broj sa nulom na početku","Decrease list item indent":"Smanji uvlačenje stavke liste",Disc:"Disk","Entering a to-do list":"Unošenje liste obaveza","Increase list item indent":"Povećaj uvlačenje stavke liste","Invalid start index value.":"Nevažeća vrednost početnog indeksa.","Keystrokes that can be used in a list":"Pritisci na tastere koji se mogu koristiti na listi","Leaving a to-do list":"Ostavljanje liste obaveza","List properties":"Navedite svojstva","Lower-latin":"Donji - latinski","Lower–roman":"Donji - rimski","Numbered List":"Lista sa brojevima","Numbered list styles toolbar":"Traka sa altakama za liste sa brojevima","Reversed order":"Obrnuti redosled",Square:"Kvadrat","Start at":"Početi u","Start index must be greater than 0.":"Početni indeks mora biti veći od 0.","To-do List":"Lista obaveza","Toggle the circle list style":"Uključite / isključite stil liste krugova","Toggle the decimal list style":"Uključi / isključi stil dekadne liste","Toggle the decimal with leading zero list style":"Prebaci decimalni znak sa vodećim stilom liste nula","Toggle the disc list style":"Uključite / isključite stil liste diskova","Toggle the lower–latin list style":"Uključite / isključite stil donje liste latinice","Toggle the lower–roman list style":"Uključite / isključite stil donje rimske liste","Toggle the square list style":"Uključite / isključite stil liste kvadrata","Toggle the upper–latin list style":"Uključite / isključite stil gornje liste latinice","Toggle the upper–roman list style":"Uključite / isključite stil gornje rimske liste","Upper-latin":"Gornji - latinski","Upper-roman":"Gornji - rimski"})}(window.CKEDITOR_TRANSLATIONS||(window.CKEDITOR_TRANSLATIONS={}));

package/dist/index.js

@@ -6,9 +6,9 @@ import { Command, Plugin, icons } from '@ckeditor/ckeditor5-core/dist/index.js';
 import { Delete } from '@ckeditor/ckeditor5-typing/dist/index.js';
 import { Enter } from '@ckeditor/ckeditor5-enter/dist/index.js';
 import { toArray, first, uid, CKEditorError, FocusTracker, KeystrokeHandler, global, getCode, parseKeystroke, getLocalizedArrowKeyCodeDirection, createElement, logWarning } from '@ckeditor/ckeditor5-utils/dist/index.js';
-import { UpcastWriter, DomEventObserver, Matcher, TreeWalker, getFillerOffset } from '@ckeditor/ckeditor5-engine/dist/index.js';
 import { ClipboardPipeline } from '@ckeditor/ckeditor5-clipboard/dist/index.js';
 import { ButtonView, MenuBarMenuListItemButtonView, View, ViewCollection, FocusCycler, addKeyboardHandlingForGrid, CollapsibleView, LabeledFieldView, createLabeledInputNumber, SwitchButtonView, createDropdown, SplitButtonView, focusChildOnDropdownOpen, MenuBarMenuView } from '@ckeditor/ckeditor5-ui/dist/index.js';
+import { DomEventObserver, Matcher, TreeWalker, getFillerOffset } from '@ckeditor/ckeditor5-engine/dist/index.js';
 
 /**
  * Document list blocks iterator.
@@ -1465,27 +1465,6 @@ import { ButtonView, MenuBarMenuListItemButtonView, View, ViewCollection, FocusC
         }
     };
 }
-/**
- * Returns the upcast converter for the `<ul>` and `<ol>` view elements that cleans the input view of garbage.
- * This is mostly to clean whitespaces from between the `<li>` view elements inside the view list element. However,
- * incorrect data can also be cleared if the view was incorrect.
- *
- * @internal
- */ function listUpcastCleanList() {
-    return (evt, data, conversionApi)=>{
-        if (!conversionApi.consumable.test(data.viewItem, {
-            name: true
-        })) {
-            return;
-        }
-        const viewWriter = new UpcastWriter(data.viewItem.document);
-        for (const child of Array.from(data.viewItem.getChildren())){
-            if (!isListItemView(child) && !isListView(child)) {
-                viewWriter.remove(child);
-            }
-        }
-    };
-}
 /**
  * Returns a model document change:data event listener that triggers conversion of related items if needed.
  *
@@ -2226,12 +2205,6 @@ function shouldUseBogusParagraph(item, attributeNames, blocks = getAllListItemBl
             converterPriority: 'high'
         }).add((dispatcher)=>{
             dispatcher.on('element:li', listItemUpcastConverter());
-            dispatcher.on('element:ul', listUpcastCleanList(), {
-                priority: 'high'
-            });
-            dispatcher.on('element:ol', listUpcastCleanList(), {
-                priority: 'high'
-            });
         });
         if (!multiBlock) {
             editor.conversion.for('downcast').elementToElement({
@@ -2582,7 +2555,14 @@ function shouldUseBogusParagraph(item, attributeNames, blocks = getAllListItemBl
         });
         return buttonView;
     });
-    editor.ui.componentFactory.add(`menuBar:${commandName}`, ()=>_createButton(MenuBarMenuListItemButtonView, editor, commandName, label, icon));
+    editor.ui.componentFactory.add(`menuBar:${commandName}`, ()=>{
+        const buttonView = _createButton(MenuBarMenuListItemButtonView, editor, commandName, label, icon);
+        buttonView.set({
+            role: 'menuitemcheckbox',
+            isToggleable: true
+        });
+        return buttonView;
+    });
 }
 /**
  * Creates a button to use either in toolbar or in menu bar.
@@ -3001,6 +2981,66 @@ for (const { listStyle, typeAttribute, listType } of LIST_STYLE_TYPES){
     }
 }
 
+/**
+ * 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.
+ */ 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;
+}
+
 const DEFAULT_LIST_TYPE$1 = 'default';
 /**
  * The document list properties engine feature.
@@ -3133,8 +3173,9 @@ const DEFAULT_LIST_TYPE$1 = 'default';
  * Creates an array of strategies for dealing with enabled listItem attributes.
  */ function createAttributeStrategies$1(enabledProperties) {
     const strategies = [];
+    const normalizedConfig = getNormalizedConfig(enabledProperties);
     if (enabledProperties.styles) {
-        const useAttribute = typeof enabledProperties.styles == 'object' && enabledProperties.styles.useAttribute;
+        const useAttribute = normalizedConfig.styles.useAttribute;
         strategies.push({
             attributeName: 'listStyle',
             defaultValue: DEFAULT_LIST_TYPE$1,
@@ -3333,7 +3374,7 @@ const DEFAULT_LIST_TYPE$1 = 'default';
         });
         // The rendering of the styles grid is conditional. When there is no styles grid, the view will render without collapsible
         // for numbered list properties, hence simplifying the layout.
-        if (enabledProperties.styles) {
+        if (styleButtonViews && styleButtonViews.length) {
             this.stylesView = this._createStylesView(styleButtonViews, styleGridAriaLabel);
             this.children.add(this.stylesView);
         } else {
@@ -3461,7 +3502,7 @@ const DEFAULT_LIST_TYPE$1 = 'default';
             numberedPropertyViews.push(this.reversedSwitchButtonView);
         }
         // When there are some style buttons, pack the numbered list properties into a collapsible to separate them.
-        if (enabledProperties.styles) {
+        if (this.stylesView) {
             this.additionalPropertiesCollapsibleView = new CollapsibleView(this.locale, numberedPropertyViews);
             this.additionalPropertiesCollapsibleView.set({
                 label: t('List properties'),
@@ -3563,10 +3604,12 @@ var listStyleUpperLatinIcon = "<svg viewBox=\"0 0 44 44\" xmlns=\"http://www.w3.
         const editor = this.editor;
         const t = editor.locale.t;
         const propertiesConfig = editor.config.get('list.properties');
+        const normalizedConfig = getNormalizedConfig(propertiesConfig);
+        const stylesListTypes = normalizedConfig.styles.listTypes;
         // Note: When this plugin does not register the "bulletedList" dropdown due to properties configuration,
         // a simple button will be still registered under the same name by ListUI as a fallback. This should happen
         // in most editor configuration because the List plugin automatically requires ListUI.
-        if (propertiesConfig.styles) {
+        if (stylesListTypes.includes('bulleted')) {
             const styleDefinitions = [
                 {
                     label: t('Toggle the disc list style'),
@@ -3592,7 +3635,7 @@ var listStyleUpperLatinIcon = "<svg viewBox=\"0 0 44 44\" xmlns=\"http://www.w3.
             const commandName = 'bulletedList';
             editor.ui.componentFactory.add(commandName, getDropdownViewCreator({
                 editor,
-                propertiesConfig,
+                normalizedConfig,
                 parentCommandName: commandName,
                 buttonLabel,
                 buttonIcon: icons.bulletedList,
@@ -3602,7 +3645,7 @@ var listStyleUpperLatinIcon = "<svg viewBox=\"0 0 44 44\" xmlns=\"http://www.w3.
             // Add the menu bar item for bulleted list.
             editor.ui.componentFactory.add(`menuBar:${commandName}`, getMenuBarStylesMenuCreator({
                 editor,
-                propertiesConfig,
+                normalizedConfig,
                 parentCommandName: commandName,
                 buttonLabel,
                 styleGridAriaLabel,
@@ -3612,7 +3655,7 @@ var listStyleUpperLatinIcon = "<svg viewBox=\"0 0 44 44\" xmlns=\"http://www.w3.
         // Note: When this plugin does not register the "numberedList" dropdown due to properties configuration,
         // a simple button will be still registered under the same name by ListUI as a fallback. This should happen
         // in most editor configuration because the List plugin automatically requires ListUI.
-        if (propertiesConfig.styles || propertiesConfig.startIndex || propertiesConfig.reversed) {
+        if (stylesListTypes.includes('numbered') || propertiesConfig.startIndex || propertiesConfig.reversed) {
             const styleDefinitions = [
                 {
                     label: t('Toggle the decimal list style'),
@@ -3656,7 +3699,7 @@ var listStyleUpperLatinIcon = "<svg viewBox=\"0 0 44 44\" xmlns=\"http://www.w3.
             const commandName = 'numberedList';
             editor.ui.componentFactory.add(commandName, getDropdownViewCreator({
                 editor,
-                propertiesConfig,
+                normalizedConfig,
                 parentCommandName: commandName,
                 buttonLabel,
                 buttonIcon: icons.numberedList,
@@ -3665,10 +3708,10 @@ var listStyleUpperLatinIcon = "<svg viewBox=\"0 0 44 44\" xmlns=\"http://www.w3.
             }));
             // Menu bar menu does not display list start index or reverse UI. If there are no styles enabled,
             // the menu makes no sense and should be omitted.
-            if (propertiesConfig.styles) {
+            if (stylesListTypes.includes('numbered')) {
                 editor.ui.componentFactory.add(`menuBar:${commandName}`, getMenuBarStylesMenuCreator({
                     editor,
-                    propertiesConfig,
+                    normalizedConfig,
                     parentCommandName: commandName,
                     buttonLabel,
                     styleGridAriaLabel,
@@ -3683,7 +3726,7 @@ var listStyleUpperLatinIcon = "<svg viewBox=\"0 0 44 44\" xmlns=\"http://www.w3.
  * which in turn contains buttons allowing users to change list styles in the context of the current selection.
  *
  * @param options.editor
- * @param options.propertiesConfig List properties configuration.
+ * @param options.normalizedConfig List properties configuration.
  * @param options.parentCommandName The name of the higher-order editor command associated with
  * the set of particular list styles (e.g. "bulletedList" for "disc", "circle", and "square" styles).
  * @param options.buttonLabel Label of the main part of the split button.
@@ -3691,7 +3734,7 @@ var listStyleUpperLatinIcon = "<svg viewBox=\"0 0 44 44\" xmlns=\"http://www.w3.
  * @param options.styleGridAriaLabel The ARIA label for the styles grid in the split button dropdown.
  * @param options.styleDefinitions Definitions of the style buttons.
  * @returns A function that can be passed straight into {@link module:ui/componentfactory~ComponentFactory#add}.
- */ function getDropdownViewCreator({ editor, propertiesConfig, parentCommandName, buttonLabel, buttonIcon, styleGridAriaLabel, styleDefinitions }) {
+ */ function getDropdownViewCreator({ editor, normalizedConfig, parentCommandName, buttonLabel, buttonIcon, styleGridAriaLabel, styleDefinitions }) {
     const parentCommand = editor.commands.get(parentCommandName);
     return (locale)=>{
         const dropdownView = createDropdown(locale, SplitButtonView);
@@ -3713,7 +3756,7 @@ var listStyleUpperLatinIcon = "<svg viewBox=\"0 0 44 44\" xmlns=\"http://www.w3.
         dropdownView.once('change:isOpen', ()=>{
             const listPropertiesView = createListPropertiesView({
                 editor,
-                propertiesConfig,
+                normalizedConfig,
                 dropdownView,
                 parentCommandName,
                 styleGridAriaLabel,
@@ -3777,23 +3820,24 @@ var listStyleUpperLatinIcon = "<svg viewBox=\"0 0 44 44\" xmlns=\"http://www.w3.
  * A helper that creates the properties view for the individual style dropdown.
  *
  * @param options.editor Editor instance.
- * @param options.propertiesConfig List properties configuration.
+ * @param options.normalizedConfig List properties configuration.
  * @param options.dropdownView Styles dropdown view that hosts the properties view.
  * @param options.parentCommandName The name of the higher-order editor command associated with
  * the set of particular list styles (e.g. "bulletedList" for "disc", "circle", and "square" styles).
  * @param options.styleDefinitions Definitions of the style buttons.
  * @param options.styleGridAriaLabel An assistive technologies label set on the grid of styles (if the grid is rendered).
- */ function createListPropertiesView({ editor, propertiesConfig, dropdownView, parentCommandName, styleDefinitions, styleGridAriaLabel }) {
+ */ function createListPropertiesView({ editor, normalizedConfig, dropdownView, parentCommandName, styleDefinitions, styleGridAriaLabel }) {
     const locale = editor.locale;
     const enabledProperties = {
-        ...propertiesConfig
+        ...normalizedConfig,
+        ...parentCommandName != 'numberedList' ? {
+            startIndex: false,
+            reversed: false
+        } : null
     };
-    if (parentCommandName != 'numberedList') {
-        enabledProperties.startIndex = false;
-        enabledProperties.reversed = false;
-    }
+    const listType = parentCommandName.replace('List', '');
     let styleButtonViews = null;
-    if (enabledProperties.styles) {
+    if (normalizedConfig.styles.listTypes.includes(listType)) {
         const listStyleCommand = editor.commands.get('listStyle');
         const styleButtonCreator = getStyleButtonCreator({
             editor,
@@ -3809,7 +3853,7 @@ var listStyleUpperLatinIcon = "<svg viewBox=\"0 0 44 44\" xmlns=\"http://www.w3.
         enabledProperties,
         styleButtonViews
     });
-    if (enabledProperties.styles) {
+    if (normalizedConfig.styles.listTypes.includes(listType)) {
         // Accessibility: focus the first active style when opening the dropdown.
         focusChildOnDropdownOpen(dropdownView, ()=>{
             return listPropertiesView.stylesView.children.find((child)=>child.isOn);
@@ -3840,12 +3884,11 @@ var listStyleUpperLatinIcon = "<svg viewBox=\"0 0 44 44\" xmlns=\"http://www.w3.
  * A helper that creates the list style submenu for menu bar.
  *
  * @param editor Editor instance.
- * @param propertiesConfig List properties configuration.
+ * @param normalizedConfig List properties configuration.
  * @param parentCommandName Name of the list command.
  * @param buttonLabel Label of the menu button.
  * @param styleGridAriaLabel ARIA label of the styles grid.
- * @param styleDefinitions Array of available styles for processed list type.
- */ function getMenuBarStylesMenuCreator({ editor, propertiesConfig, parentCommandName, buttonLabel, styleGridAriaLabel, styleDefinitions }) {
+ */ function getMenuBarStylesMenuCreator({ editor, normalizedConfig, parentCommandName, buttonLabel, styleGridAriaLabel, styleDefinitions }) {
     return (locale)=>{
         const menuView = new MenuBarMenuView(locale);
         const listCommand = editor.commands.get(parentCommandName);
@@ -3860,7 +3903,7 @@ var listStyleUpperLatinIcon = "<svg viewBox=\"0 0 44 44\" xmlns=\"http://www.w3.
         const listPropertiesView = new ListPropertiesView(locale, {
             styleGridAriaLabel,
             enabledProperties: {
-                ...propertiesConfig,
+                ...normalizedConfig,
                 // Disable list start index and reversed in the menu bar.
                 startIndex: false,
                 reversed: false
@@ -4043,15 +4086,13 @@ const ITEM_TOGGLE_KEYSTROKE$1 = /* #__PURE__ */ parseKeystroke('Ctrl+Enter');
         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());