@ckeditor/ckeditor5-undo 0.0.0-internal-20241017.0

package/src/undoediting.js

@@ -0,0 +1,102 @@
+/**
+ * @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 undo/undoediting
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import UndoCommand from './undocommand.js';
+import RedoCommand from './redocommand.js';
+/**
+ * The undo engine feature.
+ *
+ * It introduces the `'undo'` and `'redo'` commands to the editor.
+ */
+export default class UndoEditing extends Plugin {
+    constructor() {
+        super(...arguments);
+        /**
+         * Keeps track of which batches were registered in undo.
+         */
+        this._batchRegistry = new WeakSet();
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'UndoEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.t;
+        // Create commands.
+        this._undoCommand = new UndoCommand(editor);
+        this._redoCommand = new RedoCommand(editor);
+        // Register command to the editor.
+        editor.commands.add('undo', this._undoCommand);
+        editor.commands.add('redo', this._redoCommand);
+        this.listenTo(editor.model, 'applyOperation', (evt, args) => {
+            const operation = args[0];
+            // Do not register batch if the operation is not a document operation.
+            // This prevents from creating empty undo steps, where all operations where non-document operations.
+            // Non-document operations creates and alters content in detached tree fragments (for example, document fragments).
+            // Most of time this is preparing data before it is inserted into actual tree (for example during copy & paste).
+            // Such operations should not be reversed.
+            if (!operation.isDocumentOperation) {
+                return;
+            }
+            const batch = operation.batch;
+            const isRedoBatch = this._redoCommand.createdBatches.has(batch);
+            const isUndoBatch = this._undoCommand.createdBatches.has(batch);
+            const wasProcessed = this._batchRegistry.has(batch);
+            // Skip the batch if it was already processed.
+            if (wasProcessed) {
+                return;
+            }
+            // Add the batch to the registry so it will not be processed again.
+            this._batchRegistry.add(batch);
+            if (!batch.isUndoable) {
+                return;
+            }
+            if (isRedoBatch) {
+                // If this batch comes from `redoCommand`, add it to the `undoCommand` stack.
+                this._undoCommand.addBatch(batch);
+            }
+            else if (!isUndoBatch) {
+                // If the batch comes neither  from `redoCommand` nor from `undoCommand` then it is a new, regular batch.
+                // Add the batch to the `undoCommand` stack and clear the `redoCommand` stack.
+                this._undoCommand.addBatch(batch);
+                this._redoCommand.clearStack();
+            }
+        }, { priority: 'highest' });
+        this.listenTo(this._undoCommand, 'revert', (evt, undoneBatch, undoingBatch) => {
+            this._redoCommand.addBatch(undoingBatch);
+        });
+        editor.keystrokes.set('CTRL+Z', 'undo');
+        editor.keystrokes.set('CTRL+Y', 'redo');
+        editor.keystrokes.set('CTRL+SHIFT+Z', 'redo');
+        // Add the information about the keystrokes to the accessibility database.
+        editor.accessibility.addKeystrokeInfos({
+            keystrokes: [
+                {
+                    label: t('Undo'),
+                    keystroke: 'CTRL+Z'
+                },
+                {
+                    label: t('Redo'),
+                    keystroke: [['CTRL+Y'], ['CTRL+SHIFT+Z']]
+                }
+            ]
+        });
+    }
+}

package/src/undoui.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @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 undo/undoui
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+/**
+ * The undo UI feature. It introduces the `'undo'` and `'redo'` buttons to the editor.
+ */
+export default class UndoUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "UndoUI";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Creates a button for the specified command.
+     *
+     * @param name Command name.
+     * @param label Button label.
+     * @param keystroke Command keystroke.
+     * @param Icon Source of the icon.
+     */
+    private _addButtonsToFactory;
+    /**
+     * TODO
+     */
+    private _createButton;
+}

package/src/undoui.js

@@ -0,0 +1,79 @@
+/**
+ * @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 undo/undoui
+ */
+import { icons, Plugin } from '@ckeditor/ckeditor5-core';
+import { ButtonView, MenuBarMenuListItemButtonView } from '@ckeditor/ckeditor5-ui';
+/**
+ * The undo UI feature. It introduces the `'undo'` and `'redo'` buttons to the editor.
+ */
+export default class UndoUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'UndoUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const locale = editor.locale;
+        const t = editor.t;
+        const localizedUndoIcon = locale.uiLanguageDirection == 'ltr' ? icons.undo : icons.redo;
+        const localizedRedoIcon = locale.uiLanguageDirection == 'ltr' ? icons.redo : icons.undo;
+        this._addButtonsToFactory('undo', t('Undo'), 'CTRL+Z', localizedUndoIcon);
+        this._addButtonsToFactory('redo', t('Redo'), 'CTRL+Y', localizedRedoIcon);
+    }
+    /**
+     * Creates a button for the specified command.
+     *
+     * @param name Command name.
+     * @param label Button label.
+     * @param keystroke Command keystroke.
+     * @param Icon Source of the icon.
+     */
+    _addButtonsToFactory(name, label, keystroke, Icon) {
+        const editor = this.editor;
+        editor.ui.componentFactory.add(name, () => {
+            const buttonView = this._createButton(ButtonView, name, label, keystroke, Icon);
+            buttonView.set({
+                tooltip: true
+            });
+            return buttonView;
+        });
+        editor.ui.componentFactory.add('menuBar:' + name, () => {
+            return this._createButton(MenuBarMenuListItemButtonView, name, label, keystroke, Icon);
+        });
+    }
+    /**
+     * TODO
+     */
+    _createButton(ButtonClass, name, label, keystroke, Icon) {
+        const editor = this.editor;
+        const locale = editor.locale;
+        const command = editor.commands.get(name);
+        const view = new ButtonClass(locale);
+        view.set({
+            label,
+            icon: Icon,
+            keystroke
+        });
+        view.bind('isEnabled').to(command, 'isEnabled');
+        this.listenTo(view, 'execute', () => {
+            editor.execute(name);
+            editor.editing.view.focus();
+        });
+        return view;
+    }
+}