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

package/dist/componentfactory.d.ts

@@ -1,81 +1,81 @@
 /**
- * @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/componentfactory
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import type { Editor } from '@ckeditor/ckeditor5-core';
-import { type View } from './view.js';
+* @module ui/componentfactory
+*/
+import { type Locale } from "@ckeditor/ckeditor5-utils";
+import type { Editor } from "@ckeditor/ckeditor5-core";
+import { type View } from "./view.js";
 /**
- * A helper class implementing the UI component ({@link module:ui/view~View view}) factory.
- *
- * It allows functions producing specific UI components to be registered under their unique names
- * in the factory. A registered component can be then instantiated by providing its name.
- * Note that the names are case insensitive.
- *
- * ```ts
- * // The editor provides localization tools for the factory.
- * const factory = new ComponentFactory( editor );
- *
- * factory.add( 'foo', locale => new FooView( locale ) );
- * factory.add( 'bar', locale => new BarView( locale ) );
- *
- * // An instance of FooView.
- * const fooInstance = factory.create( 'foo' );
- *
- * // Names are case insensitive so this is also allowed:
- * const barInstance = factory.create( 'Bar' );
- * ```
- *
- * The {@link module:core/editor/editor~Editor#locale editor locale} is passed to the factory
- * function when {@link module:ui/componentfactory~ComponentFactory#create} is called.
- */
+* A helper class implementing the UI component ({@link module:ui/view~View view}) factory.
+*
+* It allows functions producing specific UI components to be registered under their unique names
+* in the factory. A registered component can be then instantiated by providing its name.
+* Note that the names are case insensitive.
+*
+* ```ts
+* // The editor provides localization tools for the factory.
+* const factory = new ComponentFactory( editor );
+*
+* factory.add( 'foo', locale => new FooView( locale ) );
+* factory.add( 'bar', locale => new BarView( locale ) );
+*
+* // An instance of FooView.
+* const fooInstance = factory.create( 'foo' );
+*
+* // Names are case insensitive so this is also allowed:
+* const barInstance = factory.create( 'Bar' );
+* ```
+*
+* The {@link module:core/editor/editor~Editor#locale editor locale} is passed to the factory
+* function when {@link module:ui/componentfactory~ComponentFactory#create} is called.
+*/
 export declare class ComponentFactory {
-    /**
-     * The editor instance that the factory belongs to.
-     */
-    readonly editor: Editor;
-    /**
-     * Registered component factories.
-     */
-    private readonly _components;
-    /**
-     * Creates an instance of the factory.
-     *
-     * @param editor The editor instance.
-     */
-    constructor(editor: Editor);
-    /**
-     * Returns an iterator of registered component names. Names are returned in lower case.
-     */
-    names(): IterableIterator<string>;
-    /**
-     * Registers a component factory function that will be used by the
-     * {@link #create create} method and called with the
-     * {@link module:core/editor/editor~Editor#locale editor locale} as an argument,
-     * allowing localization of the {@link module:ui/view~View view}.
-     *
-     * @param name The name of the component.
-     * @param callback The callback that returns the component.
-     */
-    add(name: string, callback: (locale: Locale) => View): void;
-    /**
-     * Creates an instance of a component registered in the factory under a specific name.
-     *
-     * When called, the {@link module:core/editor/editor~Editor#locale editor locale} is passed to
-     * the previously {@link #add added} factory function, allowing localization of the
-     * {@link module:ui/view~View view}.
-     *
-     * @param name The name of the component.
-     * @returns The instantiated component view.
-     */
-    create(name: string): View;
-    /**
-     * Checks if a component of a given name is registered in the factory.
-     *
-     * @param name The name of the component.
-     */
-    has(name: string): boolean;
+	/**
+	* The editor instance that the factory belongs to.
+	*/
+	readonly editor: Editor;
+	/**
+	* Registered component factories.
+	*/
+	private readonly _components;
+	/**
+	* Creates an instance of the factory.
+	*
+	* @param editor The editor instance.
+	*/
+	constructor(editor: Editor);
+	/**
+	* Returns an iterator of registered component names. Names are returned in lower case.
+	*/
+	names(): IterableIterator<string>;
+	/**
+	* Registers a component factory function that will be used by the
+	* {@link #create create} method and called with the
+	* {@link module:core/editor/editor~Editor#locale editor locale} as an argument,
+	* allowing localization of the {@link module:ui/view~View view}.
+	*
+	* @param name The name of the component.
+	* @param callback The callback that returns the component.
+	*/
+	add(name: string, callback: (locale: Locale) => View): void;
+	/**
+	* Creates an instance of a component registered in the factory under a specific name.
+	*
+	* When called, the {@link module:core/editor/editor~Editor#locale editor locale} is passed to
+	* the previously {@link #add added} factory function, allowing localization of the
+	* {@link module:ui/view~View view}.
+	*
+	* @param name The name of the component.
+	* @returns The instantiated component view.
+	*/
+	create(name: string): View;
+	/**
+	* Checks if a component of a given name is registered in the factory.
+	*
+	* @param name The name of the component.
+	*/
+	has(name: string): boolean;
 }