@ckeditor/ckeditor5-restricted-editing 41.4.0-alpha.0 → 41.4.0

package/dist/translations/tr.umd.js

@@ -0,0 +1,11 @@
+/**
+ * @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
+ */
+
+( e => {
+const { [ 'tr' ]: { dictionary, getPluralForm } } = {"tr":{"dictionary":{"Disable editing":"Düzenlemeyi devre dışı bırak","Enable editing":"Düzenlemeyi etkinleştir","Previous editable region":"Önceki düzenlenebilir alan","Next editable region":"Sonraki düzenlenebilir alan","Navigate editable regions":"Düzenlenebilir alanlara git"},getPluralForm(n){return (n > 1);}}};
+e[ 'tr' ] ||= { dictionary: {}, getPluralForm: null };
+e[ 'tr' ].dictionary = Object.assign( e[ 'tr' ].dictionary, dictionary );
+e[ 'tr' ].getPluralForm = getPluralForm;
+} )( window.CKEDITOR_TRANSLATIONS ||= {} );

package/dist/translations/uk.umd.js

@@ -0,0 +1,11 @@
+/**
+ * @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
+ */
+
+( e => {
+const { [ 'uk' ]: { dictionary, getPluralForm } } = {"uk":{"dictionary":{"Disable editing":"Вимкнути редагування","Enable editing":"Увімкнути редагування","Previous editable region":"Попередня область редагування","Next editable region":"Наступна область редагування","Navigate editable regions":"Навігація по областях редагування"},getPluralForm(n){return (n % 1 == 0 && n % 10 == 1 && n % 100 != 11 ? 0 : n % 1 == 0 && n % 10 >= 2 && n % 10 <= 4 && (n % 100 < 12 || n % 100 > 14) ? 1 : n % 1 == 0 && (n % 10 ==0 || (n % 10 >=5 && n % 10 <=9) || (n % 100 >=11 && n % 100 <=14 )) ? 2: 3);}}};
+e[ 'uk' ] ||= { dictionary: {}, getPluralForm: null };
+e[ 'uk' ].dictionary = Object.assign( e[ 'uk' ].dictionary, dictionary );
+e[ 'uk' ].getPluralForm = getPluralForm;
+} )( window.CKEDITOR_TRANSLATIONS ||= {} );

package/dist/translations/ur.umd.js

@@ -0,0 +1,11 @@
+/**
+ * @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
+ */
+
+( e => {
+const { [ 'ur' ]: { dictionary, getPluralForm } } = {"ur":{"dictionary":{"Disable editing":"تدویں غیر فعال کریں","Enable editing":"تدوین فعال کریں","Previous editable region":"","Next editable region":"","Navigate editable regions":""},getPluralForm(n){return (n != 1);}}};
+e[ 'ur' ] ||= { dictionary: {}, getPluralForm: null };
+e[ 'ur' ].dictionary = Object.assign( e[ 'ur' ].dictionary, dictionary );
+e[ 'ur' ].getPluralForm = getPluralForm;
+} )( window.CKEDITOR_TRANSLATIONS ||= {} );

package/dist/translations/uz.umd.js

@@ -0,0 +1,11 @@
+/**
+ * @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
+ */
+
+( e => {
+const { [ 'uz' ]: { dictionary, getPluralForm } } = {"uz":{"dictionary":{"Disable editing":"Tahrirlashni o‘chirib qo‘yish","Enable editing":"Tahrirlashga ruxsat berish","Previous editable region":"Avvalgi tahrirlanadigan hudud","Next editable region":"Keyingi tahrirlanadigan hudud","Navigate editable regions":"Tahrirlanadigan hududlar boʻylab navigatsiya"},getPluralForm(n){return 0;}}};
+e[ 'uz' ] ||= { dictionary: {}, getPluralForm: null };
+e[ 'uz' ].dictionary = Object.assign( e[ 'uz' ].dictionary, dictionary );
+e[ 'uz' ].getPluralForm = getPluralForm;
+} )( window.CKEDITOR_TRANSLATIONS ||= {} );

package/dist/translations/vi.umd.js

