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

package/dist/dropdown/menu/dropdownmenurootlistview.d.ts

@@ -1,140 +1,140 @@
 /**
- * @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/dropdown/menu/dropdownmenurootlistview
- */
-import { DropdownMenuListItemButtonView } from './dropdownmenulistitembuttonview.js';
-import { DropdownMenuNestedMenuView } from './dropdownmenunestedmenuview.js';
-import { DropdownMenuListView } from './dropdownmenulistview.js';
-import { type BodyCollection } from '../../editorui/bodycollection.js';
-import type { DropdownMenuDefinition } from './utils.js';
-import type { Locale, BaseEvent } from '@ckeditor/ckeditor5-utils';
+* @module ui/dropdown/menu/dropdownmenurootlistview
+*/
+import { DropdownMenuListItemButtonView } from "./dropdownmenulistitembuttonview.js";
+import { DropdownMenuNestedMenuView } from "./dropdownmenunestedmenuview.js";
+import { DropdownMenuListView } from "./dropdownmenulistview.js";
+import { type BodyCollection } from "../../editorui/bodycollection.js";
+import type { DropdownMenuDefinition } from "./utils.js";
+import type { Locale, BaseEvent } from "@ckeditor/ckeditor5-utils";
 /**
- * Creates and manages a multi-level menu UI structure, suitable to be used inside dropdown components.
- *
- * This class creates a menu structure based on {@link module:ui/dropdown/menu/utils~DropdownMenuDefinition declarative definition}
- * passed in the constructor.
- *
- * Below is an example of a simple definition, that describes a menu with two sub-menus (Menu 1, Menu 2) and four buttons in total (Item A,
- * Item B, Item C, Item D):
- *
- * ```js
- * [
- * 	{
- * 		id: 'menu_1',
- * 		menu: 'Menu 1',
- * 		children: [
- * 			{ id: 'menu_1_a', label: 'Item A' },
- * 			{ id: 'menu_1_b', label: 'Item B' }
- * 		]
- * 	},
- * 	{
- * 		id: 'menu_2',
- * 		menu: 'Menu 2',
- * 		children: [
- * 			{ id: 'menu_2_c', label: 'Item C' },
- * 		]
- * 	},
- * 	{ id: 'item_d', label: 'Item D' }
- * ]
- * ```
- *
- * The menu is build using multiple view classes. The most important are:
- *
- * * {@link module:ui/dropdown/menu/dropdownmenunestedmenuview~DropdownMenuNestedMenuView `DropdownMenuNestedMenuView`} - "menu" - provides
- * a panel with a nested menu, and a button which opens the panel,
- * * {@link module:ui/dropdown/menu/dropdownmenulistitembuttonview~DropdownMenuListItemButtonView `DropdownMenuListItemButtonView`} -
- * "button" or "leaf button" (as opposed to buttons provided by `DropdownMenuNestedMenuView`) - should trigger some action when pressed.
- *
- * Instances of these two classes are created based on the data provided in definitions. They are assigned proper IDs and labels.
- * Other view classes build a proper DOM structure around menus and buttons.
- *
- * The `DropdownMenuNestedMenuView` instances provides panels, which may include further menus or buttons. These panels are added to
- * a `BodyCollection` view, which means they are appended outside the DOM editor and UI structure.
- *
- * When "leaf button" is pressed, it fires `execute` event which is delegated to `DropdownMenuRootListView` as `menu:execute` event. You
- * can listen to this event to perform an action:
- *
- * ```js
- * rootListView.on( 'menu:execute', evt => {
- * 	console.log( evt.source.id ); // E.g. will print 'menu_1_a' when 'Item A' is pressed.
- * } );
- * ```
- *
- * All menus and "leaf" buttons created from the definition can be easily accessed through {@link ~DropdownMenuRootListView#menus `menus`}
- * and {@link ~DropdownMenuRootListView#buttons `buttons`} properties.
- *
- * For performance reasons, the whole menu structure is created only when `DropdownMenuRootListView` is rendered for the first time.
- *
- * It is recommended to use this class together with {@link module:ui/dropdown/utils~addMenuToDropdown `addMenuToDropdown()` helper}.
- */
+* Creates and manages a multi-level menu UI structure, suitable to be used inside dropdown components.
+*
+* This class creates a menu structure based on {@link module:ui/dropdown/menu/utils~DropdownMenuDefinition declarative definition}
+* passed in the constructor.
+*
+* Below is an example of a simple definition, that describes a menu with two sub-menus (Menu 1, Menu 2) and four buttons in total (Item A,
+* Item B, Item C, Item D):
+*
+* ```js
+* [
+* 	{
+* 		id: 'menu_1',
+* 		menu: 'Menu 1',
+* 		children: [
+* 			{ id: 'menu_1_a', label: 'Item A' },
+* 			{ id: 'menu_1_b', label: 'Item B' }
+* 		]
+* 	},
+* 	{
+* 		id: 'menu_2',
+* 		menu: 'Menu 2',
+* 		children: [
+* 			{ id: 'menu_2_c', label: 'Item C' },
+* 		]
+* 	},
+* 	{ id: 'item_d', label: 'Item D' }
+* ]
+* ```
+*
+* The menu is build using multiple view classes. The most important are:
+*
+* * {@link module:ui/dropdown/menu/dropdownmenunestedmenuview~DropdownMenuNestedMenuView `DropdownMenuNestedMenuView`} - "menu" - provides
+* a panel with a nested menu, and a button which opens the panel,
+* * {@link module:ui/dropdown/menu/dropdownmenulistitembuttonview~DropdownMenuListItemButtonView `DropdownMenuListItemButtonView`} -
+* "button" or "leaf button" (as opposed to buttons provided by `DropdownMenuNestedMenuView`) - should trigger some action when pressed.
+*
+* Instances of these two classes are created based on the data provided in definitions. They are assigned proper IDs and labels.
+* Other view classes build a proper DOM structure around menus and buttons.
+*
+* The `DropdownMenuNestedMenuView` instances provides panels, which may include further menus or buttons. These panels are added to
+* a `BodyCollection` view, which means they are appended outside the DOM editor and UI structure.
+*
+* When "leaf button" is pressed, it fires `execute` event which is delegated to `DropdownMenuRootListView` as `menu:execute` event. You
+* can listen to this event to perform an action:
+*
+* ```js
+* rootListView.on( 'menu:execute', evt => {
+* 	console.log( evt.source.id ); // E.g. will print 'menu_1_a' when 'Item A' is pressed.
+* } );
+* ```
+*
+* All menus and "leaf" buttons created from the definition can be easily accessed through {@link ~DropdownMenuRootListView#menus `menus`}
+* and {@link ~DropdownMenuRootListView#buttons `buttons`} properties.
+*
+* For performance reasons, the whole menu structure is created only when `DropdownMenuRootListView` is rendered for the first time.
+*
+* It is recommended to use this class together with {@link module:ui/dropdown/utils~addMenuToDropdown `addMenuToDropdown()` helper}.
+*/
 export declare class DropdownMenuRootListView extends DropdownMenuListView {
-    /**
-     * The CSS class to be applied to nested menu panels in this dropdown menu.
-     *
-     * It is necessary, as the panels are created in body collection, outside editor and UI structure.
-     */
-    menuPanelClass: string | undefined;
-    /**
-     * The definitions object used to create the whole menu structure.
-     */
-    private readonly _definition;
-    /**
-     * Cached array of all menus in the dropdown menu (including nested menus).
-     */
-    private _cachedMenus;
-    /**
-     * Cached array of all buttons in the dropdown menu (including buttons in nested menus).
-     */
-    private _cachedButtons;
-    /**
-     * Editor body collection into which nested menus panels will be appended.
-     */
-    private _bodyCollection;
-    /**
-     * Creates an instance of the DropdownMenuRootListView class.
-     *
-     * @param locale
-     * @param bodyCollection
-     * @param definition The definition object used to create the menu structure.
-     */
-    constructor(locale: Locale, bodyCollection: BodyCollection, definition: DropdownMenuDefinition);
-    /**
-     * Returns the array of all menus in the dropdown menu (including nested menus).
-     */
-    get menus(): Array<DropdownMenuNestedMenuView>;
-    /**
-     * Returns the array of all buttons in the dropdown menu (including buttons in nested menus).
-     *
-     * Note, that this includes only "leaf" buttons, as specified in the definition passed in constructor. Buttons created as a part of
-     * the nested menus, that open nested menus when hovered or pressed, are not included.
-     */
-    get buttons(): Array<DropdownMenuListItemButtonView>;
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Closes all nested menus.
-     */
-    closeMenus(): void;
-    /**
-     * Recursively creates the whole view tree structure for the dropdown menu, according to the passed `definitions`.
-     *
-     * @private
-     */
-    private _createStructure;
+	/**
+	* The CSS class to be applied to nested menu panels in this dropdown menu.
+	*
+	* It is necessary, as the panels are created in body collection, outside editor and UI structure.
+	*/
+	menuPanelClass: string | undefined;
+	/**
+	* The definitions object used to create the whole menu structure.
+	*/
+	private readonly _definition;
+	/**
+	* Cached array of all menus in the dropdown menu (including nested menus).
+	*/
+	private _cachedMenus;
+	/**
+	* Cached array of all buttons in the dropdown menu (including buttons in nested menus).
+	*/
+	private _cachedButtons;
+	/**
+	* Editor body collection into which nested menus panels will be appended.
+	*/
+	private _bodyCollection;
+	/**
+	* Creates an instance of the DropdownMenuRootListView class.
+	*
+	* @param locale
+	* @param bodyCollection
+	* @param definition The definition object used to create the menu structure.
+	*/
+	constructor(locale: Locale, bodyCollection: BodyCollection, definition: DropdownMenuDefinition);
+	/**
+	* Returns the array of all menus in the dropdown menu (including nested menus).
+	*/
+	get menus(): Array<DropdownMenuNestedMenuView>;
+	/**
+	* Returns the array of all buttons in the dropdown menu (including buttons in nested menus).
+	*
+	* Note, that this includes only "leaf" buttons, as specified in the definition passed in constructor. Buttons created as a part of
+	* the nested menus, that open nested menus when hovered or pressed, are not included.
+	*/
+	get buttons(): Array<DropdownMenuListItemButtonView>;
+	/**
+	* @inheritDoc
+	*/
+	override render(): void;
+	/**
+	* Closes all nested menus.
+	*/
+	closeMenus(): void;
+	/**
+	* Recursively creates the whole view tree structure for the dropdown menu, according to the passed `definitions`.
+	*
+	* @private
+	*/
+	private _createStructure;
 }
 /**
- * Fired when one of the menu buttons is executed (through mouse click or keyboard).
- *
- * This event is a delegated `execute` event fired by the pressed button. The `event.source` is the button which was executed.
- *
- * @eventName ~DropdownMenuRootListView#menu:execute
- */
+* Fired when one of the menu buttons is executed (through mouse click or keyboard).
+*
+* This event is a delegated `execute` event fired by the pressed button. The `event.source` is the button which was executed.
+*
+* @eventName ~DropdownMenuRootListView#menu:execute
+*/
 export interface DropdownMenuRootListViewExecuteEvent extends BaseEvent {
-    name: 'menu:execute';
-    args: [];
+	name: "menu:execute";
+	args: [];
 }

package/dist/dropdown/menu/utils.d.ts

@@ -1,124 +1,124 @@
 /**
- * @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/dropdown/menu/utils
- */
-import type { PositioningFunction } from '@ckeditor/ckeditor5-utils';
+* @module ui/dropdown/menu/utils
+*/
+import type { PositioningFunction } from "@ckeditor/ckeditor5-utils";
 /**
- * Contains every positioning function used by {@link module:ui/dropdown/menu/dropdownmenunestedmenuview~DropdownMenuNestedMenuView} that
- * decides where the {@link module:ui/dropdown/menu/dropdownmenunestedmenuview~DropdownMenuNestedMenuView#panelView} should be placed.
- *
- * Positioning functions:
- *
- *	┌──────┬───────────────┐
- *	│      │               │
- *	└──────┤               │
- *	       │               │
- *	       │            ES │
- *	       └───────────────┘
- *
- *	┌───────────────┬──────┐
- *	│               │      │
- *	│               ├──────┘
- *	│               │
- *	│ WS            │
- *	└───────────────┘
- *
- *	       ┌───────────────┐
- *	       │            EN │
- *	       │               │
- *	┌──────┤               │
- *	│      │               │
- *	└──────┴───────────────┘
- *
- *	┌───────────────┐
- *	│ WN            │
- *	│               │
- *	│               ├──────┐
- *	│               │      │
- *	└───────────────┴──────┘
- */
+* Contains every positioning function used by {@link module:ui/dropdown/menu/dropdownmenunestedmenuview~DropdownMenuNestedMenuView} that
+* decides where the {@link module:ui/dropdown/menu/dropdownmenunestedmenuview~DropdownMenuNestedMenuView#panelView} should be placed.
+*
+* Positioning functions:
+*
+*	┌──────┬───────────────┐
+*	│      │               │
+*	└──────┤               │
+*	       │               │
+*	       │            ES │
+*	       └───────────────┘
+*
+*	┌───────────────┬──────┐
+*	│               │      │
+*	│               ├──────┘
+*	│               │
+*	│ WS            │
+*	└───────────────┘
+*
+*	       ┌───────────────┐
+*	       │            EN │
+*	       │               │
+*	┌──────┤               │
+*	│      │               │
+*	└──────┴───────────────┘
+*
+*	┌───────────────┐
+*	│ WN            │
+*	│               │
+*	│               ├──────┐
+*	│               │      │
+*	└───────────────┴──────┘
+*/
 export declare const DropdownMenuPanelPositioningFunctions: Record<string, PositioningFunction>;
 /**
- * Represents the definition of a dropdown menu.
- */
+* Represents the definition of a dropdown menu.
+*/
 export type DropdownNestedMenuDefinition = {
-    /**
-     * Unique ID for the menu.
-     */
-    id: string;
-    /**
-     * The menu name. It is used as a label for the button which opens the menu list.
-     */
-    menu: string;
-    /**
-     * The children of the dropdown menu.
-     */
-    children: DropdownMenuDefinition;
+	/**
+	* Unique ID for the menu.
+	*/
+	id: string;
+	/**
+	* The menu name. It is used as a label for the button which opens the menu list.
+	*/
+	menu: string;
+	/**
+	* The children of the dropdown menu.
+	*/
+	children: DropdownMenuDefinition;
 };
 /**
- * Represents the definition of a dropdown menu item.
- */
+* Represents the definition of a dropdown menu item.
+*/
 export type DropdownMenuButtonDefinition = {
-    /**
-     * Unique ID for the button.
-     */
-    id: string;
-    /**
-     * The label for the button.
-     */
-    label: string;
+	/**
+	* Unique ID for the button.
+	*/
+	id: string;
+	/**
+	* The label for the button.
+	*/
+	label: string;
 };
 /**
- * A definition for a nestable menu component.
- *
- * The menu can be flat and include only top-level items, or it can include multiple levels of nested sub-menus.
- *
- * Example:
- *
- * ```ts
- * [
- * 	{
- * 		id: 'menu_1',
- * 		menu: 'Menu 1',
- * 		children: [
- * 			{
- * 				id: 'menu_1_1',
- * 				menu: 'Nested menu 1',
- * 				children: [
- * 					{
- * 						id: 'item_x',
- * 						label: 'Item X'
- * 					}
- * 				]
- * 			},
- * 			{
- * 				id: 'menu_1_2',
- * 				menu: 'Nested menu 2',
- * 				children: [
- * 					{
- * 						id: 'item_y',
- * 						label: 'Item Y'
- * 					},
- * 					{
- * 						id: 'item_z',
- * 						label: 'Item Z'
- * 					}
- * 				]
- * 			}
- * 		]
- * 	},
- * 	{
- * 		id: 'top_a',
- * 		label: 'Top Item A'
- * 	},
- * 	{
- * 		id: 'top_b',
- * 		label: 'Top Item B'
- * 	}
- * ];
- * ```
- */
+* A definition for a nestable menu component.
+*
+* The menu can be flat and include only top-level items, or it can include multiple levels of nested sub-menus.
+*
+* Example:
+*
+* ```ts
+* [
+* 	{
+* 		id: 'menu_1',
+* 		menu: 'Menu 1',
+* 		children: [
+* 			{
+* 				id: 'menu_1_1',
+* 				menu: 'Nested menu 1',
+* 				children: [
+* 					{
+* 						id: 'item_x',
+* 						label: 'Item X'
+* 					}
+* 				]
+* 			},
+* 			{
+* 				id: 'menu_1_2',
+* 				menu: 'Nested menu 2',
+* 				children: [
+* 					{
+* 						id: 'item_y',
+* 						label: 'Item Y'
+* 					},
+* 					{
+* 						id: 'item_z',
+* 						label: 'Item Z'
+* 					}
+* 				]
+* 			}
+* 		]
+* 	},
+* 	{
+* 		id: 'top_a',
+* 		label: 'Top Item A'
+* 	},
+* 	{
+* 		id: 'top_b',
+* 		label: 'Top Item B'
+* 	}
+* ];
+* ```
+*/
 export type DropdownMenuDefinition = Array<DropdownNestedMenuDefinition | DropdownMenuButtonDefinition>;