@ckeditor/ckeditor5-minimap 39.0.2 → 40.0.0

package/src/minimapiframeview.js

@@ -1,67 +1,67 @@
-/**
- * @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 minimap/minimapiframeview
- */
-import { IframeView } from 'ckeditor5/src/ui';
-import { toUnit } from 'ckeditor5/src/utils';
-const toPx = toUnit('px');
-/**
- * The internal `<iframe>` view that hosts the minimap content.
- *
- * @internal
- */
-export default class MinimapIframeView extends IframeView {
-    /**
-     * Creates an instance of the internal minimap iframe.
-     */
-    constructor(locale, options) {
-        super(locale);
-        const bind = this.bindTemplate;
-        this.set('top', 0);
-        this.set('height', 0);
-        this._options = options;
-        this.extendTemplate({
-            attributes: {
-                class: [
-                    'ck-minimap__iframe'
-                ],
-                style: {
-                    top: bind.to('top', top => toPx(top)),
-                    height: bind.to('height', height => toPx(height))
-                }
-            }
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    render() {
-        return super.render().then(() => {
-            this._prepareDocument();
-        });
-    }
-    /**
-     * Sets the new height of the iframe.
-     */
-    setHeight(newHeight) {
-        this.height = newHeight;
-    }
-    /**
-     * Sets the top offset of the iframe to move it around vertically.
-     */
-    setTopOffset(newOffset) {
-        this.top = newOffset;
-    }
-    /**
-     * Sets the internal structure of the `<iframe>` readying it to display the
-     * minimap element.
-     */
-    _prepareDocument() {
-        const iframeDocument = this.element.contentWindow.document;
-        const domRootClone = iframeDocument.adoptNode(this._options.domRootClone);
+/**
+ * @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 minimap/minimapiframeview
+ */
+import { IframeView } from 'ckeditor5/src/ui';
+import { toUnit } from 'ckeditor5/src/utils';
+const toPx = toUnit('px');
+/**
+ * The internal `<iframe>` view that hosts the minimap content.
+ *
+ * @internal
+ */
+export default class MinimapIframeView extends IframeView {
+    /**
+     * Creates an instance of the internal minimap iframe.
+     */
+    constructor(locale, options) {
+        super(locale);
+        const bind = this.bindTemplate;
+        this.set('top', 0);
+        this.set('height', 0);
+        this._options = options;
+        this.extendTemplate({
+            attributes: {
+                class: [
+                    'ck-minimap__iframe'
+                ],
+                style: {
+                    top: bind.to('top', top => toPx(top)),
+                    height: bind.to('height', height => toPx(height))
+                }
+            }
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    render() {
+        return super.render().then(() => {
+            this._prepareDocument();
+        });
+    }
+    /**
+     * Sets the new height of the iframe.
+     */
+    setHeight(newHeight) {
+        this.height = newHeight;
+    }
+    /**
+     * Sets the top offset of the iframe to move it around vertically.
+     */
+    setTopOffset(newOffset) {
+        this.top = newOffset;
+    }
+    /**
+     * Sets the internal structure of the `<iframe>` readying it to display the
+     * minimap element.
+     */
+    _prepareDocument() {
+        const iframeDocument = this.element.contentWindow.document;
+        const domRootClone = iframeDocument.adoptNode(this._options.domRootClone);
         const boxStyles = this._options.useSimplePreview ? `
 			.ck.ck-editor__editable_inline img {
 				filter: contrast( 0 );
@@ -76,15 +76,15 @@ export default class MinimapIframeView extends IframeView {
 				background: hsl(0, 0%, 60%) !important;
 				color: hsl(0, 0%, 60%) !important;
 			}
-		` : '';
-        const pageStyles = this._options.pageStyles.map(definition => {
-            if (typeof definition === 'string') {
-                return `<style>${definition}</style>`;
-            }
-            else {
-                return `<link rel="stylesheet" type="text/css" href="${definition.href}">`;
-            }
-        }).join('\n');
+		` : '';
+        const pageStyles = this._options.pageStyles.map(definition => {
+            if (typeof definition === 'string') {
+                return `<style>${definition}</style>`;
+            }
+            else {
+                return `<link rel="stylesheet" type="text/css" href="${definition.href}">`;
+            }
+        }).join('\n');
         const html = `<!DOCTYPE html><html lang="en">
 			<head>
 				<meta charset="utf-8">
@@ -121,10 +121,10 @@ export default class MinimapIframeView extends IframeView {
 				</style>
 			</head>
 			<body class="${this._options.extraClasses || ''}"></body>
-		</html>`;
-        iframeDocument.open();
-        iframeDocument.write(html);
-        iframeDocument.close();
-        iframeDocument.body.appendChild(domRootClone);
-    }
-}
+		</html>`;
+        iframeDocument.open();
+        iframeDocument.write(html);
+        iframeDocument.close();
+        iframeDocument.body.appendChild(domRootClone);
+    }
+}

package/src/minimappositiontrackerview.d.ts

@@ -1,58 +1,58 @@
-/**
- * @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 minimap/minimappositiontrackerview
- */
-import { View } from 'ckeditor5/src/ui';
-import { type Locale } from 'ckeditor5/src/utils';
-/**
- * The position tracker visualizing the visible subset of the content. Displayed over the minimap.
- *
- * @internal
- */
-export default class MinimapPositionTrackerView extends View {
-    /**
-     * The CSS `height` of the tracker visualizing the subset of the content visible to the user.
-     *
-     * @readonly
-     */
-    height: number;
-    /**
-     * The CSS `top` of the tracker, used to move it vertically over the minimap.
-     *
-     * @readonly
-     */
-    top: number;
-    /**
-     * The scroll progress (in %) displayed over the tracker when being dragged by the user.
-     *
-     * @readonly
-     */
-    scrollProgress: number;
-    /**
-     * Indicates whether the tracker is being dragged by the user (e.g. using the mouse).
-     *
-     * @internal
-     * @readonly
-     */
-    _isDragging: boolean;
-    constructor(locale: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Sets the new height of the tracker to visualize the subset of the content visible to the user.
-     */
-    setHeight(newHeight: number): void;
-    /**
-     * Sets the top offset of the tracker to move it around vertically.
-     */
-    setTopOffset(newOffset: number): void;
-    /**
-     * Sets the scroll progress (in %) to inform the user using a label when the tracker is being dragged.
-     */
-    setScrollProgress(newProgress: number): 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 minimap/minimappositiontrackerview
+ */
+import { View } from 'ckeditor5/src/ui';
+import { type Locale } from 'ckeditor5/src/utils';
+/**
+ * The position tracker visualizing the visible subset of the content. Displayed over the minimap.
+ *
+ * @internal
+ */
+export default class MinimapPositionTrackerView extends View {
+    /**
+     * The CSS `height` of the tracker visualizing the subset of the content visible to the user.
+     *
+     * @readonly
+     */
+    height: number;
+    /**
+     * The CSS `top` of the tracker, used to move it vertically over the minimap.
+     *
+     * @readonly
+     */
+    top: number;
+    /**
+     * The scroll progress (in %) displayed over the tracker when being dragged by the user.
+     *
+     * @readonly
+     */
+    scrollProgress: number;
+    /**
+     * Indicates whether the tracker is being dragged by the user (e.g. using the mouse).
+     *
+     * @internal
+     * @readonly
+     */
+    _isDragging: boolean;
+    constructor(locale: Locale);
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+    /**
+     * Sets the new height of the tracker to visualize the subset of the content visible to the user.
+     */
+    setHeight(newHeight: number): void;
+    /**
+     * Sets the top offset of the tracker to move it around vertically.
+     */
+    setTopOffset(newOffset: number): void;
+    /**
+     * Sets the scroll progress (in %) to inform the user using a label when the tracker is being dragged.
+     */
+    setScrollProgress(newProgress: number): void;
+}

package/src/minimappositiontrackerview.js

@@ -1,78 +1,78 @@
-/**
- * @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 minimap/minimappositiontrackerview
- */
-import { View } from 'ckeditor5/src/ui';
-import { toUnit, global } from 'ckeditor5/src/utils';
-const toPx = toUnit('px');
-/**
- * The position tracker visualizing the visible subset of the content. Displayed over the minimap.
- *
- * @internal
- */
-export default class MinimapPositionTrackerView extends View {
-    constructor(locale) {
-        super(locale);
-        const bind = this.bindTemplate;
-        this.set('height', 0);
-        this.set('top', 0);
-        this.set('scrollProgress', 0);
-        this.set('_isDragging', false);
-        this.setTemplate({
-            tag: 'div',
-            attributes: {
-                class: [
-                    'ck',
-                    'ck-minimap__position-tracker',
-                    bind.if('_isDragging', 'ck-minimap__position-tracker_dragging')
-                ],
-                style: {
-                    top: bind.to('top', top => toPx(top)),
-                    height: bind.to('height', height => toPx(height))
-                },
-                'data-progress': bind.to('scrollProgress')
-            },
-            on: {
-                mousedown: bind.to(() => {
-                    this._isDragging = true;
-                })
-            }
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    render() {
-        super.render();
-        this.listenTo(global.document, 'mousemove', (evt, data) => {
-            if (!this._isDragging) {
-                return;
-            }
-            this.fire('drag', data.movementY);
-        }, { useCapture: true });
-        this.listenTo(global.document, 'mouseup', () => {
-            this._isDragging = false;
-        }, { useCapture: true });
-    }
-    /**
-     * Sets the new height of the tracker to visualize the subset of the content visible to the user.
-     */
-    setHeight(newHeight) {
-        this.height = newHeight;
-    }
-    /**
-     * Sets the top offset of the tracker to move it around vertically.
-     */
-    setTopOffset(newOffset) {
-        this.top = newOffset;
-    }
-    /**
-     * Sets the scroll progress (in %) to inform the user using a label when the tracker is being dragged.
-     */
-    setScrollProgress(newProgress) {
-        this.scrollProgress = newProgress;
-    }
-}
+/**
+ * @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 minimap/minimappositiontrackerview
+ */
+import { View } from 'ckeditor5/src/ui';
+import { toUnit, global } from 'ckeditor5/src/utils';
+const toPx = toUnit('px');
+/**
+ * The position tracker visualizing the visible subset of the content. Displayed over the minimap.
+ *
+ * @internal
+ */
+export default class MinimapPositionTrackerView extends View {
+    constructor(locale) {
+        super(locale);
+        const bind = this.bindTemplate;
+        this.set('height', 0);
+        this.set('top', 0);
+        this.set('scrollProgress', 0);
+        this.set('_isDragging', false);
+        this.setTemplate({
+            tag: 'div',
+            attributes: {
+                class: [
+                    'ck',
+                    'ck-minimap__position-tracker',
+                    bind.if('_isDragging', 'ck-minimap__position-tracker_dragging')
+                ],
+                style: {
+                    top: bind.to('top', top => toPx(top)),
+                    height: bind.to('height', height => toPx(height))
+                },
+                'data-progress': bind.to('scrollProgress')
+            },
+            on: {
+                mousedown: bind.to(() => {
+                    this._isDragging = true;
+                })
+            }
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    render() {
+        super.render();
+        this.listenTo(global.document, 'mousemove', (evt, data) => {
+            if (!this._isDragging) {
+                return;
+            }
+            this.fire('drag', data.movementY);
+        }, { useCapture: true });
+        this.listenTo(global.document, 'mouseup', () => {
+            this._isDragging = false;
+        }, { useCapture: true });
+    }
+    /**
+     * Sets the new height of the tracker to visualize the subset of the content visible to the user.
+     */
+    setHeight(newHeight) {
+        this.height = newHeight;
+    }
+    /**
+     * Sets the top offset of the tracker to move it around vertically.
+     */
+    setTopOffset(newOffset) {
+        this.top = newOffset;
+    }
+    /**
+     * Sets the scroll progress (in %) to inform the user using a label when the tracker is being dragged.
+     */
+    setScrollProgress(newProgress) {
+        this.scrollProgress = newProgress;
+    }
+}

package/src/minimapview.d.ts

@@ -1,109 +1,109 @@
-/**
- * @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 minimap/minimapview
- */
-import { View } from 'ckeditor5/src/ui';
-import { type Locale } from 'ckeditor5/src/utils';
-export type MinimapViewOptions = {
-    domRootClone: HTMLElement;
-    pageStyles: Array<string | {
-        href: string;
-    }>;
-    scaleRatio: number;
-    useSimplePreview?: boolean;
-    extraClasses?: string;
-};
-/**
- * The main view of the minimap. It renders the original content but scaled down with a tracker element
- * visualizing the subset of the content visible to the user and allowing interactions (scrolling, dragging).
- *
- * @internal
- */
-export default class MinimapView extends View {
-    /**
-     * An instance of the tracker view displayed over the minimap.
-     */
-    private readonly _positionTrackerView;
-    /**
-     * The scale ratio of the minimap relative to the original editing DOM root with the content.
-     */
-    private readonly _scaleRatio;
-    /**
-     * An instance of the iframe view that hosts the minimap.
-     */
-    private readonly _minimapIframeView;
-    /**
-     * Creates an instance of the minimap view.
-     */
-    constructor({ locale, scaleRatio, pageStyles, extraClasses, useSimplePreview, domRootClone }: {
-        locale: Locale;
-    } & MinimapViewOptions);
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Returns the DOM {@link module:utils/dom/rect~Rect} height of the minimap.
-     */
-    get height(): number;
-    /**
-     * Returns the number of available space (pixels) the position tracker (visible subset of the content) can use to scroll vertically.
-     */
-    get scrollHeight(): number;
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Sets the new height of the minimap (in px) to respond to the changes in the original editing DOM root.
-     *
-     * **Note**:The provided value should be the `offsetHeight` of the original editing DOM root.
-     */
-    setContentHeight(newHeight: number): void;
-    /**
-     * Sets the minimap scroll progress.
-     *
-     * The minimap scroll progress is linked to the original editing DOM root and its scrollable container (ancestor).
-     * Changing the progress will alter the vertical position of the minimap (and its position tracker) and give the user an accurate
-     * overview of the visible document.
-     *
-     * **Note**: The value should be between 0 and 1. 0 when the DOM root has not been scrolled, 1 when the
-     * scrolling has reached the end.
-     */
-    setScrollProgress(newScrollProgress: number): void;
-    /**
-     * Sets the new height of the tracker (in px) to visualize the subset of the content visible to the user.
-     */
-    setPositionTrackerHeight(trackerHeight: number): void;
-    /**
-     * @param data DOM event data
-     */
-    private _handleMinimapClick;
-    /**
-     * @param data DOM event data
-     */
-    private _handleMinimapMouseWheel;
-}
-/**
- * Fired when the minimap view is clicked.
- *
- * @eventName ~MinimapView#click
- * @param percentage The number between 0 and 1 representing a place in the minimap (its height) that was clicked.
- */
-export type MinimapClickEvent = {
-    name: 'click';
-    args: [percentage: number];
-};
-/**
- * Fired when the position tracker is dragged or the minimap is scrolled via mouse wheel.
- *
- * @eventName ~MinimapView#drag
- * @param movementY The vertical movement of the minimap as a result of dragging or scrolling.
- */
-export type MinimapDragEvent = {
-    name: 'drag';
-    args: [movementY: number];
-};
+/**
+ * @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 minimap/minimapview
+ */
+import { View } from 'ckeditor5/src/ui';
+import { type Locale } from 'ckeditor5/src/utils';
+export type MinimapViewOptions = {
+    domRootClone: HTMLElement;
+    pageStyles: Array<string | {
+        href: string;
+    }>;
+    scaleRatio: number;
+    useSimplePreview?: boolean;
+    extraClasses?: string;
+};
+/**
+ * The main view of the minimap. It renders the original content but scaled down with a tracker element
+ * visualizing the subset of the content visible to the user and allowing interactions (scrolling, dragging).
+ *
+ * @internal
+ */
+export default class MinimapView extends View {
+    /**
+     * An instance of the tracker view displayed over the minimap.
+     */
+    private readonly _positionTrackerView;
+    /**
+     * The scale ratio of the minimap relative to the original editing DOM root with the content.
+     */
+    private readonly _scaleRatio;
+    /**
+     * An instance of the iframe view that hosts the minimap.
+     */
+    private readonly _minimapIframeView;
+    /**
+     * Creates an instance of the minimap view.
+     */
+    constructor({ locale, scaleRatio, pageStyles, extraClasses, useSimplePreview, domRootClone }: {
+        locale: Locale;
+    } & MinimapViewOptions);
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Returns the DOM {@link module:utils/dom/rect~Rect} height of the minimap.
+     */
+    get height(): number;
+    /**
+     * Returns the number of available space (pixels) the position tracker (visible subset of the content) can use to scroll vertically.
+     */
+    get scrollHeight(): number;
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+    /**
+     * Sets the new height of the minimap (in px) to respond to the changes in the original editing DOM root.
+     *
+     * **Note**:The provided value should be the `offsetHeight` of the original editing DOM root.
+     */
+    setContentHeight(newHeight: number): void;
+    /**
+     * Sets the minimap scroll progress.
+     *
+     * The minimap scroll progress is linked to the original editing DOM root and its scrollable container (ancestor).
+     * Changing the progress will alter the vertical position of the minimap (and its position tracker) and give the user an accurate
+     * overview of the visible document.
+     *
+     * **Note**: The value should be between 0 and 1. 0 when the DOM root has not been scrolled, 1 when the
+     * scrolling has reached the end.
+     */
+    setScrollProgress(newScrollProgress: number): void;
+    /**
+     * Sets the new height of the tracker (in px) to visualize the subset of the content visible to the user.
+     */
+    setPositionTrackerHeight(trackerHeight: number): void;
+    /**
+     * @param data DOM event data
+     */
+    private _handleMinimapClick;
+    /**
+     * @param data DOM event data
+     */
+    private _handleMinimapMouseWheel;
+}
+/**
+ * Fired when the minimap view is clicked.
+ *
+ * @eventName ~MinimapView#click
+ * @param percentage The number between 0 and 1 representing a place in the minimap (its height) that was clicked.
+ */
+export type MinimapClickEvent = {
+    name: 'click';
+    args: [percentage: number];
+};
+/**
+ * Fired when the position tracker is dragged or the minimap is scrolled via mouse wheel.
+ *
+ * @eventName ~MinimapView#drag
+ * @param movementY The vertical movement of the minimap as a result of dragging or scrolling.
+ */
+export type MinimapDragEvent = {
+    name: 'drag';
+    args: [movementY: number];
+};