@ckeditor/ckeditor5-enter 47.6.1 → 48.0.0-alpha.0

package/src/shiftenter.js

@@ -1,79 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module enter/shiftenter
- */
-import { ShiftEnterCommand } from './shiftentercommand.js';
-import { EnterObserver } from './enterobserver.js';
-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 class ShiftEnter extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'ShiftEnter';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    init() {
-        const editor = this.editor;
-        const schema = editor.model.schema;
-        const conversion = editor.conversion;
-        const view = editor.editing.view;
-        const viewDocument = view.document;
-        const t = this.editor.t;
-        // 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' });
-        // Add the information about the keystroke to the accessibility database.
-        editor.accessibility.addKeystrokeInfos({
-            keystrokes: [
-                {
-                    label: t('Insert a soft break (a <code>&lt;br&gt;</code> element)'),
-                    keystroke: 'Shift+Enter'
-                }
-            ]
-        });
-    }
-}

package/src/shiftentercommand.js

@@ -1,118 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module enter/shiftentercommand
- */
-import { Command } from '@ckeditor/ckeditor5-core';
-import { getCopyOnEnterAttributes } from './utils.js';
-/**
- * ShiftEnter command. It is used by the {@link module:enter/shiftenter~ShiftEnter ShiftEnter feature} to handle
- * the <kbd>Shift</kbd>+<kbd>Enter</kbd> keystroke.
- */
-export class ShiftEnterCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    execute() {
-        const model = this.editor.model;
-        const doc = model.document;
-        model.change(writer => {
-            softBreakAction(model, writer, doc.selection);
-            this.fire('afterExecute', { writer });
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const model = this.editor.model;
-        const doc = model.document;
-        this.isEnabled = isEnabled(model.schema, doc.selection);
-    }
-}
-/**
- * Checks whether the ShiftEnter command should be enabled in the specified selection.
- */
-function isEnabled(schema, selection) {
-    // At this moment it is okay to support single range selections only.
-    // But in the future we may need to change that.
-    if (selection.rangeCount > 1) {
-        return false;
-    }
-    const anchorPos = selection.anchor;
-    // Check whether the break element can be inserted in the current selection anchor.
-    if (!anchorPos || !schema.checkChild(anchorPos, 'softBreak')) {
-        return false;
-    }
-    const range = selection.getFirstRange();
-    const startElement = range.start.parent;
-    const endElement = range.end.parent;
-    // Do not modify the content if selection is cross-limit elements.
-    if ((isInsideLimitElement(startElement, schema) || isInsideLimitElement(endElement, schema)) && startElement !== endElement) {
-        return false;
-    }
-    return true;
-}
-/**
- * Creates a break in the way that the <kbd>Shift</kbd>+<kbd>Enter</kbd> keystroke is expected to work.
- */
-function softBreakAction(model, writer, selection) {
-    const isSelectionEmpty = selection.isCollapsed;
-    const range = selection.getFirstRange();
-    const startElement = range.start.parent;
-    const endElement = range.end.parent;
-    const isContainedWithinOneElement = (startElement == endElement);
-    if (isSelectionEmpty) {
-        const attributesToCopy = getCopyOnEnterAttributes(model.schema, selection.getAttributes());
-        insertBreak(model, writer, range.end);
-        writer.removeSelectionAttribute(selection.getAttributeKeys());
-        writer.setSelectionAttribute(attributesToCopy);
-    }
-    else {
-        const leaveUnmerged = !(range.start.isAtStart && range.end.isAtEnd);
-        model.deleteContent(selection, { leaveUnmerged });
-        // Selection within one element:
-        //
-        // <h>x[xx]x</h>		-> <h>x^x</h>			-> <h>x<br>^x</h>
-        if (isContainedWithinOneElement) {
-            insertBreak(model, writer, selection.focus);
-        }
-        // Selection over multiple elements.
-        //
-        // <h>x[x</h><p>y]y<p>	-> <h>x^</h><p>y</p>	-> <h>x</h><p>^y</p>
-        //
-        // We chose not to insert a line break in this case because:
-        //
-        // * it's not a very common scenario,
-        // * it actually surprised me when I saw the "expected behavior" in real life.
-        //
-        // It's ok if the user will need to be more specific where they want the <br> to be inserted.
-        else {
-            // Move the selection to the 2nd element (last step of the example above).
-            if (leaveUnmerged) {
-                writer.setSelection(endElement, 0);
-            }
-        }
-    }
-}
-function insertBreak(model, writer, position) {
-    const breakLineElement = writer.createElement('softBreak');
-    model.insertContent(breakLineElement, position);
-    writer.setSelection(breakLineElement, 'after');
-}
-/**
- * Checks whether the specified `element` is a child of the limit element.
- *
- * Checking whether the `<p>` element is inside a limit element:
- *   - `<$root><p>Text.</p></$root> => false`
- *   - `<$root><limitElement><p>Text</p></limitElement></$root> => true`
- */
-function isInsideLimitElement(element, schema) {
-    // `$root` is a limit element but in this case is an invalid element.
-    if (element.is('rootElement')) {
-        return false;
-    }
-    return schema.isLimit(element) || isInsideLimitElement(element.parent, schema);
-}

package/src/utils.js

@@ -1,21 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * Returns attributes that should be preserved on the enter keystroke.
- *
- * Filtering is realized based on `copyOnEnter` attribute property. Read more about attribute properties
- * {@link module:engine/model/schema~ModelSchema#setAttributeProperties here}.
- *
- * @param schema Model's schema.
- * @param allAttributes Attributes to filter.
- * @internal
- */
-export function* getCopyOnEnterAttributes(schema, allAttributes) {
-    for (const attribute of allAttributes) {
-        if (attribute && schema.getAttributeProperties(attribute[0]).copyOnEnter) {
-            yield attribute;
-        }
-    }
-}