@ckeditor/ckeditor5-enter 40.0.0 → 40.2.0

package/src/entercommand.js

@@ -1,96 +1,96 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module enter/entercommand
- */
-import { Command } from '@ckeditor/ckeditor5-core';
-import { getCopyOnEnterAttributes } from './utils';
-/**
- * Enter command used by the {@link module:enter/enter~Enter Enter feature} to handle the <kbd>Enter</kbd> keystroke.
- */
-export default class EnterCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    execute() {
-        this.editor.model.change(writer => {
-            this.enterBlock(writer);
-            this.fire('afterExecute', { writer });
-        });
-    }
-    /**
-     * Splits a block where the document selection is placed, in the way how the <kbd>Enter</kbd> key is expected to work:
-     *
-     * ```
-     * <p>Foo[]bar</p>   ->   <p>Foo</p><p>[]bar</p>
-     * <p>Foobar[]</p>   ->   <p>Foobar</p><p>[]</p>
-     * <p>Fo[ob]ar</p>   ->   <p>Fo</p><p>[]ar</p>
-     * ```
-     *
-     * In some cases, the split will not happen:
-     *
-     * ```
-     * // The selection parent is a limit element:
-     * <figcaption>A[bc]d</figcaption>   ->   <figcaption>A[]d</figcaption>
-     *
-     * // The selection spans over multiple elements:
-     * <h>x[x</h><p>y]y<p>   ->   <h>x</h><p>[]y</p>
-     * ```
-     *
-     * @param writer Writer to use when performing the enter action.
-     * @returns Boolean indicating if the block was split.
-     */
-    enterBlock(writer) {
-        const model = this.editor.model;
-        const selection = model.document.selection;
-        const schema = model.schema;
-        const isSelectionEmpty = selection.isCollapsed;
-        const range = selection.getFirstRange();
-        const startElement = range.start.parent;
-        const endElement = range.end.parent;
-        // Don't touch the roots and other limit elements.
-        if (schema.isLimit(startElement) || schema.isLimit(endElement)) {
-            // Delete the selected content but only if inside a single limit element.
-            // Abort, when crossing limit elements boundary (e.g. <limit1>x[x</limit1>donttouchme<limit2>y]y</limit2>).
-            // This is an edge case and it's hard to tell what should actually happen because such a selection
-            // is not entirely valid.
-            if (!isSelectionEmpty && startElement == endElement) {
-                model.deleteContent(selection);
-            }
-            return false;
-        }
-        if (isSelectionEmpty) {
-            const attributesToCopy = getCopyOnEnterAttributes(writer.model.schema, selection.getAttributes());
-            splitBlock(writer, range.start);
-            writer.setSelectionAttribute(attributesToCopy);
-            return true;
-        }
-        else {
-            const leaveUnmerged = !(range.start.isAtStart && range.end.isAtEnd);
-            const isContainedWithinOneElement = (startElement == endElement);
-            model.deleteContent(selection, { leaveUnmerged });
-            if (leaveUnmerged) {
-                // Partially selected elements.
-                //
-                // <h>x[xx]x</h>		-> <h>x^x</h>			-> <h>x</h><h>^x</h>
-                if (isContainedWithinOneElement) {
-                    splitBlock(writer, selection.focus);
-                    return true;
-                }
-                // Selection over multiple elements.
-                //
-                // <h>x[x</h><p>y]y<p>	-> <h>x^</h><p>y</p>	-> <h>x</h><p>^y</p>
-                else {
-                    writer.setSelection(endElement, 0);
-                }
-            }
-        }
-        return false;
-    }
-}
-function splitBlock(writer, splitPos) {
-    writer.split(splitPos);
-    writer.setSelection(splitPos.parent.nextSibling, 0);
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module enter/entercommand
+ */
+import { Command } from '@ckeditor/ckeditor5-core';
+import { getCopyOnEnterAttributes } from './utils';
+/**
+ * Enter command used by the {@link module:enter/enter~Enter Enter feature} to handle the <kbd>Enter</kbd> keystroke.
+ */
+export default class EnterCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    execute() {
+        this.editor.model.change(writer => {
+            this.enterBlock(writer);
+            this.fire('afterExecute', { writer });
+        });
+    }
+    /**
+     * Splits a block where the document selection is placed, in the way how the <kbd>Enter</kbd> key is expected to work:
+     *
+     * ```
+     * <p>Foo[]bar</p>   ->   <p>Foo</p><p>[]bar</p>
+     * <p>Foobar[]</p>   ->   <p>Foobar</p><p>[]</p>
+     * <p>Fo[ob]ar</p>   ->   <p>Fo</p><p>[]ar</p>
+     * ```
+     *
+     * In some cases, the split will not happen:
+     *
+     * ```
+     * // The selection parent is a limit element:
+     * <figcaption>A[bc]d</figcaption>   ->   <figcaption>A[]d</figcaption>
+     *
+     * // The selection spans over multiple elements:
+     * <h>x[x</h><p>y]y<p>   ->   <h>x</h><p>[]y</p>
+     * ```
+     *
+     * @param writer Writer to use when performing the enter action.
+     * @returns Boolean indicating if the block was split.
+     */
+    enterBlock(writer) {
+        const model = this.editor.model;
+        const selection = model.document.selection;
+        const schema = model.schema;
+        const isSelectionEmpty = selection.isCollapsed;
+        const range = selection.getFirstRange();
+        const startElement = range.start.parent;
+        const endElement = range.end.parent;
+        // Don't touch the roots and other limit elements.
+        if (schema.isLimit(startElement) || schema.isLimit(endElement)) {
+            // Delete the selected content but only if inside a single limit element.
+            // Abort, when crossing limit elements boundary (e.g. <limit1>x[x</limit1>donttouchme<limit2>y]y</limit2>).
+            // This is an edge case and it's hard to tell what should actually happen because such a selection
+            // is not entirely valid.
+            if (!isSelectionEmpty && startElement == endElement) {
+                model.deleteContent(selection);
+            }
+            return false;
+        }
+        if (isSelectionEmpty) {
+            const attributesToCopy = getCopyOnEnterAttributes(writer.model.schema, selection.getAttributes());
+            splitBlock(writer, range.start);
+            writer.setSelectionAttribute(attributesToCopy);
+            return true;
+        }
+        else {
+            const leaveUnmerged = !(range.start.isAtStart && range.end.isAtEnd);
+            const isContainedWithinOneElement = (startElement == endElement);
+            model.deleteContent(selection, { leaveUnmerged });
+            if (leaveUnmerged) {
+                // Partially selected elements.
+                //
+                // <h>x[xx]x</h>		-> <h>x^x</h>			-> <h>x</h><h>^x</h>
+                if (isContainedWithinOneElement) {
+                    splitBlock(writer, selection.focus);
+                    return true;
+                }
+                // Selection over multiple elements.
+                //
+                // <h>x[x</h><p>y]y<p>	-> <h>x^</h><p>y</p>	-> <h>x</h><p>^y</p>
+                else {
+                    writer.setSelection(endElement, 0);
+                }
+            }
+        }
+        return false;
+    }
+}
+function splitBlock(writer, splitPos) {
+    writer.split(splitPos);
+    writer.setSelection(splitPos.parent.nextSibling, 0);
+}

