@ckeditor/ckeditor5-ui 36.0.0 → 37.0.0-alpha.0

package/src/notification/notification.js

@@ -16,8 +16,6 @@ import { ContextPlugin } from '@ckeditor/ckeditor5-core';
  *
  * Note that every unhandled and not stopped `warning` notification will be displayed as a system alert.
  * See {@link module:ui/notification/notification~Notification#showWarning}.
- *
- * @extends module:core/contextplugin~ContextPlugin
  */
 export default class Notification extends ContextPlugin {
     /**
@@ -41,22 +39,26 @@ export default class Notification extends ContextPlugin {
      * 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:
      *
-     * 		showSuccess( 'Image is uploaded.', {
-     * 			namespace: 'upload:image'
-     * 		} );
+     * ```ts
+     * showSuccess( 'Image is uploaded.', {
+     * 	namespace: 'upload:image'
+     * } );
+     * ```
      *
      * will fire the `show:success:upload:image` event.
      *
      * You can provide the title of the notification:
      *
-     *		showSuccess( 'Image is uploaded.', {
-     *			title: 'Image upload success'
-     *		} );
+     * ```ts
+     * showSuccess( 'Image is uploaded.', {
+     * 	title: 'Image upload success'
+     * } );
+     * ```
      *
-     * @param {String} message The content of the notification.
-     * @param {Object} [data={}] Additional data.
-     * @param {String} [data.namespace] Additional event namespace.
-     * @param {String} [data.title] The title of the notification.
+     * @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, data = {}) {
         this._showNotification({
@@ -72,22 +74,26 @@ export default class Notification extends ContextPlugin {
      * 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:
      *
-     * 		showInfo( 'Editor is offline.', {
-     * 			namespace: 'editor:status'
-     * 		} );
+     * ```ts
+     * showInfo( 'Editor is offline.', {
+     * 	namespace: 'editor:status'
+     * } );
+     * ```
      *
      * will fire the `show:info:editor:status` event.
      *
      * You can provide the title of the notification:
      *
-     *		showInfo( 'Editor is offline.', {
-     *			title: 'Network information'
-     *		} );
+     * ```ts
+     * showInfo( 'Editor is offline.', {
+     * 	title: 'Network information'
+     * } );
+     * ```
      *
-     * @param {String} message The content of the notification.
-     * @param {Object} [data={}] Additional data.
-     * @param {String} [data.namespace] Additional event namespace.
-     * @param {String} [data.title] The title of the notification.
+     * @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, data = {}) {
         this._showNotification({
@@ -103,45 +109,53 @@ export default class Notification extends ContextPlugin {
      * 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:
      *
-     * 		showWarning( 'Image upload error.', {
-     * 			namespace: 'upload:image'
-     * 		} );
+     * ```ts
+     * showWarning( 'Image upload error.', {
+     * 	namespace: 'upload:image'
+     * } );
+     * ```
      *
      * will fire the `show:warning:upload:image` event.
      *
      * You can provide the title of the notification:
      *
-     *		showWarning( 'Image upload error.', {
-     *			title: 'Upload failed'
-     *		} );
+     * ```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:
      *
-     * 		notifications.on( 'show:warning', ( evt, data ) => {
-     * 			// Do something with the data.
+     * ```ts
+     * notifications.on( 'show:warning', ( evt, data ) => {
+     * 	// Do something with the data.
      *
-     * 			// Stop this event to prevent displaying it as an alert.
-     * 			evt.stop();
-     * 		} );
+     * 	// 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:
      *
-     * 		notifications.on( 'show:warning', ( evt, data ) => {
-     * 			// Show the warning in the UI, but do not stop it.
-     * 		} );
+     * ```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.
+     * 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' } );
+     * 	// Stop this event to prevent displaying it as an alert.
+     * 	evt.stop();
+     * }, { priority: 'low' } );
+     * ```
      *
-     * @param {String} message The content of the notification.
-     * @param {Object} [data={}] Additional data.
-     * @param {String} [data.namespace] Additional event namespace.
-     * @param {String} [data.title] The title of the notification.
+     * @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, data = {}) {
         this._showNotification({
@@ -154,12 +168,11 @@ export default class Notification extends ContextPlugin {
     /**
      * Fires the `show` event with the specified type, namespace and message.
      *
-     * @private
-     * @param {Object} data The message data.
-     * @param {String} data.message The content of the notification.
-     * @param {'success'|'info'|'warning'} data.type The type of the message.
-     * @param {String} [data.namespace] Additional event namespace.
-     * @param {String} [data.title=''] The title of the notification.
+     * @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.
      */
     _showNotification(data) {
         const event = data.namespace ?