@ckeditor/ckeditor5-ui 41.3.0-alpha.3 → 41.3.0

package/dist/types/labeledinput/labeledinputview.d.ts

@@ -1,129 +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-oss-license
- */
-/**
- * @module ui/labeledinput/labeledinputview
- */
-import View from '../view.js';
-import LabelView from '../label/labelview.js';
-import type { default as InputView } from '../input/inputview.js';
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import '../../theme/components/labeledinput/labeledinput.css';
-/**
- * The labeled input view class.
- */
-export default class LabeledInputView extends View {
-    /**
-     * The label view.
-     */
-    readonly labelView: LabelView;
-    /**
-     * The input view.
-     */
-    readonly inputView: InputView;
-    /**
-     * The status view for the {@link #inputView}. It displays {@link #errorText} and
-     * {@link #infoText}.
-     */
-    readonly statusView: View;
-    /**
-     * The text of the label.
-     *
-     * @observable
-     */
-    label: string | undefined;
-    /**
-     * The value of the input.
-     *
-     * @observable
-     */
-    value: string | undefined;
-    /**
-     * Controls whether the component is in read-only mode.
-     *
-     * @observable
-     */
-    isReadOnly: boolean;
-    /**
-     * The validation error text. When set, it will be displayed
-     * next to the {@link #inputView} as a typical validation error message.
-     * Set it to `null` to hide the message.
-     *
-     * **Note:** Setting this property to anything but `null` will automatically
-     * make the {@link module:ui/inputtext/inputtextview~InputTextView#hasError `hasError`}
-     * of the {@link #inputView} `true`.
-     *
-     * **Note:** Typing in the {@link #inputView} which fires the
-     * {@link module:ui/inputtext/inputtextview~InputTextView#event:input `input` event}
-     * resets this property back to `null`, indicating that the input field can be re–validated.
-     *
-     * @observable
-     */
-    errorText: string | null;
-    /**
-     * The additional information text displayed next to the {@link #inputView} which can
-     * be used to inform the user about the purpose of the input, provide help or hints.
-     *
-     * Set it to `null` to hide the message.
-     *
-     * **Note:** This text will be displayed in the same place as {@link #errorText} but the
-     * latter always takes precedence: if the {@link #errorText} is set, it replaces
-     * {@link #errorText} for as long as the value of the input is invalid.
-     *
-     * @observable
-     */
-    infoText: string | null;
-    /**
-     * The combined status text made of {@link #errorText} and {@link #infoText}.
-     * Note that when present, {@link #errorText} always takes precedence in the
-     * status.
-     *
-     * @see #errorText
-     * @see #infoText
-     * @see #statusView
-     * @private
-     * @observable
-     */
-    _statusText: string | null;
-    /**
-     * Creates an instance of the labeled input view class.
-     *
-     * @param locale The locale instance.
-     * @param InputView Constructor of the input view.
-     */
-    constructor(locale: Locale | undefined, InputView: new (locale: Locale | undefined, statusUid: string) => InputView);
-    /**
-     * Creates label view class instance and bind with view.
-     *
-     * @param id Unique id to set as labelView#for attribute.
-     */
-    private _createLabelView;
-    /**
-     * Creates input view class instance and bind with view.
-     *
-     * @param InputView Input view constructor.
-     * @param inputUid Unique id to set as inputView#id attribute.
-     * @param statusUid Unique id of the status for the input's `aria-describedby` attribute.
-     */
-    private _createInputView;
-    /**
-     * Creates the status view instance. It displays {@link #errorText} and {@link #infoText}
-     * next to the {@link #inputView}. See {@link #_statusText}.
-     *
-     * @param statusUid Unique id of the status, shared with the input's `aria-describedby` attribute.
-     */
-    private _createStatusView;
-    /**
-     * Moves the focus to the input and selects the value.
-     */
-    select(): void;
-    /**
-     * Focuses the input.
-     */
-    focus(): void;
-}

package/dist/types/list/listitemgroupview.d.ts

@@ -1,63 +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-oss-license
- */
-/**
- * @module ui/list/listitemgroupview
- */
-import View from '../view.js';
-import type ViewCollection from '../viewcollection.js';
-import ListView from './listview.js';
-import LabelView from '../label/labelview.js';
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-/**
- * The list item group view class.
- */
-export default class ListItemGroupView extends View {
-    /**
-     * The visible label of the group.
-     *
-     * @observable
-     * @default ''
-     */
-    label: string;
-    /**
-     * Label of the group view. Its text is configurable using the {@link #label label attribute}.
-     *
-     * If a custom label view is not passed in `ListItemGroupView` constructor, the label is an instance
-     * of {@link module:ui/label/labelview~LabelView}.
-     */
-    readonly labelView: LabelView;
-    /**
-     * Collection of the child list items inside this group.
-     */
-    readonly items: ListView['items'];
-    /**
-     * Collection of the child elements of the group.
-     */
-    readonly children: ViewCollection;
-    /**
-     * Controls whether the item view is visible. Visible by default, list items are hidden
-     * using a CSS class.
-     *
-     * @observable
-     * @default true
-     */
-    isVisible: boolean;
-    /**
-     * Creates an instance of the list item group view class.
-     *
-     * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
-     * @param labelView The instance of the group's label. If not provided, an instance of
-     * {@link module:ui/label/labelview~LabelView} is used.
-     */
-    constructor(locale?: Locale, labelView?: LabelView);
-    /**
-     * Focuses the list item (which is not a separator).
-     */
-    focus(): void;
-}

package/dist/types/list/listitemview.d.ts

