@ckeditor/ckeditor5-ui 48.2.0 → 48.3.0-alpha.1

package/dist/model.d.ts

@@ -1,22 +1,23 @@
 /**
- * @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
- */
-declare const UIModel_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Observable;
-    prototype: import("@ckeditor/ckeditor5-utils").Observable;
-};
+* @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
+*/
 /**
- * The base MVC model class.
- */
-export declare class UIModel extends /* #__PURE__ */ UIModel_base {
-    [x: string]: unknown;
-    /**
-     * Creates a new Model instance.
-     *
-     * @param attributes The model state attributes to be defined during the instance creation.
-     * @param properties The (out of state) properties to be appended to the instance during creation.
-     */
-    constructor(attributes?: Record<string, unknown>, properties?: Record<string, unknown>);
+* @module ui/model
+*/
+import { type ObservableMixinConstructor } from "@ckeditor/ckeditor5-utils";
+declare const UIModelBase: ObservableMixinConstructor;
+/**
+* The base MVC model class.
+*/
+export declare class UIModel extends UIModelBase {
+	[x: string]: unknown;
+	/**
+	* Creates a new Model instance.
+	*
+	* @param attributes The model state attributes to be defined during the instance creation.
+	* @param properties The (out of state) properties to be appended to the instance during creation.
+	*/
+	constructor(attributes?: Record<string, unknown>, properties?: Record<string, unknown>);
 }
 export {};

package/dist/notification/notification.d.ts

@@ -1,215 +1,215 @@
 /**
- * @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
- */
+* @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 ui/notification/notification
- */
-import { ContextPlugin } from '@ckeditor/ckeditor5-core';
+* @module ui/notification/notification
+*/
+import { ContextPlugin } from "@ckeditor/ckeditor5-core";
 /**
- * The Notification plugin.
- *
- * This plugin sends a few types of notifications: `success`, `info` and `warning`. The notifications need to be
- * handled and displayed by a plugin responsible for showing the UI of the notifications. Using this plugin for dispatching
- * notifications makes it possible to switch the notifications UI.
- *
- * Note that every unhandled and not stopped `warning` notification will be displayed as a system alert.
- * See {@link module:ui/notification/notification~Notification#showWarning}.
- */
+* The Notification plugin.
+*
+* This plugin sends a few types of notifications: `success`, `info` and `warning`. The notifications need to be
+* handled and displayed by a plugin responsible for showing the UI of the notifications. Using this plugin for dispatching
+* notifications makes it possible to switch the notifications UI.
+*
+* Note that every unhandled and not stopped `warning` notification will be displayed as a system alert.
+* See {@link module:ui/notification/notification~Notification#showWarning}.
+*/
 export declare class Notification extends ContextPlugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Notification";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Shows a success notification.
-     *
-     * By default, it fires the {@link #event:show:success `show:success` event} with the given `data`. The event namespace can be extended
-     * using the `data.namespace` option. For example:
-     *
-     * ```ts
-     * showSuccess( 'Image is uploaded.', {
-     * 	namespace: 'upload:image'
-     * } );
-     * ```
-     *
-     * will fire the `show:success:upload:image` event.
-     *
-     * You can provide the title of the notification:
-     *
-     * ```ts
-     * showSuccess( 'Image is uploaded.', {
-     * 	title: 'Image upload success'
-     * } );
-     * ```
-     *
-     * @param message The content of the notification.
-     * @param data Additional data.
-     * @param data.namespace Additional event namespace.
-     * @param data.title The title of the notification.
-     */
-    showSuccess(message: string, data?: {
-        namespace?: string;
-        title?: string;
-    }): void;
-    /**
-     * Shows an information notification.
-     *
-     * By default, it fires the {@link #event:show:info `show:info` event} with the given `data`. The event namespace can be extended
-     * using the `data.namespace` option. For example:
-     *
-     * ```ts
-     * showInfo( 'Editor is offline.', {
-     * 	namespace: 'editor:status'
-     * } );
-     * ```
-     *
-     * will fire the `show:info:editor:status` event.
-     *
-     * You can provide the title of the notification:
-     *
-     * ```ts
-     * showInfo( 'Editor is offline.', {
-     * 	title: 'Network information'
-     * } );
-     * ```
-     *
-     * @param message The content of the notification.
-     * @param data Additional data.
-     * @param data.namespace Additional event namespace.
-     * @param data.title The title of the notification.
-     */
-    showInfo(message: string, data?: {
-        namespace?: string;
-        title?: string;
-    }): void;
-    /**
-     * Shows a warning notification.
-     *
-     * By default, it fires the {@link #event:show:warning `show:warning` event}
-     * with the given `data`. The event namespace can be extended using the `data.namespace` option. For example:
-     *
-     * ```ts
-     * showWarning( 'Image upload error.', {
-     * 	namespace: 'upload:image'
-     * } );
-     * ```
-     *
-     * will fire the `show:warning:upload:image` event.
-     *
-     * You can provide the title of the notification:
-     *
-     * ```ts
-     * showWarning( 'Image upload error.', {
-     * 	title: 'Upload failed'
-     * } );
-     * ```
-     *
-     * Note that each unhandled and not stopped `warning` notification will be displayed as a system alert.
-     * The plugin responsible for displaying warnings should `stop()` the event to prevent displaying it as an alert:
-     *
-     * ```ts
-     * notifications.on( 'show:warning', ( evt, data ) => {
-     * 	// Do something with the data.
-     *
-     * 	// Stop this event to prevent displaying it as an alert.
-     * 	evt.stop();
-     * } );
-     * ```
-     *
-     * You can attach many listeners to the same event and `stop()` this event in a listener with a low priority:
-     *
-     * ```ts
-     * notifications.on( 'show:warning', ( evt, data ) => {
-     * 	// Show the warning in the UI, but do not stop it.
-     * } );
-     *
-     * notifications.on( 'show:warning', ( evt, data ) => {
-     * 	// Log the warning to some error tracker.
-     *
-     * 	// Stop this event to prevent displaying it as an alert.
-     * 	evt.stop();
-     * }, { priority: 'low' } );
-     * ```
-     *
-     * @param message The content of the notification.
-     * @param data Additional data.
-     * @param data.namespace Additional event namespace.
-     * @param data.title The title of the notification.
-     */
-    showWarning(message: string, data?: {
-        namespace?: string;
-        title?: string;
-    }): void;
-    /**
-     * Fires the `show` event with the specified type, namespace and message.
-     *
-     * @param data The message data.
-     * @param data.message The content of the notification.
-     * @param data.type The type of the message.
-     * @param data.namespace Additional event namespace.
-     * @param data.title The title of the notification.
-     */
-    private _showNotification;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "Notification";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Shows a success notification.
+	*
+	* By default, it fires the {@link #event:show:success `show:success` event} with the given `data`. The event namespace can be extended
+	* using the `data.namespace` option. For example:
+	*
+	* ```ts
+	* showSuccess( 'Image is uploaded.', {
+	* 	namespace: 'upload:image'
+	* } );
+	* ```
+	*
+	* will fire the `show:success:upload:image` event.
+	*
+	* You can provide the title of the notification:
+	*
+	* ```ts
+	* showSuccess( 'Image is uploaded.', {
+	* 	title: 'Image upload success'
+	* } );
+	* ```
+	*
+	* @param message The content of the notification.
+	* @param data Additional data.
+	* @param data.namespace Additional event namespace.
+	* @param data.title The title of the notification.
+	*/
+	showSuccess(message: string, data?: {
+		namespace?: string;
+		title?: string;
+	}): void;
+	/**
+	* Shows an information notification.
+	*
+	* By default, it fires the {@link #event:show:info `show:info` event} with the given `data`. The event namespace can be extended
+	* using the `data.namespace` option. For example:
+	*
+	* ```ts
+	* showInfo( 'Editor is offline.', {
+	* 	namespace: 'editor:status'
+	* } );
+	* ```
+	*
+	* will fire the `show:info:editor:status` event.
+	*
+	* You can provide the title of the notification:
+	*
+	* ```ts
+	* showInfo( 'Editor is offline.', {
+	* 	title: 'Network information'
+	* } );
+	* ```
+	*
+	* @param message The content of the notification.
+	* @param data Additional data.
+	* @param data.namespace Additional event namespace.
+	* @param data.title The title of the notification.
+	*/
+	showInfo(message: string, data?: {
+		namespace?: string;
+		title?: string;
+	}): void;
+	/**
+	* Shows a warning notification.
+	*
+	* By default, it fires the {@link #event:show:warning `show:warning` event}
+	* with the given `data`. The event namespace can be extended using the `data.namespace` option. For example:
+	*
+	* ```ts
+	* showWarning( 'Image upload error.', {
+	* 	namespace: 'upload:image'
+	* } );
+	* ```
+	*
+	* will fire the `show:warning:upload:image` event.
+	*
+	* You can provide the title of the notification:
+	*
+	* ```ts
+	* showWarning( 'Image upload error.', {
+	* 	title: 'Upload failed'
+	* } );
+	* ```
+	*
+	* Note that each unhandled and not stopped `warning` notification will be displayed as a system alert.
+	* The plugin responsible for displaying warnings should `stop()` the event to prevent displaying it as an alert:
+	*
+	* ```ts
+	* notifications.on( 'show:warning', ( evt, data ) => {
+	* 	// Do something with the data.
+	*
+	* 	// Stop this event to prevent displaying it as an alert.
+	* 	evt.stop();
+	* } );
+	* ```
+	*
+	* You can attach many listeners to the same event and `stop()` this event in a listener with a low priority:
+	*
+	* ```ts
+	* notifications.on( 'show:warning', ( evt, data ) => {
+	* 	// Show the warning in the UI, but do not stop it.
+	* } );
+	*
+	* notifications.on( 'show:warning', ( evt, data ) => {
+	* 	// Log the warning to some error tracker.
+	*
+	* 	// Stop this event to prevent displaying it as an alert.
+	* 	evt.stop();
+	* }, { priority: 'low' } );
+	* ```
+	*
+	* @param message The content of the notification.
+	* @param data Additional data.
+	* @param data.namespace Additional event namespace.
+	* @param data.title The title of the notification.
+	*/
+	showWarning(message: string, data?: {
+		namespace?: string;
+		title?: string;
+	}): void;
+	/**
+	* Fires the `show` event with the specified type, namespace and message.
+	*
+	* @param data The message data.
+	* @param data.message The content of the notification.
+	* @param data.type The type of the message.
+	* @param data.namespace Additional event namespace.
+	* @param data.title The title of the notification.
+	*/
+	private _showNotification;
 }
-export type NotificationEventType = 'success' | 'info' | 'warning';
+export type NotificationEventType = "success" | "info" | "warning";
 /**
- * Fired when one of the `showSuccess()`, `showInfo()`, `showWarning()` methods is called.
- *
- * @eventName ~Notification#show
- * @param data The notification data.
- */
+* Fired when one of the `showSuccess()`, `showInfo()`, `showWarning()` methods is called.
+*
+* @eventName ~Notification#show
+* @param data The notification data.
+*/
 export type NotificationShowEvent = {
-    name: 'show';
-    args: [data: NotificationShowEventData];
+	name: "show";
+	args: [data: NotificationShowEventData];
 };
 /**
- * Fired when the `showSuccess()` method is called.
- *
- * @eventName ~Notification#show:success
- * @param data The notification data.
- */
-export type NotificationShowSuccessEvent = NotificationShowTypeEvent<'success'>;
+* Fired when the `showSuccess()` method is called.
+*
+* @eventName ~Notification#show:success
+* @param data The notification data.
+*/
+export type NotificationShowSuccessEvent = NotificationShowTypeEvent<"success">;
 /**
- * Fired when the `showInfo()` method is called.
- *
- * @eventName ~Notification#show:info
- * @param data The notification data.
- */
-export type NotificationShowInfoEvent = NotificationShowTypeEvent<'info'>;
+* Fired when the `showInfo()` method is called.
+*
+* @eventName ~Notification#show:info
+* @param data The notification data.
+*/
+export type NotificationShowInfoEvent = NotificationShowTypeEvent<"info">;
 /**
- * Fired when the `showWarning()` method is called.
- *
- * When this event is not handled or stopped by `event.stop()`, the `data.message` of this event will
- * be automatically displayed as a system alert.
- *
- * @eventName ~Notification#show:warning
- * @param data The notification data.
- */
-export type NotificationShowWarningEvent = NotificationShowTypeEvent<'warning'>;
+* Fired when the `showWarning()` method is called.
+*
+* When this event is not handled or stopped by `event.stop()`, the `data.message` of this event will
+* be automatically displayed as a system alert.
+*
+* @eventName ~Notification#show:warning
+* @param data The notification data.
+*/
+export type NotificationShowWarningEvent = NotificationShowTypeEvent<"warning">;
 export type NotificationShowTypeEvent<NotificationType extends NotificationEventType> = {
-    name: `show:${NotificationType}` | `show:${NotificationType}:${string}`;
-    args: [data: NotificationShowEventData<NotificationType>];
+	name: `show:${NotificationType}` | `show:${NotificationType}:${string}`;
+	args: [data: NotificationShowEventData<NotificationType>];
 };
 export type NotificationShowEventData<NotificationType extends NotificationEventType = NotificationEventType> = {
-    /**
-     * The content of the notification.
-     */
-    message: string;
-    /**
-     * The title of the notification.
-     */
-    title: string;
-    /**
-     * The type of the notification.
-     */
-    type: NotificationType;
+	/**
+	* The content of the notification.
+	*/
+	message: string;
+	/**
+	* The title of the notification.
+	*/
+	title: string;
+	/**
+	* The type of the notification.
+	*/
+	type: NotificationType;
 };