@ckeditor/ckeditor5-ui 44.1.0 → 44.2.0-alpha.1

package/dist/badge/badge.d.ts

@@ -1,133 +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-licensing-options
- */
-/**
- * @module ui/badge/badge
- */
-import type { Editor } from '@ckeditor/ckeditor5-core';
-import type View from '../view.js';
-declare const Badge_base: {
-    new (): import("@ckeditor/ckeditor5-utils").DomEmitter;
-    prototype: import("@ckeditor/ckeditor5-utils").DomEmitter;
-};
-/**
- * A helper that enables the badge feature in the editor and renders a custom view next to the bottom of the editable element
- * (editor root, source editing area, etc.) when the editor is focused.
- *
- * @private
- */
-export default abstract class Badge extends /* #__PURE__ */ Badge_base {
-    /**
-     * Editor instance the helper was created for.
-     */
-    protected readonly editor: Editor;
-    /**
-     * A reference to the balloon panel hosting and positioning the badge content.
-     */
-    private _balloonView;
-    /**
-     * A throttled version of the {@link #_showBalloon} method meant for frequent use to avoid performance loss.
-     */
-    private _showBalloonThrottled;
-    /**
-     * A reference to the last editable element (root, source editing area, etc.) focused by the user.
-     * Since the focus can move to other focusable elements in the UI, this reference allows positioning the balloon over the
-     * right element whether the user is typing or using the UI.
-     */
-    private _lastFocusedEditableElement;
-    /**
-     * An additional CSS class added to the `BalloonView`.
-     */
-    private readonly _balloonClass;
-    /**
-     * Creates a badge for a given editor. The feature is initialized on Editor#ready
-     * event.
-     */
-    protected constructor(editor: Editor, options?: {
-        balloonClass?: string;
-    });
-    /**
-     * Destroys the badge along with its view.
-     */
-    destroy(): void;
-    /**
-     * Enables badge label once the editor (ui) is ready.
-     */
-    protected _handleEditorReady(): void;
-    /**
-     * Returns normalized configuration for the badge.
-     */
-    protected _getNormalizedConfig(): BadgeConfig;
-    /**
-     * Creates the badge content.
-     */
-    protected abstract _createBadgeContent(): View<HTMLElement>;
-    /**
-     * Enables the badge feature.
-     */
-    protected abstract _isEnabled(): boolean;
-    /**
-     * Attempts to display the balloon with the badge view.
-     */
-    private _showBalloon;
-    /**
-     * Hides the badge balloon if already visible.
-     */
-    private _hideBalloon;
-    /**
-     * Creates an instance of the {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView balloon panel}
-     * with the badge view inside ready for positioning.
-     */
-    private _createBalloonView;
-    /**
-     * Returns the options for attaching the balloon to the focused editable element.
-     */
-    private _getBalloonAttachOptions;
-    /**
-     * Updates the {@link #_lastFocusedEditableElement} based on the state of the global focus tracker.
-     */
-    private _updateLastFocusedEditableElement;
-}
-/**
- * The badge configuration options.
- **/
-export interface BadgeConfig {
-    /**
-     * The position of the badge.
-     *
-     * * When `'inside'`, the badge will be displayed within the boundaries of the editing area.
-     * * When `'border'`, the basge will be displayed over the bottom border of the editing area.
-     *
-     * @default 'border'
-     */
-    position: 'inside' | 'border';
-    /**
-     * Allows choosing the side of the editing area where the badge will be displayed.
-     *
-     * **Note:** If {@link module:core/editor/editorconfig~EditorConfig#language `config.language`} is set to an RTL (right-to-left)
-     * language, the side switches to `'left'` by default.
-     *
-     * @default 'right'
-     */
-    side: 'left' | 'right';
-    /**
-     * The vertical distance the badge can be moved away from its default position.
-     *
-     * **Note:** If `position` is `'border'`, the offset is measured from the (vertical) center of the badge.
-     *
-     * @default 5
-     */
-    verticalOffset: number;
-    /**
-     * The horizontal distance between the side of the editing root and the nearest side of the badge.
-     *
-     * @default 5
-     */
-    horizontalOffset: number;
-}
-export {};

