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

package/dist/button/buttonview.d.ts

@@ -1,197 +1,197 @@
 /**
- * @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/button/buttonview
- */
-import { View } from '../view.js';
-import { IconView } from '../icon/iconview.js';
-import { type ViewCollection } from '../viewcollection.js';
-import type { Button } from './button.js';
-import { type ButtonLabel } from './buttonlabel.js';
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import '../../theme/components/button/button.css';
+* @module ui/button/buttonview
+*/
+import { View } from "../view.js";
+import { IconView } from "../icon/iconview.js";
+import { type ViewCollection } from "../viewcollection.js";
+import type { Button } from "./button.js";
+import { type ButtonLabel } from "./buttonlabel.js";
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import "../../theme/components/button/button.css";
 /**
- * The button view class.
- *
- * ```ts
- * const view = new ButtonView();
- *
- * view.set( {
- * 	label: 'A button',
- * 	keystroke: 'Ctrl+B',
- * 	tooltip: true,
- * 	withText: true
- * } );
- *
- * view.render();
- *
- * document.body.append( view.element );
- * ```
- */
+* The button view class.
+*
+* ```ts
+* const view = new ButtonView();
+*
+* view.set( {
+* 	label: 'A button',
+* 	keystroke: 'Ctrl+B',
+* 	tooltip: true,
+* 	withText: true
+* } );
+*
+* view.render();
+*
+* document.body.append( view.element );
+* ```
+*/
 export declare class ButtonView extends View<HTMLButtonElement> implements Button {
-    /**
-     * Collection of the child views inside of the button {@link #element}.
-     */
-    readonly children: ViewCollection;
-    /**
-     * Label of the button view. Its text is configurable using the {@link #label label attribute}.
-     *
-     * If not configured otherwise in the `constructor()`, by default the label is an instance
-     * of {@link module:ui/button/buttonlabelview~ButtonLabelView}.
-     */
-    readonly labelView: ButtonLabel;
-    /**
-     * The icon view of the button. Will be added to {@link #children} when the
-     * {@link #icon icon attribute} is defined.
-     */
-    readonly iconView: IconView;
-    /**
-     * A view displaying the keystroke of the button next to the {@link #labelView label}.
-     * Added to {@link #children} when the {@link #withKeystroke `withKeystroke` attribute}
-     * is defined.
-     */
-    readonly keystrokeView: View;
-    /**
-     * @inheritDoc
-     */
-    class: string | undefined;
-    /**
-     * @inheritDoc
-     */
-    labelStyle: string | undefined;
-    /**
-     * @inheritDoc
-     */
-    icon: string | undefined;
-    /**
-     * @inheritDoc
-     */
-    isEnabled: boolean;
-    /**
-     * @inheritDoc
-     */
-    isOn: boolean;
-    /**
-     * @inheritDoc
-     */
-    isVisible: boolean;
-    /**
-     * @inheritDoc
-     */
-    isToggleable: boolean;
-    /**
-     * @inheritDoc
-     */
-    keystroke: string | undefined;
-    /**
-     * @inheritDoc
-     */
-    label: string | undefined;
-    /**
-     * @inheritDoc
-     */
-    tabindex: number;
-    /**
-     * @inheritDoc
-     */
-    tooltip: Button['tooltip'];
-    /**
-     * @inheritDoc
-     */
-    tooltipPosition: Button['tooltipPosition'];
-    /**
-     * @inheritDoc
-     */
-    type: Button['type'];
-    /**
-     * @inheritDoc
-     */
-    withText: boolean;
-    /**
-     * @inheritDoc
-     */
-    withKeystroke: boolean;
-    /**
-     * @inheritDoc
-     */
-    role: string | undefined;
-    /**
-     * @inheritDoc
-     */
-    ariaLabel?: string | undefined;
-    /**
-     * @inheritDoc
-     */
-    ariaLabelledBy: string | undefined;
-    /**
-     * Aria-pressed attribute of element. It is calculated based on {@link #isToggleable isToggleable} and {@link #role}.
-     * It's set to true if the button is on and the role is not checkable.
-     *
-     * @readonly
-     * @internal
-     */
-    _ariaPressed: string | false;
-    /**
-     * Aria-checked attribute of element. It is calculated based on {@link #isToggleable isToggleable} and {@link #role}.
-     * It's set to true if the button is on and the role is checkable.
-     *
-     * @readonly
-     * @internal
-     */
-    _ariaChecked: string | false;
-    /**
-     * Tooltip of the button bound to the template.
-     *
-     * @see #tooltip
-     * @see module:ui/button/buttonview~ButtonView#_getTooltipString
-     * @internal
-     * @observable
-     */
-    _tooltipString: string;
-    /**
-     * Delayed focus function for focus handling in Safari.
-     */
-    private _focusDelayed;
-    /**
-     * Creates an instance of the button view class.
-     *
-     * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
-     * @param labelView The instance of the button's label. If not provided, an instance of
-     * {@link module:ui/button/buttonlabelview~ButtonLabelView} is used.
-     */
-    constructor(locale?: Locale, labelView?: ButtonLabel);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Focuses the {@link #element} of the button.
-     */
-    focus(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Binds the label view instance it with button attributes.
-     */
-    private _setupLabelView;
-    /**
-     * Creates a view that displays a keystroke next to a {@link #labelView label }
-     * and binds it with button attributes.
-     */
-    private _createKeystrokeView;
-    /**
-     * Gets the text for the tooltip from the combination of
-     * {@link #tooltip}, {@link #label} and {@link #keystroke} attributes.
-     *
-     * @see #tooltip
-     * @see #_tooltipString
-     * @param tooltip Button tooltip.
-     * @param label Button label.
-     * @param keystroke Button keystroke.
-     */
-    private _getTooltipString;
+	/**
+	* Collection of the child views inside of the button {@link #element}.
+	*/
+	readonly children: ViewCollection;
+	/**
+	* Label of the button view. Its text is configurable using the {@link #label label attribute}.
+	*
+	* If not configured otherwise in the `constructor()`, by default the label is an instance
+	* of {@link module:ui/button/buttonlabelview~ButtonLabelView}.
+	*/
+	readonly labelView: ButtonLabel;
+	/**
+	* The icon view of the button. Will be added to {@link #children} when the
+	* {@link #icon icon attribute} is defined.
+	*/
+	readonly iconView: IconView;
+	/**
+	* A view displaying the keystroke of the button next to the {@link #labelView label}.
+	* Added to {@link #children} when the {@link #withKeystroke `withKeystroke` attribute}
+	* is defined.
+	*/
+	readonly keystrokeView: View;
+	/**
+	* @inheritDoc
+	*/
+	class: string | undefined;
+	/**
+	* @inheritDoc
+	*/
+	labelStyle: string | undefined;
+	/**
+	* @inheritDoc
+	*/
+	icon: string | undefined;
+	/**
+	* @inheritDoc
+	*/
+	isEnabled: boolean;
+	/**
+	* @inheritDoc
+	*/
+	isOn: boolean;
+	/**
+	* @inheritDoc
+	*/
+	isVisible: boolean;
+	/**
+	* @inheritDoc
+	*/
+	isToggleable: boolean;
+	/**
+	* @inheritDoc
+	*/
+	keystroke: string | undefined;
+	/**
+	* @inheritDoc
+	*/
+	label: string | undefined;
+	/**
+	* @inheritDoc
+	*/
+	tabindex: number;
+	/**
+	* @inheritDoc
+	*/
+	tooltip: Button["tooltip"];
+	/**
+	* @inheritDoc
+	*/
+	tooltipPosition: Button["tooltipPosition"];
+	/**
+	* @inheritDoc
+	*/
+	type: Button["type"];
+	/**
+	* @inheritDoc
+	*/
+	withText: boolean;
+	/**
+	* @inheritDoc
+	*/
+	withKeystroke: boolean;
+	/**
+	* @inheritDoc
+	*/
+	role: string | undefined;
+	/**
+	* @inheritDoc
+	*/
+	ariaLabel?: string | undefined;
+	/**
+	* @inheritDoc
+	*/
+	ariaLabelledBy: string | undefined;
+	/**
+	* Aria-pressed attribute of element. It is calculated based on {@link #isToggleable isToggleable} and {@link #role}.
+	* It's set to true if the button is on and the role is not checkable.
+	*
+	* @readonly
+	* @internal
+	*/
+	_ariaPressed: string | false;
+	/**
+	* Aria-checked attribute of element. It is calculated based on {@link #isToggleable isToggleable} and {@link #role}.
+	* It's set to true if the button is on and the role is checkable.
+	*
+	* @readonly
+	* @internal
+	*/
+	_ariaChecked: string | false;
+	/**
+	* Tooltip of the button bound to the template.
+	*
+	* @see #tooltip
+	* @see module:ui/button/buttonview~ButtonView#_getTooltipString
+	* @internal
+	* @observable
+	*/
+	_tooltipString: string;
+	/**
+	* Delayed focus function for focus handling in Safari.
+	*/
+	private _focusDelayed;
+	/**
+	* Creates an instance of the button view class.
+	*
+	* @param locale The {@link module:core/editor/editor~Editor#locale} instance.
+	* @param labelView The instance of the button's label. If not provided, an instance of
+	* {@link module:ui/button/buttonlabelview~ButtonLabelView} is used.
+	*/
+	constructor(locale?: Locale, labelView?: ButtonLabel);
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* Focuses the {@link #element} of the button.
+	*/
+	focus(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* Binds the label view instance it with button attributes.
+	*/
+	private _setupLabelView;
+	/**
+	* Creates a view that displays a keystroke next to a {@link #labelView label }
+	* and binds it with button attributes.
+	*/
+	private _createKeystrokeView;
+	/**
+	* Gets the text for the tooltip from the combination of
+	* {@link #tooltip}, {@link #label} and {@link #keystroke} attributes.
+	*
+	* @see #tooltip
+	* @see #_tooltipString
+	* @param tooltip Button tooltip.
+	* @param label Button label.
+	* @param keystroke Button keystroke.
+	*/
+	private _getTooltipString;
 }

package/dist/button/filedialogbuttonview.d.ts

@@ -1,112 +1,120 @@
 /**
- * @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/button/filedialogbuttonview
- */
-import { View } from '../view.js';
-import { ButtonView } from './buttonview.js';
-import type { Constructor, Mixed } from '@ckeditor/ckeditor5-utils';
-import { ListItemButtonView } from './listitembuttonview.js';
-declare const FileDialogButtonView_base: Mixed<typeof ButtonView, FileDialogButtonViewBase>;
+* @module ui/button/filedialogbuttonview
+*/
+import { View } from "../view.js";
+import { ButtonView } from "./buttonview.js";
+import type { Constructor, Mixed } from "@ckeditor/ckeditor5-utils";
+import { ListItemButtonView } from "./listitembuttonview.js";
 /**
- * The file dialog button view.
- *
- * This component provides a button that opens the native file selection dialog.
- * It can be used to implement the UI of a file upload feature.
- *
- * ```ts
- * const view = new FileDialogButtonView( locale );
- *
- * view.set( {
- * 	acceptedType: 'image/*',
- * 	allowMultipleFiles: true
- * 	label: t( 'Insert image' ),
- * 	icon: imageIcon,
- * 	tooltip: true
- * } );
- *
- * view.on( 'done', ( evt, files ) => {
- * 	for ( const file of Array.from( files ) ) {
- * 		console.log( 'Selected file', file );
- * 	}
- * } );
- * ```
- */
-export declare class FileDialogButtonView extends /* #__PURE__ */ FileDialogButtonView_base {
-}
-declare const FileDialogListItemButtonView_base: Mixed<typeof ListItemButtonView, FileDialogButtonViewBase>;
+* Constructor returned by {@link ~FileDialogViewMixin}. Use it to name a mixin base class before extending it.
+*
+* ```ts
+* const MyFileDialogViewBase: FileDialogViewMixinConstructor<typeof BaseClass> = FileDialogViewMixin( BaseClass );
+*
+* class MyFileDialogView extends MyFileDialogViewBase {}
+* ```
+*/
+export type FileDialogViewMixinConstructor<Base extends Constructor<ButtonView>> = Mixed<Base, FileDialogButtonViewBase>;
+declare const FileDialogButtonViewMixinBase: FileDialogViewMixinConstructor<typeof ButtonView>;
+declare const FileDialogListItemButtonViewMixinBase: FileDialogViewMixinConstructor<typeof ListItemButtonView>;
+/**
+* The file dialog button view.
+*
+* This component provides a button that opens the native file selection dialog.
+* It can be used to implement the UI of a file upload feature.
+*
+* ```ts
+* const view = new FileDialogButtonView( locale );
+*
+* view.set( {
+* 	acceptedType: 'image/*',
+* 	allowMultipleFiles: true
+* 	label: t( 'Insert image' ),
+* 	icon: imageIcon,
+* 	tooltip: true
+* } );
+*
+* view.on( 'done', ( evt, files ) => {
+* 	for ( const file of Array.from( files ) ) {
+* 		console.log( 'Selected file', file );
+* 	}
+* } );
+* ```
+*/
+export declare class FileDialogButtonView extends FileDialogButtonViewMixinBase {}
 /**
- * The file dialog button view used in a lists.
- *
- * This component provides a button that opens the native file selection dialog.
- * It can be used to implement the UI of a file upload feature.
- *
+* The file dialog button view used in a lists.
+*
+* This component provides a button that opens the native file selection dialog.
+* It can be used to implement the UI of a file upload feature.
+*
 * ```ts
- * const view = new FileDialogListItemButtonView( locale );
- *
- * view.set( {
- * 	acceptedType: 'image/*',
- * 	allowMultipleFiles: true
- * 	label: t( 'Insert image' ),
- * 	icon: imageIcon,
- * 	tooltip: true
- * } );
- *
- * view.on( 'done', ( evt, files ) => {
- * 	for ( const file of Array.from( files ) ) {
- * 		console.log( 'Selected file', file );
- * 	}
- * } );
- * ```
- */
-export declare class FileDialogListItemButtonView extends /* #__PURE__ */ FileDialogListItemButtonView_base {
-}
+* const view = new FileDialogListItemButtonView( locale );
+*
+* view.set( {
+* 	acceptedType: 'image/*',
+* 	allowMultipleFiles: true
+* 	label: t( 'Insert image' ),
+* 	icon: imageIcon,
+* 	tooltip: true
+* } );
+*
+* view.on( 'done', ( evt, files ) => {
+* 	for ( const file of Array.from( files ) ) {
+* 		console.log( 'Selected file', file );
+* 	}
+* } );
+* ```
+*/
+export declare class FileDialogListItemButtonView extends FileDialogListItemButtonViewMixinBase {}
 /**
- * Mixin function that enhances a base button view class with file dialog functionality. It is used
- * to create a button view class that opens the native select file dialog when clicked.
- *
- * The enhanced view includes a button and a hidden file input. When the button is clicked, the file dialog is opened.
- * The mixin adds properties and methods to the base class to handle the file selection.
- *
- * @param view The base class to be enhanced with file dialog functionality.
- * @returns A new class that extends the base class and includes the file dialog functionality.
- */
-export declare function FileDialogViewMixin<Base extends Constructor<ButtonView>>(view: Base): Mixed<Base, FileDialogButtonViewBase>;
+* Mixin function that enhances a base button view class with file dialog functionality. It is used
+* to create a button view class that opens the native select file dialog when clicked.
+*
+* The enhanced view includes a button and a hidden file input. When the button is clicked, the file dialog is opened.
+* The mixin adds properties and methods to the base class to handle the file selection.
+*
+* @param view The base class to be enhanced with file dialog functionality.
+* @returns A new class that extends the base class and includes the file dialog functionality.
+*/
+export declare function FileDialogViewMixin<Base extends Constructor<ButtonView>>(view: Base): FileDialogViewMixinConstructor<Base>;
 /**
- * Represents the base view for a file dialog button component.
- */
+* Represents the base view for a file dialog button component.
+*/
 export type FileDialogButtonViewBase = View & {
-    /**
-     * Accepted file types. Can be provided in form of file extensions, media type or one of:
-     * * `audio/*`,
-     * * `video/*`,
-     * * `image/*`.
-     *
-     * @observable
-     */
-    acceptedType: string;
-    /**
-     * Indicates if multiple files can be selected. Defaults to `true`.
-     *
-     * @observable
-     */
-    allowMultipleFiles: boolean;
+	/**
+	* Accepted file types. Can be provided in form of file extensions, media type or one of:
+	* * `audio/*`,
+	* * `video/*`,
+	* * `image/*`.
+	*
+	* @observable
+	*/
+	acceptedType: string;
+	/**
+	* Indicates if multiple files can be selected. Defaults to `true`.
+	*
+	* @observable
+	*/
+	allowMultipleFiles: boolean;
 };
 /**
- * Fired when file dialog is closed with file selected.
- *
- * ```ts
- * view.on( 'done', ( evt, files ) => {
- * 	for ( const file of files ) {
- * 		console.log( 'Selected file', file );
- * 	}
- * }
- * ```
- */
+* Fired when file dialog is closed with file selected.
+*
+* ```ts
+* view.on( 'done', ( evt, files ) => {
+* 	for ( const file of files ) {
+* 		console.log( 'Selected file', file );
+* 	}
+* }
+* ```
+*/
 export type FileInputViewDoneEvent = {
-    name: 'done';
-    args: [files: FileList];
+	name: "done";
+	args: [files: FileList];
 };
 export {};