@ckeditor/ckeditor5-page-break 39.0.1 → 40.0.0

package/src/pagebreakediting.js

@@ -1,102 +1,102 @@
-/**
- * @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 page-break/pagebreakediting
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { toWidget } from 'ckeditor5/src/widget';
-import PageBreakCommand from './pagebreakcommand';
-import '../theme/pagebreak.css';
-/**
- * The page break editing feature.
- */
-export default class PageBreakEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'PageBreakEditing';
-    }
-    /**
-     * @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 };
-            },
-            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~Element} to a page break widget:
- * * Adds a {@link module:engine/view/element~Element#_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 });
-}
+/**
+ * @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 page-break/pagebreakediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { toWidget } from 'ckeditor5/src/widget';
+import PageBreakCommand from './pagebreakcommand';
+import '../theme/pagebreak.css';
+/**
+ * The page break editing feature.
+ */
+export default class PageBreakEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'PageBreakEditing';
+    }
+    /**
+     * @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 };
+            },
+            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~Element} to a page break widget:
+ * * Adds a {@link module:engine/view/element~Element#_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.d.ts

@@ -1,21 +1,21 @@
-/**
- * @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 page-break/pagebreakui
- */
-import { Plugin } from 'ckeditor5/src/core';
-/**
- * The page break UI plugin.
- */
-export default class PageBreakUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "PageBreakUI";
-    /**
-     * @inheritDoc
-     */
-    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
+ */
+/**
+ * @module page-break/pagebreakui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+/**
+ * The page break UI plugin.
+ */
+export default class PageBreakUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "PageBreakUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/pagebreakui.js

@@ -1,45 +1,45 @@
-/**
- * @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 page-break/pagebreakui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { ButtonView } from 'ckeditor5/src/ui';
-import pageBreakIcon from '../theme/icons/pagebreak.svg';
-/**
- * The page break UI plugin.
- */
-export default class PageBreakUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'PageBreakUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const t = editor.t;
-        // Add pageBreak button to feature components.
-        editor.ui.componentFactory.add('pageBreak', locale => {
-            const command = editor.commands.get('pageBreak');
-            const view = new ButtonView(locale);
-            view.set({
-                label: t('Page break'),
-                icon: pageBreakIcon,
-                tooltip: true
-            });
-            view.bind('isEnabled').to(command, 'isEnabled');
-            // Execute command.
-            this.listenTo(view, 'execute', () => {
-                editor.execute('pageBreak');
-                editor.editing.view.focus();
-            });
-            return view;
-        });
-    }
-}
+/**
+ * @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 page-break/pagebreakui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { ButtonView } from 'ckeditor5/src/ui';
+import pageBreakIcon from '../theme/icons/pagebreak.svg';
+/**
+ * The page break UI plugin.
+ */
+export default class PageBreakUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'PageBreakUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.t;
+        // Add pageBreak button to feature components.
+        editor.ui.componentFactory.add('pageBreak', locale => {
+            const command = editor.commands.get('pageBreak');
+            const view = new ButtonView(locale);
+            view.set({
+                label: t('Page break'),
+                icon: pageBreakIcon,
+                tooltip: true
+            });
+            view.bind('isEnabled').to(command, 'isEnabled');
+            // Execute command.
+            this.listenTo(view, 'execute', () => {
+                editor.execute('pageBreak');
+                editor.editing.view.focus();
+            });
+            return view;
+        });
+    }
+}