@ckeditor/ckeditor5-widget 39.0.1 → 40.0.0

package/src/highlightstack.d.ts

@@ -1,74 +1,74 @@
-/**
- * @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
- */
-import type { DowncastWriter, HighlightDescriptor } from '@ckeditor/ckeditor5-engine';
-declare const HighlightStack_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Emitter;
-    prototype: import("@ckeditor/ckeditor5-utils").Emitter;
-};
-/**
- * Class used to handle the correct order of highlights on elements.
- *
- * When different highlights are applied to same element the correct order should be preserved:
- *
- * * highlight with highest priority should be applied,
- * * if two highlights have same priority - sort by CSS class provided in
- * {@link module:engine/conversion/downcasthelpers~HighlightDescriptor}.
- *
- * This way, highlight will be applied with the same rules it is applied on texts.
- */
-export default class HighlightStack extends HighlightStack_base {
-    private readonly _stack;
-    /**
-     * Adds highlight descriptor to the stack.
-     *
-     * @fires change:top
-     */
-    add(descriptor: HighlightDescriptor, writer: DowncastWriter): void;
-    /**
-     * Removes highlight descriptor from the stack.
-     *
-     * @fires change:top
-     * @param id Id of the descriptor to remove.
-     */
-    remove(id: string, writer: DowncastWriter): void;
-    /**
-     * Inserts a given descriptor in correct place in the stack. It also takes care about updating information
-     * when descriptor with same id is already present.
-     */
-    private _insertDescriptor;
-    /**
-     * Removes descriptor with given id from the stack.
-     *
-     * @param id Descriptor's id.
-     */
-    private _removeDescriptor;
-}
-/**
- * Fired when top element on {@link module:widget/highlightstack~HighlightStack} has been changed
- *
- * @eventName ~HighlightStack#change:top
- */
-export type HighlightStackChangeEvent = {
-    name: 'change' | 'change:top';
-    args: [HighlightStackChangeEventData];
-};
-/**
- * Additional information about the change.
- */
-export type HighlightStackChangeEventData = {
-    /**
-     * Old highlight descriptor. It will be `undefined` when first descriptor is added to the stack.
-     */
-    oldDescriptor: HighlightDescriptor;
-    /**
-     * New highlight descriptor. It will be `undefined` when last descriptor is removed from the stack.
-     */
-    newDescriptor: HighlightDescriptor;
-    /**
-     * View writer that can be used to modify element.
-     */
-    writer: DowncastWriter;
-};
-export {};
+/**
+ * @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
+ */
+import type { DowncastWriter, HighlightDescriptor } from '@ckeditor/ckeditor5-engine';
+declare const HighlightStack_base: {
+    new (): import("@ckeditor/ckeditor5-utils").Emitter;
+    prototype: import("@ckeditor/ckeditor5-utils").Emitter;
+};
+/**
+ * Class used to handle the correct order of highlights on elements.
+ *
+ * When different highlights are applied to same element the correct order should be preserved:
+ *
+ * * highlight with highest priority should be applied,
+ * * if two highlights have same priority - sort by CSS class provided in
+ * {@link module:engine/conversion/downcasthelpers~HighlightDescriptor}.
+ *
+ * This way, highlight will be applied with the same rules it is applied on texts.
+ */
+export default class HighlightStack extends HighlightStack_base {
+    private readonly _stack;
+    /**
+     * Adds highlight descriptor to the stack.
+     *
+     * @fires change:top
+     */
+    add(descriptor: HighlightDescriptor, writer: DowncastWriter): void;
+    /**
+     * Removes highlight descriptor from the stack.
+     *
+     * @fires change:top
+     * @param id Id of the descriptor to remove.
+     */
+    remove(id: string, writer: DowncastWriter): void;
+    /**
+     * Inserts a given descriptor in correct place in the stack. It also takes care about updating information
+     * when descriptor with same id is already present.
+     */
+    private _insertDescriptor;
+    /**
+     * Removes descriptor with given id from the stack.
+     *
+     * @param id Descriptor's id.
+     */
+    private _removeDescriptor;
+}
+/**
+ * Fired when top element on {@link module:widget/highlightstack~HighlightStack} has been changed
+ *
+ * @eventName ~HighlightStack#change:top
+ */
+export type HighlightStackChangeEvent = {
+    name: 'change' | 'change:top';
+    args: [HighlightStackChangeEventData];
+};
+/**
+ * Additional information about the change.
+ */
+export type HighlightStackChangeEventData = {
+    /**
+     * Old highlight descriptor. It will be `undefined` when first descriptor is added to the stack.
+     */
+    oldDescriptor: HighlightDescriptor;
+    /**
+     * New highlight descriptor. It will be `undefined` when last descriptor is removed from the stack.
+     */
+    newDescriptor: HighlightDescriptor;
+    /**
+     * View writer that can be used to modify element.
+     */
+    writer: DowncastWriter;
+};
+export {};