@@ -0,0 +1,11 @@
+/**
+ * @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
+ */
+
+( e => {
+const { [ 'vi' ]: { dictionary, getPluralForm } } = {"vi":{"dictionary":{"Disable editing":"Tắt tính năng chỉnh sửa","Enable editing":"Bật tính năng chỉnh sửa","Previous editable region":"Vùng có thể chỉnh sửa trước đó","Next editable region":"Vùng có thể chỉnh sửa tiếp theo","Navigate editable regions":"Di chuyển giữa các vùng có thể chỉnh sửa"},getPluralForm(n){return 0;}}};
+e[ 'vi' ] ||= { dictionary: {}, getPluralForm: null };
+e[ 'vi' ].dictionary = Object.assign( e[ 'vi' ].dictionary, dictionary );
+e[ 'vi' ].getPluralForm = getPluralForm;
+} )( window.CKEDITOR_TRANSLATIONS ||= {} );

package/dist/translations/zh-cn.umd.js

@@ -0,0 +1,11 @@
+/**
+ * @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
+ */
+
+( e => {
+const { [ 'zh-cn' ]: { dictionary, getPluralForm } } = {"zh-cn":{"dictionary":{"Disable editing":"禁用编辑","Enable editing":"允许编辑","Previous editable region":"上一个可编辑区域","Next editable region":"下一个可编辑区域","Navigate editable regions":"导航至可编辑区域"},getPluralForm(n){return 0;}}};
+e[ 'zh-cn' ] ||= { dictionary: {}, getPluralForm: null };
+e[ 'zh-cn' ].dictionary = Object.assign( e[ 'zh-cn' ].dictionary, dictionary );
+e[ 'zh-cn' ].getPluralForm = getPluralForm;
+} )( window.CKEDITOR_TRANSLATIONS ||= {} );

package/dist/translations/zh.umd.js

