@ckeditor/ckeditor5-pagination 44.1.0 → 44.2.0-alpha.0

package/theme/line.css

@@ -3,7 +3,7 @@
  * CKEditor 5 Collaboration is licensed under a commercial license and protected by copyright law. Where not otherwise indicated,
  * all CKEditor 5 Collaboration content is authored by CKSource engineers and consists of CKSource-owned intellectual property.
  *
- * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 

package/theme/pagenavigator.css

@@ -3,7 +3,7 @@
  * CKEditor 5 Collaboration is licensed under a commercial license and protected by copyright law. Where not otherwise indicated,
  * all CKEditor 5 Collaboration content is authored by CKSource engineers and consists of CKSource-owned intellectual property.
  *
- * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 

package/theme/pagination.css

@@ -3,7 +3,7 @@
  * CKEditor 5 Collaboration is licensed under a commercial license and protected by copyright law. Where not otherwise indicated,
  * all CKEditor 5 Collaboration content is authored by CKSource engineers and consists of CKSource-owned intellectual property.
  *
- * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 

package/dist/augmentation.d.ts

@@ -1,23 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-import type { PaginationConfig, Pagination } from './index.js';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the pagination feature. It is used by the pagination feature from the `@ckeditor/ckeditor5-pagination`
-         * package.
-         *
-         * Read more in {@link module:pagination/pagination~PaginationConfig}.
-         */
-        pagination?: PaginationConfig;
-    }
-    interface PluginsMap {
-        [Pagination.pluginName]: Pagination;
-    }
-}

package/dist/index.d.ts

@@ -1,13 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module pagination
- */
-export { default as Pagination, type PaginationConfig, type PaginationMarginsConfig } from './pagination.js';
-import './augmentation.js';

package/dist/legacyerrors.d.ts

@@ -1,9 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-export {};

package/dist/pagination.d.ts

@@ -1,147 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module pagination/pagination
- * @publicApi
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import PaginationEditing from './paginationediting.js';
-import PaginationUI from './paginationui.js';
-/**
- * The pagination feature.
- */
-export default class Pagination extends Plugin {
-    /**
-     * The current page number.
-     *
-     * @observable
-     * @default 1
-     * @readonly
-     */
-    readonly pageNumber: number;
-    /**
-     * The total page count.
-     *
-     * @observable
-     * @default 1
-     * @readonly
-     */
-    readonly totalPages: number;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Pagination";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof PaginationEditing, typeof PaginationUI];
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Scroll the editor content to a desired page.
-     *
-     * @param pageNumber The page number (counting from 1).
-     */
-    scrollToPage(pageNumber: number): void;
-}
-/**
- * The configuration of the pagination feature. It is used by the pagination feature from the `@ckeditor/ckeditor5-pagination` package.
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		pagination: {
- * 			// A4
- * 			pageWidth: '21cm',
- * 			pageHeight: '29.7cm',
- *
- * 			pageMargins: {
- * 				top: '20mm',
- * 				bottom: '20mm',
- * 				left: '12mm',
- * 				right: '12mm'
- * 			}
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * **NOTE:** The configuration of the plugin must match the {@link module:export-pdf/exportpdf~ExportPdfConfig export to PDF} or
- * {@link module:export-word/exportword~ExportWordConfig export to Word} feature configuration.
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface PaginationConfig {
-    /**
-     * The page width.
-     */
-    pageWidth: string;
-    /**
-     * The page height.
-     */
-    pageHeight: string;
-    /**
-     * The page margins.
-     */
-    pageMargins: PaginationMarginsConfig;
-    /**
-     * The pagination feature is by default enabled only in browsers that are using the Blink engine
-     * (Chrome, Chromium, newer Edge, newer Opera). This is due to some existing incompatibilities in Firefox and Safari;
-     * we will be working on them in the future.
-     *
-     * This behavior can be modified by setting this configuration value to `true`.
-     *
-     * @default false
-     */
-    enableOnUnsupportedBrowsers?: boolean;
-}
-/**
- * The configuration of the pagination feature page margins.
- */
-export interface PaginationMarginsConfig {
-    /**
-     * The top margin.
-     */
-    top: string;
-    /**
-     * The bottom margin.
-     */
-    bottom: string;
-    /**
-     * The left margin.
-     */
-    left: string;
-    /**
-     * The right margin.
-     */
-    right: string;
-}
-/**
- * The configuration required by the pagination plugin is missing.
- * Follow the instructions provided in {@glink features/pagination/pagination#configuration Pagination feature documentation}
- * to initialize the plugin properly.
- *
- * @error pagination-config-not-found
- * @param {module:core/editor/editorconfig~EditorConfig} config Configuration of the editor.
- */

package/dist/paginationediting.d.ts

@@ -1,82 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module pagination/paginationediting
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import PaginationLookup from './paginationlookup.js';
-import PaginationRenderer from './paginationrenderer.js';
-import '../theme/pagination.css';
-/**
- * The pagination editing plugin.
- */
-export default class PaginationEditing extends Plugin {
-    /**
-     * The current page number.
-     *
-     * @observable
-     * @default 1
-     * @readonly
-     */
-    readonly pageNumber: number;
-    /**
-     * The total page count.
-     *
-     * @observable
-     * @default 1
-     * @readonly
-     */
-    totalPages: number;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "PaginationEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof PaginationLookup, typeof PaginationRenderer];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Scroll the editor content to a desired page.
-     *
-     * @param pageNumber The page number (counting from 1).
-     */
-    scrollToPage(pageNumber: number): void;
-    /**
-     * Moves the selection to the beginning of a specific page.
-     *
-     * Also see {@link #scrollToPage}.
-     *
-     * @param pageNumber The page number (counting from 1).
-     */
-    moveSelectionToPage(pageNumber: number): void;
-    /**
-     * Scrolls the document and moves the user selection to the next page.
-     */
-    goToNextPage(): void;
-    /**
-     * Scrolls the document and moves the user selection to the previous page.
-     */
-    goToPreviousPage(): void;
-}