@@ -1,40 +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-oss-license
- */
-/**
- * @module ui/list/listitemview
- */
-import View from '../view.js';
-import type { FocusableView } from '../focuscycler.js';
-import type ViewCollection from '../viewcollection.js';
-import type { Locale } from '@ckeditor/ckeditor5-utils';
-/**
- * The list item view class.
- */
-export default class ListItemView extends View {
-    /**
-     * Collection of the child views inside of the list item {@link #element}.
-     */
-    readonly children: ViewCollection<FocusableView>;
-    /**
-     * Controls whether the item view is visible. Visible by default, list items are hidden
-     * using a CSS class.
-     *
-     * @observable
-     * @default true
-     */
-    isVisible: boolean;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale?: Locale);
-    /**
-     * Focuses the list item.
-     */
-    focus(): void;
-}

package/dist/types/list/listseparatorview.d.ts

@@ -1,22 +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-oss-license
- */
-/**
- * @module ui/list/listseparatorview
- */
-import View from '../view.js';
-import type { Locale } from '@ckeditor/ckeditor5-utils';
-/**
- * The list separator view class.
- */
-export default class ListSeparatorView extends View {
-    /**
-     * @inheritDoc
-     */
-    constructor(locale?: Locale);
-}

package/dist/types/list/listview.d.ts

@@ -1,128 +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-oss-license
- */
-/**
- * @module ui/list/listview
- */
-import View from '../view.js';
-import { type FocusableView } from '../focuscycler.js';
-import ListItemView from './listitemview.js';
-import ListItemGroupView from './listitemgroupview.js';
-import type ListSeparatorView from './listseparatorview.js';
-import type DropdownPanelFocusable from '../dropdown/dropdownpanelfocusable.js';
-import ViewCollection from '../viewcollection.js';
-import { FocusTracker, KeystrokeHandler, type Locale } from '@ckeditor/ckeditor5-utils';
-import '../../theme/components/list/list.css';
-/**
- * The list view class.
- */
-export default class ListView extends View<HTMLUListElement> implements DropdownPanelFocusable {
-    /**
-     * The collection of focusable views in the list. It is used to determine accessible navigation
-     * between the {@link module:ui/list/listitemview~ListItemView list items} and
-     * {@link module:ui/list/listitemgroupview~ListItemGroupView list groups}.
-     */
-    readonly focusables: ViewCollection<FocusableView>;
-    /**
-     * Collection of the child list views.
-     */
-    readonly items: ViewCollection<ListItemView | ListItemGroupView | ListSeparatorView>;
-    /**
-     * Tracks information about DOM focus in the list.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Label used by assistive technologies to describe this list element.
-     *
-     * @observable
-     */
-    ariaLabel: string | undefined;
-    /**
-     * (Optional) The ARIA property reflected by the `aria-ariaLabelledBy` DOM attribute used by assistive technologies.
-     *
-     * @observable
-     */
-    ariaLabelledBy?: string | undefined;
-    /**
-     * The property reflected by the `role` DOM attribute to be used by assistive technologies.
-     *
-     * @observable
-     */
-    role: string | undefined;
-    /**
-     * Helps cycling over focusable {@link #items} in the list.
-     */
-    private readonly _focusCycler;
-    /**
-     * A cached map of {@link module:ui/list/listitemgroupview~ListItemGroupView} to `change` event listeners for their `items`.
-     * Used for accessibility and keyboard navigation purposes.
-     */
-    private readonly _listItemGroupToChangeListeners;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale?: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Focuses the first focusable in {@link #items}.
-     */
-    focus(): void;
-    /**
-     * Focuses the first focusable in {@link #items}.
-     */
-    focusFirst(): void;
-    /**
-     * Focuses the last focusable in {@link #items}.
-     */
-    focusLast(): void;
-    /**
-     * Registers a list item view in the focus tracker.
-     *
-     * @param item The list item view to be registered.
-     * @param index Index of the list item view in the {@link #items} collection. If not specified, the item will be added at the end.
-     */
-    private _registerFocusableListItem;
-    /**
-     * Removes a list item view from the focus tracker.
-     *
-     * @param item The list item view to be removed.
-     */
-    private _deregisterFocusableListItem;
-    /**
-     * Gets a callback that will be called when the `items` collection of a {@link module:ui/list/listitemgroupview~ListItemGroupView}
-     * change.
-     *
-     * @param groupView The group view for which the callback will be created.
-     * @returns The callback function to be used for the items `change` event listener in a group.
-     */
-    private _getOnGroupItemsChangeCallback;
-    /**
-     * Registers a list item group view (and its children) in the focus tracker.
-     *
-     * @param groupView A group view to be registered.
-     * @param groupIndex Index of the group view in the {@link #items} collection. If not specified, the group will be added at the end.
-     */
-    private _registerFocusableItemsGroup;
-    /**
-     * Removes a list item group view (and its children) from the focus tracker.
-     *
-     * @param groupView The group view to be removed.
-     */
-    private _deregisterFocusableItemsGroup;
-}

package/dist/types/model.d.ts

@@ -1,26 +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-oss-license
- */
-declare const Model_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Observable;
-    prototype: import("@ckeditor/ckeditor5-utils").Observable;
-};
-/**
- * The base MVC model class.
- */
-export default class Model extends Model_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>);
-}
-export {};

package/dist/types/notification/notification.d.ts

@@ -1,215 +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-oss-license
- */
-/**
- * @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}.
- */
-export default class Notification extends ContextPlugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Notification";
-    /**
-     * @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';
-/**
- * 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];
-};
-/**
- * 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 `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>];
-};
-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;
-};