package/dist/bindings/addkeyboardhandlingforgrid.d.ts

@@ -1,31 +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-licensing-options
- */
-/**
- * @module ui/bindings/addkeyboardhandlingforgrid
- */
-import type { FocusTracker, KeystrokeHandler } from '@ckeditor/ckeditor5-utils';
-import type ViewCollection from '../viewcollection.js';
-/**
- * A helper that adds a keyboard navigation support (arrow up/down/left/right) for grids.
- *
- * @param options Configuration options.
- * @param options.keystrokeHandler Keystroke handler to register navigation with arrow keys.
- * @param options.focusTracker A focus tracker for grid elements.
- * @param options.gridItems A collection of grid items.
- * @param options.numberOfColumns Number of columns in the grid. Can be specified as a function that returns
- * the number (e.g. for responsive grids).
- * @param options.uiLanguageDirection String of ui language direction.
- */
-export default function addKeyboardHandlingForGrid({ keystrokeHandler, focusTracker, gridItems, numberOfColumns, uiLanguageDirection }: {
-    keystrokeHandler: KeystrokeHandler;
-    focusTracker: FocusTracker;
-    gridItems: ViewCollection;
-    numberOfColumns: number | (() => number);
-    uiLanguageDirection?: string;
-}): void;

package/dist/bindings/clickoutsidehandler.d.ts

@@ -1,34 +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-licensing-options
- */
-/**
- * @module ui/bindings/clickoutsidehandler
- */
-import type { CallbackOptions, DomEmitter } from '@ckeditor/ckeditor5-utils';
-/**
- * Handles clicking **outside** of a specified set of elements, then fires an action.
- *
- * **Note**: Actually, the action is executed upon `mousedown`, not `click`. It prevents
- * certain issues when the user keeps holding the mouse button and the UI cannot react
- * properly.
- *
- * @param options Configuration options.
- * @param options.emitter The emitter to which this behavior should be added.
- * @param options.activator Function returning a `Boolean`, to determine whether the handler is active.
- * @param options.contextElements Array of HTML elements or a callback returning an array of HTML elements
- * that determine the scope of the handler. Clicking any of them or their descendants will **not** fire the callback.
- * @param options.callback An action executed by the handler.
- * @param options.listenerOptions Additional options for the listener (like priority).
- */
-export default function clickOutsideHandler({ emitter, activator, callback, contextElements, listenerOptions }: {
-    emitter: DomEmitter;
-    activator: () => boolean;
-    contextElements: Array<Element> | (() => Array<Element>);
-    callback: () => void;
-    listenerOptions?: CallbackOptions;
-}): void;

package/dist/bindings/csstransitiondisablermixin.d.ts

@@ -1,44 +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-licensing-options
- */
-/**
- * @module ui/bindings/csstransitiondisablermixin
- */
-import type { Constructor, Mixed } from '@ckeditor/ckeditor5-utils';
-import type View from '../view.js';
-/**
- * A mixin that brings the possibility to temporarily disable CSS transitions using
- * {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
- * when the view is first displayed but they should work normal in other cases.
- *
- * The methods to control the CSS transitions are:
- * * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
- * {@link module:ui/view~View#element view element}.
- * * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
- * {@link module:ui/view~View#element view element}.
- *
- * The usage comes down to:
- *
- * ```ts
- * const MyViewWithCssTransitionDisabler = CssTransitionDisablerMixin( MyView );
- * const view = new MyViewWithCssTransitionDisabler();
- *
- * // ...
- *
- * view.disableCssTransitions();
- * view.show();
- * view.enableCssTransitions();
- * ```
- *
- * @param view View instance that should get this functionality.
- */
-export default function CssTransitionDisablerMixin<Base extends Constructor<View>>(view: Base): Mixed<Base, ViewWithCssTransitionDisabler>;
-export type ViewWithCssTransitionDisabler = View & {
-    disableCssTransitions(): void;
-    enableCssTransitions(): void;
-};

package/dist/bindings/draggableviewmixin.d.ts

