@ckeditor/ckeditor5-page-break 0.0.0-nightly-20260118.0 → 0.0.0-nightly-next-20260118.0

package/lang/translations/uz.po

@@ -1,16 +0,0 @@
-# Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
-#
-# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
-#
-# Check out the official contributor's guide:
-# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
-#
-msgid ""
-msgstr ""
-"Language: uz\n"
-"Plural-Forms: nplurals=2; plural=(n > 1);\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-
-msgctxt "Page break"
-msgid "Page break"
-msgstr "Sahifalar uzilishi"

package/lang/translations/vi.po

@@ -1,16 +0,0 @@
-# Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
-#
-# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
-#
-# Check out the official contributor's guide:
-# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
-#
-msgid ""
-msgstr ""
-"Language: vi\n"
-"Plural-Forms: nplurals=1; plural=0;\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-
-msgctxt "Page break"
-msgid "Page break"
-msgstr "Ngắt trang"

package/lang/translations/zh-cn.po

@@ -1,16 +0,0 @@
-# Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
-#
-# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
-#
-# Check out the official contributor's guide:
-# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
-#
-msgid ""
-msgstr ""
-"Language: zh_CN\n"
-"Plural-Forms: nplurals=1; plural=0;\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-
-msgctxt "Page break"
-msgid "Page break"
-msgstr "分页符"

package/lang/translations/zh.po

@@ -1,16 +0,0 @@
-# Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
-#
-# Want to contribute to this file? Submit your changes via a GitHub Pull Request.
-#
-# Check out the official contributor's guide:
-# https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
-#
-msgid ""
-msgstr ""
-"Language: zh_TW\n"
-"Plural-Forms: nplurals=1; plural=0;\n"
-"Content-Type: text/plain; charset=UTF-8\n"
-
-msgctxt "Page break"
-msgid "Page break"
-msgstr "換頁"

package/src/augmentation.js

@@ -1,5 +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
- */
-export {};

package/src/index.js

@@ -1,12 +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 page-break
- */
-export { PageBreak } from './pagebreak.js';
-export { PageBreakEditing } from './pagebreakediting.js';
-export { PageBreakUI } from './pagebreakui.js';
-export { PageBreakCommand } from './pagebreakcommand.js';
-import './augmentation.js';

package/src/pagebreak.js

@@ -1,38 +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 page-break/pagebreak
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { Widget } from 'ckeditor5/src/widget.js';
-import { PageBreakEditing } from './pagebreakediting.js';
-import { PageBreakUI } from './pagebreakui.js';
-/**
- * The page break feature.
- *
- * It provides the possibility to insert a page break into the rich-text editor.
- *
- * For a detailed overview, check the {@glink features/page-break Page break feature} documentation.
- */
-export class PageBreak extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [PageBreakEditing, PageBreakUI, Widget];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'PageBreak';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-}

package/src/pagebreakcommand.js

@@ -1,61 +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 page-break/pagebreakcommand
- */
-import { Command } from 'ckeditor5/src/core.js';
-import { findOptimalInsertionRange } from 'ckeditor5/src/widget.js';
-/**
- * The page break command.
- *
- * The command is registered by {@link module:page-break/pagebreakediting~PageBreakEditing} as `'pageBreak'`.
- *
- * To insert a page break at the current selection, execute the command:
- *
- *		editor.execute( 'pageBreak' );
- */
-export class PageBreakCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const model = this.editor.model;
-        const schema = model.schema;
-        const selection = model.document.selection;
-        this.isEnabled = isPageBreakAllowedInParent(selection, schema, model);
-    }
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     */
-    execute() {
-        const model = this.editor.model;
-        model.change(writer => {
-            const pageBreakElement = writer.createElement('pageBreak');
-            model.insertObject(pageBreakElement, null, null, {
-                setSelection: 'after'
-            });
-        });
-    }
-}
-/**
- * Checks if a page break is allowed by the schema in the optimal insertion parent.
- */
-function isPageBreakAllowedInParent(selection, schema, model) {
-    const parent = getInsertPageBreakParent(selection, model);
-    return schema.checkChild(parent, 'pageBreak');
-}
-/**
- * Returns a node that will be used to insert a page break with `model.insertContent` to check if the page break can be placed there.
- */
-function getInsertPageBreakParent(selection, model) {
-    const insertionRange = findOptimalInsertionRange(selection, model);
-    const parent = insertionRange.start.parent;
-    if (parent.isEmpty && !parent.is('element', '$root')) {
-        return parent.parent;
-    }
-    return parent;
-}

package/src/pagebreakediting.js

