@ckeditor/ckeditor5-restricted-editing 0.0.0-nightly-20240423.0 → 0.0.0-nightly-20240425.0

package/dist/types/restrictededitingmodenavigationcommand.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @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
+ */
+/**
+ * @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
+ */
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+/**
+ * The command that allows navigation across the exceptions in the edited document.
+ */
+export default class RestrictedEditingModeNavigationCommand extends Command {
+    /**
+     * The direction of the command.
+     */
+    private _direction;
+    /**
+     * Creates an instance of the command.
+     *
+     * @param editor The editor instance.
+     * @param direction The direction that the command works.
+     */
+    constructor(editor: Editor, direction: RestrictedEditingModeNavigationDirection);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     */
+    execute(): void;
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    private _checkEnabled;
+}
+/**
+ * Directions in which the
+ * {@link module:restricted-editing/restrictededitingmodenavigationcommand~RestrictedEditingModeNavigationCommand} can work.
+ */
+export type RestrictedEditingModeNavigationDirection = 'forward' | 'backward';

package/dist/types/restrictededitingmodeui.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @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
+ */
+/**
+ * @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 restricted-editing/restrictededitingmodeui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The restricted editing mode UI feature.
+ *
+ * It introduces the `'restrictedEditing'` dropdown that offers tools to navigate between exceptions across
+ * the document.
+ */
+export default class RestrictedEditingModeUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "RestrictedEditingModeUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Creates a button for restricted editing command to use in menu bar.
+     */
+    private _createMenuBarButton;
+    /**
+     * Returns a definition of the navigation button to be used in the dropdown.
+     *
+     * @param commandName The name of the command that the button represents.
+     * @param label The translated label of the button.
+     * @param keystroke The button keystroke.
+     */
+    private _getButtonDefinition;
+    /**
+     * Returns definitions for UI buttons.
+     *
+     * @internal
+     */
+    private _getButtonDefinitions;
+}

package/dist/types/standardeditingmode.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @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
+ */
+/**
+ * @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 restricted-editing/standardeditingmode
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import StandardEditingModeEditing from './standardeditingmodeediting.js';
+import StandardEditingModeUI from './standardeditingmodeui.js';
+import '../theme/restrictedediting.css';
+/**
+ * The standard editing mode plugin.
+ *
+ * This is a "glue" plugin that loads the following plugins:
+ *
+ * * The {@link module:restricted-editing/standardeditingmodeediting~StandardEditingModeEditing standard mode editing feature}.
+ * * The {@link module:restricted-editing/standardeditingmodeui~StandardEditingModeUI standard mode UI feature}.
+ */
+export default class StandardEditingMode extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "StandardEditingMode";
+    static get requires(): readonly [typeof StandardEditingModeEditing, typeof StandardEditingModeUI];
+}

package/dist/types/standardeditingmodeediting.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @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
+ */
+/**
+ * @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 restricted-editing/standardeditingmodeediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The standard editing mode editing feature.
+ *
+ * * It introduces the `restrictedEditingException` text attribute that is rendered as
+ * a `<span>` element with the `restricted-editing-exception` CSS class.
+ * * It registers the `'restrictedEditingException'` command.
+ */
+export default class StandardEditingModeEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "StandardEditingModeEditing";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/dist/types/standardeditingmodeui.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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
+ */
+/**
+ * @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 restricted-editing/standardeditingmodeui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The standard editing mode UI feature.
+ *
+ * It introduces the `'restrictedEditingException'` button that marks text as unrestricted for editing.
+ */
+export default class StandardEditingModeUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "StandardEditingModeUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Creates a button for restricted editing exception command to use either in toolbar or in menu bar.
+     */
+    private _createButton;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-restricted-editing",
-  "version": "0.0.0-nightly-20240423.0",
+  "version": "0.0.0-nightly-20240425.0",
   "description": "Restricted editing feature for CKEditor 5 editors.",
   "keywords": [
     "ckeditor",
@@ -12,7 +12,7 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "0.0.0-nightly-20240423.0"
+    "ckeditor5": "0.0.0-nightly-20240425.0"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",
@@ -24,6 +24,7 @@
     "directory": "packages/ckeditor5-restricted-editing"
   },
   "files": [
+    "dist",
     "lang",
     "src/**/*.js",
     "src/**/*.d.ts",

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) {
@@ -231,18 +241,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.
  */