@@ -1,50 +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-licensing-options
- */
-/**
- * @module ui/bindings/draggableviewmixin
- */
-import type View from '../view.js';
-import { type Constructor, type Mixed } from '@ckeditor/ckeditor5-utils';
-/**
- * A mixin that brings the possibility to observe dragging of the view element.
- * The view has to implement the {@link ~DraggableView} interface to use it:
- *
- * ```js
- * export default class MyDraggableView extends DraggableViewMixin( View ) implements DraggableView {
- * 		// ...
- * }
- * ```
- *
- * Creating a class extending it attaches a set of mouse and touch listeners allowing to observe dragging of the view element:
- * * `mousedown` and `touchstart` on the view element - starting the dragging.
- * * `mousemove` and `touchmove` on the document - updating the view coordinates.
- * * `mouseup` and `touchend` on the document - stopping the dragging.
- *
- * The mixin itself does not provide a visual feedback (that is, the dragged element does not change its position) -
- * it is up to the developer to implement it.
- */
-export default function DraggableViewMixin<Base extends Constructor<View>>(view: Base): Mixed<Base, DraggableView>;
-/**
- * An interface that should be implemented by views that want to be draggable.
- */
-export interface DraggableView extends View {
-    get dragHandleElement(): HTMLElement | null;
-}
-/**
- * An event data object for the {@link ~DraggableView} `drag` event. Fired when the view is dragged.
- */
-export type DraggableViewDragEvent = {
-    name: 'drag';
-    args: [
-        {
-            deltaX: number;
-            deltaY: number;
-        }
-    ];
-};

package/dist/bindings/injectcsstransitiondisabler.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-licensing-options
- */
-/**
- * @module ui/bindings/injectcsstransitiondisabler
- */
-import type View from '../view.js';
-/**
- * A decorator that brings the possibility to temporarily disable CSS transitions using
- * {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
- * when the view is first displayed but they should work normal in other cases.
- *
- * The methods to control the CSS transitions are:
- * * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
- * {@link module:ui/view~View#element view element}.
- * * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
- * {@link module:ui/view~View#element view element}.
- *
- * **Note**: This helper extends the {@link module:ui/view~View#template template} and must be used **after**
- * {@link module:ui/view~View#setTemplate} is called:
- *
- * ```ts
- * import injectCssTransitionDisabler from '@ckeditor/ckeditor5-ui/src/bindings/injectcsstransitiondisabler';
- *
- * class MyView extends View {
- * 	constructor() {
- * 		super();
- *
- * 		// ...
- *
- * 		this.setTemplate( { ... } );
- *
- * 		// ...
- *
- * 		injectCssTransitionDisabler( this );
- *
- * 		// ...
- * 	}
- * }
- * ```
- *
- * The usage comes down to:
- *
- * ```ts
- * const view = new MyView();
- *
- * // ...
- *
- * view.disableCssTransitions();
- * view.show();
- * view.enableCssTransitions();
- * ```
- *
- * @deprecated
- * @see module:ui/bindings/csstransitiondisablermixin~CssTransitionDisablerMixin
- * @param view View instance that should get this functionality.
- */
-export default function injectCssTransitionDisabler(view: View): void;

package/dist/bindings/preventdefault.d.ts

@@ -1,37 +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-licensing-options
- */
-/**
- * @module ui/bindings/preventdefault
- */
-import type { ListenerBinding } from '../template.js';
-import type View from '../view.js';
-/**
- * A helper which executes a native `Event.preventDefault()` if the target of an event equals the
- * {@link module:ui/view~View#element element of the view}. It shortens the definition of a
- * {@link module:ui/view~View#template template}.
- *
- * ```ts
- * // In a class extending View.
- * import preventDefault from '@ckeditor/ckeditor5-ui/src/bindings/preventdefault';
- *
- * // ...
- *
- * this.setTemplate( {
- * 	tag: 'div',
- *
- * 	on: {
- * 		// Prevent the default mousedown action on this view.
- * 		mousedown: preventDefault( this )
- * 	}
- * } );
- * ```
- *
- * @param view View instance that defines the template.
- */
-export default function preventDefault(view: View): ListenerBinding;

package/dist/bindings/submithandler.d.ts