@@ -1,130 +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 page-break/pagebreakediting
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { toWidget } from 'ckeditor5/src/widget.js';
-import { PageBreakCommand } from './pagebreakcommand.js';
-import '../theme/pagebreak.css';
-/**
- * The page break editing feature.
- */
-export class PageBreakEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'PageBreakEditing';
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    static get licenseFeatureCode() {
-        return 'PB';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin() {
-        return true;
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const schema = editor.model.schema;
-        const t = editor.t;
-        const conversion = editor.conversion;
-        schema.register('pageBreak', {
-            inheritAllFrom: '$blockObject'
-        });
-        conversion.for('dataDowncast').elementToStructure({
-            model: 'pageBreak',
-            view: (modelElement, { writer }) => {
-                const divElement = writer.createContainerElement('div', {
-                    class: 'page-break',
-                    // If user has no `.ck-content` styles, it should always break a page during print.
-                    style: 'page-break-after: always'
-                }, 
-                // For a rationale of using span inside a div see:
-                // https://github.com/ckeditor/ckeditor5-page-break/pull/1#discussion_r328934062.
-                writer.createContainerElement('span', {
-                    style: 'display: none'
-                }));
-                return divElement;
-            }
-        });
-        conversion.for('editingDowncast').elementToStructure({
-            model: 'pageBreak',
-            view: (modelElement, { writer }) => {
-                const label = t('Page break');
-                const viewWrapper = writer.createContainerElement('div');
-                const viewLabelElement = writer.createRawElement('span', { class: 'page-break__label' }, function (domElement) {
-                    domElement.innerText = t('Page break');
-                });
-                writer.addClass('page-break', viewWrapper);
-                writer.insert(writer.createPositionAt(viewWrapper, 0), viewLabelElement);
-                return toPageBreakWidget(viewWrapper, writer, label);
-            }
-        });
-        conversion.for('upcast')
-            .elementToElement({
-            view: element => {
-                // For upcast conversion it's enough if we check for element style and verify if it's empty
-                // or contains only hidden span element.
-                const hasPageBreakBefore = element.getStyle('page-break-before') == 'always';
-                const hasPageBreakAfter = element.getStyle('page-break-after') == 'always';
-                if (!hasPageBreakBefore && !hasPageBreakAfter) {
-                    return null;
-                }
-                // The "page break" div accepts only single child or no child at all.
-                if (element.childCount == 1) {
-                    const viewSpan = element.getChild(0);
-                    // The child must be the "span" element that is not displayed.
-                    if (!viewSpan.is('element', 'span') || viewSpan.getStyle('display') != 'none') {
-                        return null;
-                    }
-                }
-                else if (element.childCount > 1) {
-                    return null;
-                }
-                return {
-                    name: true,
-                    styles: [
-                        ...(hasPageBreakBefore ? ['page-break-before'] : []),
-                        ...(hasPageBreakAfter ? ['page-break-after'] : [])
-                    ],
-                    ...element.hasClass('page-break') && {
-                        classes: ['page-break']
-                    }
-                };
-            },
-            model: 'pageBreak',
-            // This conversion must be checked before <br> conversion because some editors use
-            // <br style="page-break-before:always"> as a page break marker.
-            converterPriority: 'high'
-        });
-        editor.commands.add('pageBreak', new PageBreakCommand(editor));
-    }
-}
-/**
- * Converts a given {@link module:engine/view/element~ViewElement} to a page break widget:
- * * Adds a {@link module:engine/view/element~ViewElement#_setCustomProperty custom property} allowing to
- *   recognize the page break widget element.
- * * Calls the {@link module:widget/utils~toWidget} function with the proper element's label creator.
- */
-function toPageBreakWidget(viewElement, writer, label) {
-    writer.setCustomProperty('pageBreak', true, viewElement);
-    return toWidget(viewElement, writer, { label });
-}

package/src/pagebreakui.js

@@ -1,63 +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 page-break/pagebreakui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { IconPageBreak } from 'ckeditor5/src/icons.js';
-import { ButtonView, MenuBarMenuListItemButtonView } from 'ckeditor5/src/ui.js';
-/**
- * The page break UI plugin.
- */
-export class PageBreakUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'PageBreakUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin() {
-        return true;
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        // Add pageBreak button to feature components.
-        editor.ui.componentFactory.add('pageBreak', () => {
-            const view = this._createButton(ButtonView);
-            view.set({
-                tooltip: true
-            });
-            return view;
-        });
-        editor.ui.componentFactory.add('menuBar:pageBreak', () => this._createButton(MenuBarMenuListItemButtonView));
-    }
-    /**
-     * Creates a button for page break command to use either in toolbar or in menu bar.
-     */
-    _createButton(ButtonClass) {
-        const editor = this.editor;
-        const locale = editor.locale;
-        const command = editor.commands.get('pageBreak');
-        const view = new ButtonClass(editor.locale);
-        const t = locale.t;
-        view.set({
-            label: t('Page break'),
-            icon: IconPageBreak
-        });
-        view.bind('isEnabled').to(command, 'isEnabled');
-        // Execute the command.
-        this.listenTo(view, 'execute', () => {
-            editor.execute('pageBreak');
-            editor.editing.view.focus();
-        });
-        return view;
-    }
-}

package/theme/pagebreak.css

@@ -1,62 +0,0 @@
-/*
- * 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
- */
-
-.ck-content .page-break {
-	position: relative;
-	clear: both;
-	padding: 5px 0;
-	display: flex;
-	align-items: center;
-	justify-content: center;
-
-	&::after {
-		content: '';
-		position: absolute;
-		border-bottom: 2px dashed hsl(0, 0%, 77%);
-		width: 100%;
-	}
-}
-
-.ck-content .page-break__label {
-	position: relative;
-	z-index: 1;
-	padding: .3em .6em;
-	display: block;
-	text-transform: uppercase;
-	border: 1px solid hsl(0, 0%, 77%);
-	border-radius: 2px;
-	font-size: 0.75em;
-	font-weight: bold;
-	color: hsl(0, 0%, 20%);
-	background: hsl(0, 0%, 100%);
-	box-shadow: 2px 2px 1px hsla(0, 0%, 0%, 0.15);
-
-	/* Disable the possibility to select the label text by the user. */
-	-webkit-user-select: none;
-	-moz-user-select: none;
-	-ms-user-select: none;
-	user-select: none;
-}
-
-/* Do not show the page break element inside the print preview window. */
-@media print {
-	.ck-content .page-break {
-		padding: 0;
-
-		&::after {
-			display: none;
-		}
-	}
-
-	/*
-	 * From time to time placing page-break directly after a block element with margin causes appending a new blank page in pagination mode.
-	 * Removing margin-bottom from the block element fixes that issue and the margin is not being moved to the next blank page.
-	 *
-	 * Keep this in sync with the pagination plugins.
-	 */
-	.ck-content *:has(+ .page-break) {
-		margin-bottom: 0;
-	}
-}