package/src/highlightstack.js

@@ -1,129 +1,129 @@
-/**
- * @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 widget/highlightstack
- */
-import { EmitterMixin } from '@ckeditor/ckeditor5-utils';
-/**
- * Class used to handle the correct order of highlights on elements.
- *
- * When different highlights are applied to same element the correct order should be preserved:
- *
- * * highlight with highest priority should be applied,
- * * if two highlights have same priority - sort by CSS class provided in
- * {@link module:engine/conversion/downcasthelpers~HighlightDescriptor}.
- *
- * This way, highlight will be applied with the same rules it is applied on texts.
- */
-export default class HighlightStack extends EmitterMixin() {
-    constructor() {
-        super(...arguments);
-        this._stack = [];
-    }
-    /**
-     * Adds highlight descriptor to the stack.
-     *
-     * @fires change:top
-     */
-    add(descriptor, writer) {
-        const stack = this._stack;
-        // Save top descriptor and insert new one. If top is changed - fire event.
-        const oldTop = stack[0];
-        this._insertDescriptor(descriptor);
-        const newTop = stack[0];
-        // When new object is at the top and stores different information.
-        if (oldTop !== newTop && !compareDescriptors(oldTop, newTop)) {
-            this.fire('change:top', {
-                oldDescriptor: oldTop,
-                newDescriptor: newTop,
-                writer
-            });
-        }
-    }
-    /**
-     * Removes highlight descriptor from the stack.
-     *
-     * @fires change:top
-     * @param id Id of the descriptor to remove.
-     */
-    remove(id, writer) {
-        const stack = this._stack;
-        const oldTop = stack[0];
-        this._removeDescriptor(id);
-        const newTop = stack[0];
-        // When new object is at the top and stores different information.
-        if (oldTop !== newTop && !compareDescriptors(oldTop, newTop)) {
-            this.fire('change:top', {
-                oldDescriptor: oldTop,
-                newDescriptor: newTop,
-                writer
-            });
-        }
-    }
-    /**
-     * Inserts a given descriptor in correct place in the stack. It also takes care about updating information
-     * when descriptor with same id is already present.
-     */
-    _insertDescriptor(descriptor) {
-        const stack = this._stack;
-        const index = stack.findIndex(item => item.id === descriptor.id);
-        // Inserting exact same descriptor - do nothing.
-        if (compareDescriptors(descriptor, stack[index])) {
-            return;
-        }
-        // If descriptor with same id but with different information is on the stack - remove it.
-        if (index > -1) {
-            stack.splice(index, 1);
-        }
-        // Find correct place to insert descriptor in the stack.
-        // It has different information (for example priority) so it must be re-inserted in correct place.
-        let i = 0;
-        while (stack[i] && shouldABeBeforeB(stack[i], descriptor)) {
-            i++;
-        }
-        stack.splice(i, 0, descriptor);
-    }
-    /**
-     * Removes descriptor with given id from the stack.
-     *
-     * @param id Descriptor's id.
-     */
-    _removeDescriptor(id) {
-        const stack = this._stack;
-        const index = stack.findIndex(item => item.id === id);
-        // If descriptor with same id is on the list - remove it.
-        if (index > -1) {
-            stack.splice(index, 1);
-        }
-    }
-}
-/**
- * Compares two descriptors by checking their priority and class list.
- *
- * @returns Returns true if both descriptors are defined and have same priority and classes.
- */
-function compareDescriptors(a, b) {
-    return a && b && a.priority == b.priority && classesToString(a.classes) == classesToString(b.classes);
-}
-/**
- * Checks whenever first descriptor should be placed in the stack before second one.
- */
-function shouldABeBeforeB(a, b) {
-    if (a.priority > b.priority) {
-        return true;
-    }
-    else if (a.priority < b.priority) {
-        return false;
-    }
-    // When priorities are equal and names are different - use classes to compare.
-    return classesToString(a.classes) > classesToString(b.classes);
-}
-/**
- * Converts CSS classes passed with {@link module:engine/conversion/downcasthelpers~HighlightDescriptor} to
- * sorted string.
- */
-function classesToString(classes) {
-    return Array.isArray(classes) ? classes.sort().join(',') : classes;
-}
+/**
+ * @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 widget/highlightstack
+ */
+import { EmitterMixin } from '@ckeditor/ckeditor5-utils';
+/**
+ * Class used to handle the correct order of highlights on elements.
+ *
+ * When different highlights are applied to same element the correct order should be preserved:
+ *
+ * * highlight with highest priority should be applied,
+ * * if two highlights have same priority - sort by CSS class provided in
+ * {@link module:engine/conversion/downcasthelpers~HighlightDescriptor}.
+ *
+ * This way, highlight will be applied with the same rules it is applied on texts.
+ */
+export default class HighlightStack extends EmitterMixin() {
+    constructor() {
+        super(...arguments);
+        this._stack = [];
+    }
+    /**
+     * Adds highlight descriptor to the stack.
+     *
+     * @fires change:top
+     */
+    add(descriptor, writer) {
+        const stack = this._stack;
+        // Save top descriptor and insert new one. If top is changed - fire event.
+        const oldTop = stack[0];
+        this._insertDescriptor(descriptor);
+        const newTop = stack[0];
+        // When new object is at the top and stores different information.
+        if (oldTop !== newTop && !compareDescriptors(oldTop, newTop)) {
+            this.fire('change:top', {
+                oldDescriptor: oldTop,
+                newDescriptor: newTop,
+                writer
+            });
+        }
+    }
+    /**
+     * Removes highlight descriptor from the stack.
+     *
+     * @fires change:top
+     * @param id Id of the descriptor to remove.
+     */
+    remove(id, writer) {
+        const stack = this._stack;
+        const oldTop = stack[0];
+        this._removeDescriptor(id);
+        const newTop = stack[0];
+        // When new object is at the top and stores different information.
+        if (oldTop !== newTop && !compareDescriptors(oldTop, newTop)) {
+            this.fire('change:top', {
+                oldDescriptor: oldTop,
+                newDescriptor: newTop,
+                writer
+            });
+        }
+    }
+    /**
+     * Inserts a given descriptor in correct place in the stack. It also takes care about updating information
+     * when descriptor with same id is already present.
+     */
+    _insertDescriptor(descriptor) {
+        const stack = this._stack;
+        const index = stack.findIndex(item => item.id === descriptor.id);
+        // Inserting exact same descriptor - do nothing.
+        if (compareDescriptors(descriptor, stack[index])) {
+            return;
+        }
+        // If descriptor with same id but with different information is on the stack - remove it.
+        if (index > -1) {
+            stack.splice(index, 1);
+        }
+        // Find correct place to insert descriptor in the stack.
+        // It has different information (for example priority) so it must be re-inserted in correct place.
+        let i = 0;
+        while (stack[i] && shouldABeBeforeB(stack[i], descriptor)) {
+            i++;
+        }
+        stack.splice(i, 0, descriptor);
+    }
+    /**
+     * Removes descriptor with given id from the stack.
+     *
+     * @param id Descriptor's id.
+     */
+    _removeDescriptor(id) {
+        const stack = this._stack;
+        const index = stack.findIndex(item => item.id === id);
+        // If descriptor with same id is on the list - remove it.
+        if (index > -1) {
+            stack.splice(index, 1);
+        }
+    }
+}
+/**
+ * Compares two descriptors by checking their priority and class list.
+ *
+ * @returns Returns true if both descriptors are defined and have same priority and classes.
+ */
+function compareDescriptors(a, b) {
+    return a && b && a.priority == b.priority && classesToString(a.classes) == classesToString(b.classes);
+}
+/**
+ * Checks whenever first descriptor should be placed in the stack before second one.
+ */
+function shouldABeBeforeB(a, b) {
+    if (a.priority > b.priority) {
+        return true;
+    }
+    else if (a.priority < b.priority) {
+        return false;
+    }
+    // When priorities are equal and names are different - use classes to compare.
+    return classesToString(a.classes) > classesToString(b.classes);
+}
+/**
+ * Converts CSS classes passed with {@link module:engine/conversion/downcasthelpers~HighlightDescriptor} to
+ * sorted string.
+ */
+function classesToString(classes) {
+    return Array.isArray(classes) ? classes.sort().join(',') : classes;
+}