@@ -1,61 +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-licensing-options
- */
-/**
- * @module ui/bindings/submithandler
- */
-import type View from '../view.js';
-/**
- * A handler useful for {@link module:ui/view~View views} working as HTML forms. It intercepts a native DOM
- * `submit` event, prevents the default web browser behavior (navigation and page reload) and
- * fires the `submit` event on a view instead. Such a custom event can be then used by any
- * {@link module:utils/dom/emittermixin~DomEmitter emitter}, e.g. to serialize the form data.
- *
- * ```ts
- * import submitHandler from '@ckeditor/ckeditor5-ui/src/bindings/submithandler';
- *
- * // ...
- *
- * class AnyFormView extends View {
- * 	constructor() {
- * 		super();
- *
- * 		// ...
- *
- * 		submitHandler( {
- * 			view: this
- * 		} );
- * 	}
- * }
- *
- * // ...
- *
- * const view = new AnyFormView();
- *
- * // A sample listener attached by an emitter working with the view.
- * this.listenTo( view, 'submit', () => {
- * 	saveTheFormData();
- * 	hideTheForm();
- * } );
- * ```
- *
- * @param options Configuration options.
- * @param options.view The view which DOM `submit` events should be handled.
- */
-export default function submitHandler({ view }: {
-    view: View;
-}): void;
-/**
- * Fired by {@link module:ui/bindings/submithandler~submitHandler} helper.
- *
- * @eventName module:ui/view~View#submit
- */
-export type SubmitHandlerEvent = {
-    name: 'submit';
-    args: [];
-};

package/dist/button/button.d.ts