@@ -0,0 +1,11 @@
+/**
+ * @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
+ */
+
+( e => {
+const { [ 'zh' ]: { dictionary, getPluralForm } } = {"zh":{"dictionary":{"Disable editing":"停用編輯","Enable editing":"啟用編輯","Previous editable region":"上一個可編輯區域","Next editable region":"下一個可編輯區域","Navigate editable regions":"編輯區域導航"},getPluralForm(n){return 0;}}};
+e[ 'zh' ] ||= { dictionary: {}, getPluralForm: null };
+e[ 'zh' ].dictionary = Object.assign( e[ 'zh' ].dictionary, dictionary );
+e[ 'zh' ].getPluralForm = getPluralForm;
+} )( window.CKEDITOR_TRANSLATIONS ||= {} );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-restricted-editing",
-  "version": "41.4.0-alpha.0",
+  "version": "41.4.0",
   "description": "Restricted editing feature for CKEditor 5 editors.",
   "keywords": [
     "ckeditor",
@@ -12,7 +12,7 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "41.4.0-alpha.0"
+    "ckeditor5": "41.4.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",

package/src/restrictededitingmodeediting.js

@@ -50,8 +50,18 @@ export default class RestrictedEditingModeEditing extends Plugin {
         // Commands & keystrokes that allow navigation in the content.
         editor.commands.add('goToPreviousRestrictedEditingException', new RestrictedEditingModeNavigationCommand(editor, 'backward'));
         editor.commands.add('goToNextRestrictedEditingException', new RestrictedEditingModeNavigationCommand(editor, 'forward'));
-        editor.keystrokes.set('Tab', getCommandExecuter(editor, 'goToNextRestrictedEditingException'));
-        editor.keystrokes.set('Shift+Tab', getCommandExecuter(editor, 'goToPreviousRestrictedEditingException'));
+        this.listenTo(editingView.document, 'tab', (evt, data) => {
+            const commandName = !data.shiftKey ? 'goToNextRestrictedEditingException' : 'goToPreviousRestrictedEditingException';
+            const command = editor.commands.get(commandName);
+            if (command.isEnabled) {
+                editor.execute(commandName);
+                // Stop the event in the DOM: no listener in the web page will be triggered by this event.
+                data.preventDefault();
+                data.stopPropagation();
+            }
+            // Stop the event bubbling in the editor: no more callbacks will be executed for this keystroke.
+            evt.stop();
+        }, { context: '$capture' });
         editor.keystrokes.set('Ctrl+A', getSelectAllHandler(editor));
         editingView.change(writer => {
             for (const root of editingView.document.roots) {
@@ -98,8 +108,43 @@ export default class RestrictedEditingModeEditing extends Plugin {
             }
         }));
         // Currently the marker helpers are tied to other use-cases and do not render a collapsed marker as highlight.
-        // That's why there are 2 downcast converters for them:
-        // 1. The default marker-to-highlight will wrap selected text with `<span>`.
+        // Also, markerToHighlight can not convert marker on an inline object. It handles only text and widgets,
+        // but it is not a case in the data pipeline. That's why there are 3 downcast converters for them:
+        //
+        // 1. The custom inline item (text or inline object) converter (but not the selection).
+        editor.conversion.for('downcast').add(dispatcher => {
+            dispatcher.on('addMarker:restrictedEditingException', (evt, data, conversionApi) => {
+                // Only convert per-item conversion.
+                if (!data.item) {
+                    return;
+                }
+                // Do not convert the selection or non-inline items.
+                if (data.item.is('selection') || !conversionApi.schema.isInline(data.item)) {
+                    return;
+                }
+                if (!conversionApi.consumable.consume(data.item, evt.name)) {
+                    return;
+                }
+                const viewWriter = conversionApi.writer;
+                const viewElement = viewWriter.createAttributeElement('span', {
+                    class: 'restricted-editing-exception'
+                }, {
+                    id: data.markerName,
+                    priority: -10
+                });
+                const viewRange = conversionApi.mapper.toViewRange(data.range);
+                const rangeAfterWrap = viewWriter.wrap(viewRange, viewElement);
+                for (const element of rangeAfterWrap.getItems()) {
+                    if (element.is('attributeElement') && element.isSimilar(viewElement)) {
+                        conversionApi.mapper.bindElementToMarker(element, data.markerName);
+                        // One attribute element is enough, because all of them are bound together by the view writer.
+                        // Mapper uses this binding to get all the elements no matter how many of them are registered in the mapper.
+                        break;
+                    }
+                }
+            });
+        });
+        // 2. The marker-to-highlight converter for the document selection.
         editor.conversion.for('downcast').markerToHighlight({
             model: 'restrictedEditingException',
             // Use callback to return new object every time new marker instance is created - otherwise it will be seen as the same marker.
@@ -111,8 +156,8 @@ export default class RestrictedEditingModeEditing extends Plugin {
                 };
             }
         });
-        // 2. But for collapsed marker we need to render it as an element.
-        // Additionally the editing pipeline should always display a collapsed marker.
+        // 3. And for collapsed marker we need to render it as an element.
+        // Additionally, the editing pipeline should always display a collapsed marker.
         editor.conversion.for('editingDowncast').markerToElement({
             model: 'restrictedEditingException',
             view: (markerData, { writer }) => {
@@ -231,18 +276,6 @@ export default class RestrictedEditingModeEditing extends Plugin {
         }
     }
 }
-/**
- * Helper method for executing enabled commands only.
- */
-function getCommandExecuter(editor, commandName) {
-    return (_, cancel) => {
-        const command = editor.commands.get(commandName);
-        if (command.isEnabled) {
-            editor.execute(commandName);
-            cancel();
-        }
-    };
-}
 /**
  * Helper for handling Ctrl+A keydown behaviour.
  */

package/src/restrictededitingmodeui.js

@@ -34,7 +34,9 @@ export default class RestrictedEditingModeUI extends Plugin {
             this._getButtonDefinitions().forEach(({ commandName, label, keystroke }) => {
                 listItems.add(this._getButtonDefinition(commandName, label, keystroke));
             });
-            addListToDropdown(dropdownView, listItems);
+            addListToDropdown(dropdownView, listItems, {
+                role: 'menu'
+            });
             dropdownView.buttonView.set({
                 label: t('Navigate editable regions'),
                 icon: lockIcon,
@@ -109,6 +111,7 @@ export default class RestrictedEditingModeUI extends Plugin {
                 withText: true,
                 keystroke,
                 withKeystroke: true,
+                role: 'menuitem',
                 _commandName: commandName
             })
         };