package/src/enterobserver.d.ts

@@ -1,44 +1,44 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module enter/enterobserver
- */
-import { Observer, DomEventData, type View, type BubblingEvent } from '@ckeditor/ckeditor5-engine';
-/**
- * Enter observer introduces the {@link module:engine/view/document~Document#event:enter `Document#enter`} event.
- */
-export default class EnterObserver extends Observer {
-    /**
-     * @inheritDoc
-     */
-    constructor(view: View);
-    /**
-     * @inheritDoc
-     */
-    observe(): void;
-    /**
-     * @inheritDoc
-     */
-    stopObserving(): void;
-}
-/**
- * Fired when the user presses the <kbd>Enter</kbd> key.
- *
- * Note: This event is fired by the {@link module:enter/enterobserver~EnterObserver observer}
- * (usually registered by the {@link module:enter/enter~Enter Enter feature} and
- * {@link module:enter/shiftenter~ShiftEnter ShiftEnter feature}).
- *
- * @eventName module:engine/view/document~Document#enter
- */
-export type ViewDocumentEnterEvent = BubblingEvent<{
-    name: 'enter';
-    args: [EnterEventData];
-}>;
-export interface EnterEventData extends DomEventData<InputEvent> {
-    /**
-     * Whether it is a soft enter (<kbd>Shift</kbd>+<kbd>Enter</kbd>) or a hard enter (<kbd>Enter</kbd>).
-     */
-    isSoft: boolean;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module enter/enterobserver
+ */
+import { Observer, DomEventData, type View, type BubblingEvent } from '@ckeditor/ckeditor5-engine';
+/**
+ * Enter observer introduces the {@link module:engine/view/document~Document#event:enter `Document#enter`} event.
+ */
+export default class EnterObserver extends Observer {
+    /**
+     * @inheritDoc
+     */
+    constructor(view: View);
+    /**
+     * @inheritDoc
+     */
+    observe(): void;
+    /**
+     * @inheritDoc
+     */
+    stopObserving(): void;
+}
+/**
+ * Fired when the user presses the <kbd>Enter</kbd> key.
+ *
+ * Note: This event is fired by the {@link module:enter/enterobserver~EnterObserver observer}
+ * (usually registered by the {@link module:enter/enter~Enter Enter feature} and
+ * {@link module:enter/shiftenter~ShiftEnter ShiftEnter feature}).
+ *
+ * @eventName module:engine/view/document~Document#enter
+ */
+export type ViewDocumentEnterEvent = BubblingEvent<{
+    name: 'enter';
+    args: [EnterEventData];
+}>;
+export interface EnterEventData extends DomEventData<InputEvent> {
+    /**
+     * Whether it is a soft enter (<kbd>Shift</kbd>+<kbd>Enter</kbd>) or a hard enter (<kbd>Enter</kbd>).
+     */
+    isSoft: boolean;
+}

package/src/enterobserver.js

@@ -1,61 +1,61 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module enter/enterobserver
- */
-import { Observer, DomEventData, BubblingEventInfo } from '@ckeditor/ckeditor5-engine';
-import { env } from '@ckeditor/ckeditor5-utils';
-const ENTER_EVENT_TYPES = {
-    insertParagraph: { isSoft: false },
-    insertLineBreak: { isSoft: true }
-};
-/**
- * Enter observer introduces the {@link module:engine/view/document~Document#event:enter `Document#enter`} event.
- */
-export default class EnterObserver extends Observer {
-    /**
-     * @inheritDoc
-     */
-    constructor(view) {
-        super(view);
-        const doc = this.document;
-        let shiftPressed = false;
-        doc.on('keydown', (evt, data) => {
-            shiftPressed = data.shiftKey;
-        });
-        doc.on('beforeinput', (evt, data) => {
-            if (!this.isEnabled) {
-                return;
-            }
-            let inputType = data.inputType;
-            // See https://github.com/ckeditor/ckeditor5/issues/13321.
-            if (env.isSafari && shiftPressed && inputType == 'insertParagraph') {
-                inputType = 'insertLineBreak';
-            }
-            const domEvent = data.domEvent;
-            const enterEventSpec = ENTER_EVENT_TYPES[inputType];
-            if (!enterEventSpec) {
-                return;
-            }
-            const event = new BubblingEventInfo(doc, 'enter', data.targetRanges[0]);
-            doc.fire(event, new DomEventData(view, domEvent, {
-                isSoft: enterEventSpec.isSoft
-            }));
-            // Stop `beforeinput` event if `enter` event was stopped.
-            // https://github.com/ckeditor/ckeditor5/issues/753
-            if (event.stop.called) {
-                evt.stop();
-            }
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    observe() { }
-    /**
-     * @inheritDoc
-     */
-    stopObserving() { }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module enter/enterobserver
+ */
+import { Observer, DomEventData, BubblingEventInfo } from '@ckeditor/ckeditor5-engine';
+import { env } from '@ckeditor/ckeditor5-utils';
+const ENTER_EVENT_TYPES = {
+    insertParagraph: { isSoft: false },
+    insertLineBreak: { isSoft: true }
+};
+/**
+ * Enter observer introduces the {@link module:engine/view/document~Document#event:enter `Document#enter`} event.
+ */
+export default class EnterObserver extends Observer {
+    /**
+     * @inheritDoc
+     */
+    constructor(view) {
+        super(view);
+        const doc = this.document;
+        let shiftPressed = false;
+        doc.on('keydown', (evt, data) => {
+            shiftPressed = data.shiftKey;
+        });
+        doc.on('beforeinput', (evt, data) => {
+            if (!this.isEnabled) {
+                return;
+            }
+            let inputType = data.inputType;
+            // See https://github.com/ckeditor/ckeditor5/issues/13321.
+            if (env.isSafari && shiftPressed && inputType == 'insertParagraph') {
+                inputType = 'insertLineBreak';
+            }
+            const domEvent = data.domEvent;
+            const enterEventSpec = ENTER_EVENT_TYPES[inputType];
+            if (!enterEventSpec) {
+                return;
+            }
+            const event = new BubblingEventInfo(doc, 'enter', data.targetRanges[0]);
+            doc.fire(event, new DomEventData(view, domEvent, {
+                isSoft: enterEventSpec.isSoft
+            }));
+            // Stop `beforeinput` event if `enter` event was stopped.
+            // https://github.com/ckeditor/ckeditor5/issues/753
+            if (event.stop.called) {
+                evt.stop();
+            }
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    observe() { }
+    /**
+     * @inheritDoc
+     */
+    stopObserving() { }
+}

package/src/index.d.ts

@@ -1,13 +1,13 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module enter
- */
-export { default as Enter } from './enter';
-export { default as ShiftEnter } from './shiftenter';
-export type { ViewDocumentEnterEvent } from './enterobserver';
-export type { default as EnterCommand, EnterCommandAfterExecuteEvent } from './entercommand';
-export type { default as ShiftEnterCommand } from './shiftentercommand';
-import './augmentation';
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module enter
+ */
+export { default as Enter } from './enter';
+export { default as ShiftEnter } from './shiftenter';
+export type { ViewDocumentEnterEvent } from './enterobserver';
+export type { default as EnterCommand, EnterCommandAfterExecuteEvent } from './entercommand';
+export type { default as ShiftEnterCommand } from './shiftentercommand';
+import './augmentation';

package/src/index.js

@@ -1,10 +1,10 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module enter
- */
-export { default as Enter } from './enter';
-export { default as ShiftEnter } from './shiftenter';
-import './augmentation';
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module enter
+ */
+export { default as Enter } from './enter';
+export { default as ShiftEnter } from './shiftenter';
+import './augmentation';

package/src/shiftenter.d.ts

@@ -1,19 +1,19 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-/**
- * This plugin handles the <kbd>Shift</kbd>+<kbd>Enter</kbd> keystroke (soft line break) in the editor.
- *
- * See also the {@link module:enter/enter~Enter} plugin.
- *
- * For more information about this feature see the {@glink api/enter package page}.
- */
-export default class ShiftEnter extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ShiftEnter";
-    init(): void;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+/**
+ * This plugin handles the <kbd>Shift</kbd>+<kbd>Enter</kbd> keystroke (soft line break) in the editor.
+ *
+ * See also the {@link module:enter/enter~Enter} plugin.
+ *
+ * For more information about this feature see the {@glink api/enter package page}.
+ */
+export default class ShiftEnter extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ShiftEnter";
+    init(): void;
+}

package/src/shiftenter.js

@@ -1,63 +1,63 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module enter/shiftenter
- */
-import ShiftEnterCommand from './shiftentercommand';
-import EnterObserver from './enterobserver';
-import { Plugin } from '@ckeditor/ckeditor5-core';
-/**
- * This plugin handles the <kbd>Shift</kbd>+<kbd>Enter</kbd> keystroke (soft line break) in the editor.
- *
- * See also the {@link module:enter/enter~Enter} plugin.
- *
- * For more information about this feature see the {@glink api/enter package page}.
- */
-export default class ShiftEnter extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'ShiftEnter';
-    }
-    init() {
-        const editor = this.editor;
-        const schema = editor.model.schema;
-        const conversion = editor.conversion;
-        const view = editor.editing.view;
-        const viewDocument = view.document;
-        // Configure the schema.
-        schema.register('softBreak', {
-            allowWhere: '$text',
-            isInline: true
-        });
-        // Configure converters.
-        conversion.for('upcast')
-            .elementToElement({
-            model: 'softBreak',
-            view: 'br'
-        });
-        conversion.for('downcast')
-            .elementToElement({
-            model: 'softBreak',
-            view: (modelElement, { writer }) => writer.createEmptyElement('br')
-        });
-        view.addObserver(EnterObserver);
-        editor.commands.add('shiftEnter', new ShiftEnterCommand(editor));
-        this.listenTo(viewDocument, 'enter', (evt, data) => {
-            // When not in composition, we handle the action, so prevent the default one.
-            // When in composition, it's the browser who modify the DOM (renderer is disabled).
-            if (!viewDocument.isComposing) {
-                data.preventDefault();
-            }
-            // The hard enter key is handled by the Enter plugin.
-            if (!data.isSoft) {
-                return;
-            }
-            editor.execute('shiftEnter');
-            view.scrollToTheSelection();
-        }, { priority: 'low' });
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module enter/shiftenter
+ */
+import ShiftEnterCommand from './shiftentercommand';
+import EnterObserver from './enterobserver';
+import { Plugin } from '@ckeditor/ckeditor5-core';
+/**
+ * This plugin handles the <kbd>Shift</kbd>+<kbd>Enter</kbd> keystroke (soft line break) in the editor.
+ *
+ * See also the {@link module:enter/enter~Enter} plugin.
+ *
+ * For more information about this feature see the {@glink api/enter package page}.
+ */
+export default class ShiftEnter extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ShiftEnter';
+    }
+    init() {
+        const editor = this.editor;
+        const schema = editor.model.schema;
+        const conversion = editor.conversion;
+        const view = editor.editing.view;
+        const viewDocument = view.document;
+        // Configure the schema.
+        schema.register('softBreak', {
+            allowWhere: '$text',
+            isInline: true
+        });
+        // Configure converters.
+        conversion.for('upcast')
+            .elementToElement({
+            model: 'softBreak',
+            view: 'br'
+        });
+        conversion.for('downcast')
+            .elementToElement({
+            model: 'softBreak',
+            view: (modelElement, { writer }) => writer.createEmptyElement('br')
+        });
+        view.addObserver(EnterObserver);
+        editor.commands.add('shiftEnter', new ShiftEnterCommand(editor));
+        this.listenTo(viewDocument, 'enter', (evt, data) => {
+            // When not in composition, we handle the action, so prevent the default one.
+            // When in composition, it's the browser who modify the DOM (renderer is disabled).
+            if (!viewDocument.isComposing) {
+                data.preventDefault();
+            }
+            // The hard enter key is handled by the Enter plugin.
+            if (!data.isSoft) {
+                return;
+            }
+            editor.execute('shiftEnter');
+            view.scrollToTheSelection();
+        }, { priority: 'low' });
+    }
+}