package/dist/paginationlookup.d.ts

@@ -1,70 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module pagination/paginationlookup
- */
-import type { Range } from 'ckeditor5/src/engine.js';
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * The pagination lookup plugin.
- */
-export default class PaginationLookup extends Plugin {
-    /**
-     * List of the page breaks.
-     *
-     * @observable
-     * @default []
-     * @readonly
-     */
-    pageBreaks: Array<PageBreakInfo>;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "PaginationLookup";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-}
-/**
- * Single page break information.
- */
-export declare class PageBreakInfo {
-    readonly type: 'manual' | 'element' | 'text';
-    readonly modelRange: Range;
-    /**
-     * Creates PageBreakInfo instance.
-     */
-    constructor({ type, modelRange, domNode, offset }: {
-        readonly type: PageBreakInfo['type'];
-        readonly modelRange: PageBreakInfo['modelRange'];
-        readonly domNode: Node;
-        readonly offset: number;
-    });
-    /**
-     * The top offset in window coordinates.
-     */
-    get offset(): number;
-}

package/dist/paginationrenderer.d.ts

@@ -1,52 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module pagination/paginationrenderer
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * The pagination renderer plugin. This plugin renders pagination lines (with numbers) over
- * the editing root of the editor.
- */
-export default class PaginationRenderer extends Plugin {
-    /**
-     * The current page number.
-     *
-     * @observable
-     * @default 1
-     * @readonly
-     */
-    pageNumber: number;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "PaginationRenderer";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Scroll the editor content to a desired page.
-     *
-     * @param pageNumber The page number (counting from 1).
-     */
-    scrollToPage(pageNumber: number): void;
-}

package/dist/paginationui.d.ts

@@ -1,37 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module pagination/paginationui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * The pagination UI plugin. It introduces:
- *
- * * The `'pageNavigation'` UI view,
- * * The `'nextPage'` UI button,
- * * The `'previousPage'` UI button.
- */
-export default class PaginationUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "PaginationUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/ui/linesrepository.d.ts

@@ -1,38 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module pagination/ui/linesrepository
- */
-import type { Editor } from 'ckeditor5/src/core.js';
-/**
- * Helper class for managing the page break lines.
- */
-export default class LinesRepository {
-    /**
-     * Creates a new lines repository instance.
-     */
-    constructor(editor: Editor);
-    /**
-     * Destroys the lines repository instance.
-     */
-    destroy(): void;
-    /**
-     * Hides all lines.
-     */
-    cleanLines(): void;
-    /**
-     * Shows a line at specified page coordinates.
-     *
-     * @param left
-     * @param top
-     * @param width
-     * @param pageNumber The page number (line label).
-     */
-    showLine(left: number, top: number, width: number, pageNumber: number): void;
-}

package/dist/ui/lineview.d.ts

@@ -1,57 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module pagination/ui/lineview
- */
-import { View } from 'ckeditor5/src/ui.js';
-import '../../theme/line.css';
-/**
- * The page break line view.
- */
-export default class LineView extends View {
-    /**
-     * Controls whether the line is visible.
-     *
-     * @observable
-     * @default false
-     */
-    isVisible: boolean;
-    /**
-     * Controls the line position x coordinate.
-     *
-     * @observable
-     * @default null
-     */
-    left: number | null;
-    /**
-     * Controls the line width.
-     *
-     * @observable
-     * @default null
-     */
-    width: number | null;
-    /**
-     * Controls the line label.
-     *
-     * @observable
-     * @default null
-     */
-    pageNumber: number | null;
-    /**
-     * Controls the line position y coordinate.
-     *
-     * @observable
-     * @default null
-     */
-    top: number | null;
-    /**
-     * @inheritDoc
-     */
-    constructor();
-}

package/dist/ui/pagenavigatorview.d.ts

@@ -1,65 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module pagination/ui/pagenavigatorview
- */
-import { View, InputNumberView } from 'ckeditor5/src/ui.js';
-import { type Locale } from 'ckeditor5/src/utils.js';
-import '../../theme/pagenavigator.css';
-/**
- * The page navigation UI element.
- */
-export default class PageNavigatorView extends View {
-    /**
-     * The current page number.
-     *
-     * @observable
-     * @default 1
-     */
-    pageNumber: number;
-    /**
-     * The total page count.
-     *
-     * @observable
-     * @default 1
-     */
-    totalPages: number;
-    /**
-     * Controls whether the component is enabled.
-     *
-     * @observable
-     * @default true
-     */
-    isEnabled: boolean;
-    /**
-     * An instance of the input number view to type a new page number.
-     */
-    pageNumberView: InputNumberView;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
-}
-/**
- * An event fired after {@link module:pagination/ui/pagenavigatorview~PageNavigatorView#pageNumberView} value is updated.
- *
- * @eventName ~PageNavigatorView#navigation
- */
-export type PaginationNavigationEvent = {
-    name: 'navigation';
-    args: [pageNumber: number];
-};

package/dist/utils/common-translations.d.ts

@@ -1,13 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module pagination/utils/common-translations
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-export declare function getTranslation(locale: Locale, id: string, ...args: Array<any>): string;