@@ -1,179 +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-licensing-options
- */
-/**
- * @module ui/button/button
- */
-/**
- * The button interface. Implemented by, among others, {@link module:ui/button/buttonview~ButtonView},
- * {@link module:ui/dropdown/button/splitbuttonview~SplitButtonView} and
- * {@link module:ui/dropdown/button/dropdownbuttonview~DropdownButtonView}.
- */
-export default interface Button {
-    /**
-     * The label of the button view visible to the user when {@link #withText} is `true`.
-     * It can also be used to create a {@link #tooltip}.
-     *
-     * @observable
-     */
-    label: string | undefined;
-    /**
-     * (Optional) The keystroke associated with the button, i.e. <kbd>CTRL+B</kbd>,
-     * in the string format compatible with {@link module:utils/keyboard}.
-     *
-     * **Note**: Use {@link module:ui/button/button~Button#withKeystroke} if you want to display
-     * the keystroke information next to the {@link module:ui/button/button~Button#label label}.
-     *
-     * @observable
-     */
-    keystroke: string | undefined;
-    /**
-     * (Optional) Tooltip of the button, i.e. displayed when hovering the button with the mouse cursor.
-     *
-     * * If defined as a `Boolean` (e.g. `true`), then combination of `label` and `keystroke` will be set as a tooltip.
-     * * If defined as a `String`, tooltip will equal the exact text of that `String`.
-     * * If defined as a `Function`, `label` and `keystroke` will be passed to that function, which is to return
-     * a string with the tooltip text.
-     *
-     * ```ts
-     * const view = new ButtonView( locale );
-     * view.tooltip = ( label, keystroke ) => `A tooltip for ${ label } and ${ keystroke }.`
-     * ```
-     *
-     * @observable
-     * @default false
-     */
-    tooltip: boolean | string | ((label: string, keystroke: string | undefined) => string);
-    /**
-     * (Optional) The position of the tooltip. See {@link module:ui/tooltipmanager~TooltipManager}
-     * to learn more about the tooltip system.
-     *
-     * **Note:** It makes sense only when the {@link #tooltip `tooltip` attribute} is defined.
-     *
-     * @observable
-     * @default 's'
-     */
-    tooltipPosition: 's' | 'n' | 'e' | 'w' | 'sw' | 'se';
-    /**
-     * The HTML type of the button.
-     *
-     * @observable
-     * @default 'button'
-     */
-    type: 'button' | 'submit' | 'reset' | 'menu';
-    /**
-     * Controls whether the button view is "on". It makes sense when a feature it represents
-     * is currently active, e.g. a bold button is "on" when the selection is in the bold text.
-     *
-     * To disable the button, use {@link #isEnabled} instead.
-     *
-     * @observable
-     * @default true
-     */
-    isOn: boolean;
-    /**
-     * Controls whether the button view is enabled, i.e. it can be clicked and execute an action.
-     *
-     * To change the "on" state of the button, use {@link #isOn} instead.
-     *
-     * @observable
-     * @default true
-     */
-    isEnabled: boolean;
-    /**
-     * Controls whether the button view is visible. Visible by default, buttons are hidden
-     * using a CSS class.
-     *
-     * @observable
-     * @default true
-     */
-    isVisible: boolean;
-    /**
-     * Controls whether the button view is a toggle button (two–state) for assistive technologies.
-     *
-     * @observable
-     * @default false
-     */
-    isToggleable: boolean;
-    /**
-     * (Optional) Controls whether the label of the button is hidden (e.g. an icon–only button).
-     *
-     * @observable
-     * @default false
-     */
-    withText: boolean;
-    /**
-     * (Optional) Controls whether the keystroke of the button is displayed next to its
-     * {@link module:ui/button/button~Button#label label}.
-     *
-     * **Note**: This property requires a {@link module:ui/button/button~Button#keystroke keystroke}
-     * to be defined in the first place.
-     *
-     * @observable
-     * @default false
-     */
-    withKeystroke: boolean;
-    /**
-     * (Optional) An XML {@link module:ui/icon/iconview~IconView#content content} of the icon.
-     * When defined, an `iconView` should be added to the button.
-     *
-     * The user must provide the entire XML string, not just the path. See the
-     * {@glink framework/architecture/ui-library#setting-label-icon-and-tooltip UI library} guide for details.
-     *
-     * @observable
-     */
-    icon: string | undefined;
-    /**
-     * (Optional) Controls the `tabindex` HTML attribute of the button. By default, the button is focusable
-     * but does not included in the <kbd>Tab</kbd> order.
-     *
-     * @observable
-     * @default -1
-     */
-    tabindex: number;
-    /**
-     * (Optional) The additional CSS class set on the button.
-     *
-     * @observable
-     */
-    class: string | undefined;
-    /**
-     * (Optional) The ARIA property reflected by the `aria-label` DOM attribute used by assistive technologies.
-     *
-     * @observable
-     */
-    ariaLabel?: string | undefined;
-    /**
-     * (Optional) The ARIA property reflected by the `aria-ariaLabelledBy` DOM attribute used by assistive technologies.
-     *
-     * @observable
-     */
-    ariaLabelledBy?: string | undefined;
-    /**
-     * (Optional) The property reflected by the `role` DOM attribute to be used by assistive technologies.
-     *
-     * @observable
-     */
-    role?: string | undefined;
-    /**
-     * (Optional) The value of the `style` attribute of the label.
-     *
-     * @observable
-     */
-    labelStyle: string | undefined;
-}
-/**
- * Fired when the button view is clicked. It won't be fired when the button {@link module:ui/button/button~Button#isEnabled}
- * is `false`.
- *
- * @eventName ~Button#execute
- */
-export type ButtonExecuteEvent = {
-    name: 'execute';
-    args: [];
-};

package/dist/button/buttonlabel.d.ts

@@ -1,38 +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-licensing-options
- */
-/**
- * @module ui/button/buttonlabel
-*/
-import type View from '../view.js';
-/**
- * The button label interface. Implemented by the {@link module:ui/button/buttonlabelview~ButtonLabelView}
- * and any label view that can be used with the {@link module:ui/button/buttonview~ButtonView}.
- */
-export default interface ButtonLabel extends View {
-    /**
-     * The `id` attribute of the button label. It is used for accessibility purposes
-     * to describe the button.
-     *
-     * @observable
-     */
-    id: string | undefined;
-    /**
-     * The `style` attribute of the button label. It allows customizing the presentation
-     * of the label.
-     *
-     * @observable
-     */
-    style: string | undefined;
-    /**
-     * The human-readable text of the label.
-     *
-     * @observable
-     */
-    text: string | undefined;
-}