package/src/index.d.ts

@@ -1,13 +1,13 @@
-/**
- * @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 widget
- */
-export { default as Widget } from './widget';
-export { default as WidgetToolbarRepository } from './widgettoolbarrepository';
-export { default as WidgetResize } from './widgetresize';
-export { default as WidgetTypeAround } from './widgettypearound/widgettypearound';
-export * from './utils';
-import './augmentation';
+/**
+ * @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 widget
+ */
+export { default as Widget } from './widget';
+export { default as WidgetToolbarRepository } from './widgettoolbarrepository';
+export { default as WidgetResize } from './widgetresize';
+export { default as WidgetTypeAround } from './widgettypearound/widgettypearound';
+export * from './utils';
+import './augmentation';

package/src/index.js

@@ -1,13 +1,13 @@
-/**
- * @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 widget
- */
-export { default as Widget } from './widget';
-export { default as WidgetToolbarRepository } from './widgettoolbarrepository';
-export { default as WidgetResize } from './widgetresize';
-export { default as WidgetTypeAround } from './widgettypearound/widgettypearound';
-export * from './utils';
-import './augmentation';
+/**
+ * @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 widget
+ */
+export { default as Widget } from './widget';
+export { default as WidgetToolbarRepository } from './widgettoolbarrepository';
+export { default as WidgetResize } from './widgetresize';
+export { default as WidgetTypeAround } from './widgettypearound/widgettypearound';
+export * from './utils';
+import './augmentation';