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

package/dist/footnotesproperties/footnotespropertiesediting.d.ts

@@ -1,44 +1,44 @@
 /**
- * @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 footnotes/footnotesproperties/footnotespropertiesediting
- * @publicApi
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { type FootnotesDefinitionsCanonicalStyle } from './footnotespropertiesconfig.js';
-import { FootnotesTracker } from '../footnotestracker.js';
-import { FootnotesEditing } from '../footnotesediting.js';
+* @module footnotes/footnotesproperties/footnotespropertiesediting
+* @publicApi
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { type FootnotesDefinitionsCanonicalStyle } from "./footnotespropertiesconfig.js";
+import { FootnotesTracker } from "../footnotestracker.js";
+import { FootnotesEditing } from "../footnotesediting.js";
 /**
- * A plugin that provides footnotes properties editing.
- */
+* A plugin that provides footnotes properties editing.
+*/
 export declare class FootnotesPropertiesEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FootnotesPropertiesEditing";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof FootnotesEditing, typeof FootnotesTracker];
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "FootnotesPropertiesEditing";
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[FootnotesEditing, FootnotesTracker]>;
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }
 /**
- * Normalizes footnotes list style by converting aliases to their canonical form.
- *
- * @param listStyle The list style value to normalize.
- * @returns The canonical form of the list style.
- */
+* Normalizes footnotes list style by converting aliases to their canonical form.
+*
+* @param listStyle The list style value to normalize.
+* @returns The canonical form of the list style.
+*/
 export declare function toCanonicalFootnotesListStyle(listStyle: unknown): FootnotesDefinitionsCanonicalStyle | null;

package/dist/footnotesproperties/footnotespropertiesformatters.d.ts

@@ -1,27 +1,21 @@
 /**
- * @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 footnotes/footnotesproperties/footnotespropertiesformatters
- * @publicApi
- */
+* @module footnotes/footnotesproperties/footnotespropertiesformatters
+*/
+import type { FootnotesDefinitionsStyle } from "./footnotespropertiesconfig.js";
 /**
- * Formats a unsigned decimal number with leading zeros based on the specified number of digits.
- *
- * @param n The number to format.
- * @param digits The minimum number of digits.
- * @returns The formatted string with leading zeros.
- */
-export declare function formatDecimalLeadingZeroFootnote(n: number, digits: number): string;
-/**
- * Converts a unsigned number to alphabetic representation like Excel columns (A, B, C, ..., Z, AA, AB, ...).
- * This follows Excel-style numbering: 1=A, 2=B, ..., 26=Z, 27=AA, 28=AB, etc.
- *
- * @param n The number to convert (must be >= 1).
- * @param upper Whether to use uppercase letters.
- * @returns The alphabetic representation of the number.
- */
-export declare function formatLatinFootnote(n: number, upper: boolean): string;
-export declare function formatRomanFootnote(n: number, upper: boolean): string;
-export declare function formatArabicIndicFootnote(n: number): string;
+* Formats provided footnote value using selected style.
+*
+* @param options Formatter options.
+* @returns Formatted string.
+*/
+export declare function formatFootnoteListValue({ style, digits, value }: FormatFootnoteListValueOptions): string;
+type FormatFootnoteListValueOptions = {
+	style?: FootnotesDefinitionsStyle;
+	digits: number;
+	value: number;
+};
+export {};

package/dist/footnotesproperties/footnotespropertiesui.d.ts

@@ -1,41 +1,41 @@
 /**
- * @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 footnotes/footnotesproperties/footnotespropertiesui
- * @publicApi
- */
-import { ContextualBalloon } from '@ckeditor/ckeditor5-ui';
-import { WidgetToolbarRepository } from '@ckeditor/ckeditor5-widget';
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import '../../theme/footnotesproperties.css';
+* @module footnotes/footnotesproperties/footnotespropertiesui
+* @publicApi
+*/
+import { ContextualBalloon } from "@ckeditor/ckeditor5-ui";
+import { WidgetToolbarRepository } from "@ckeditor/ckeditor5-widget";
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import "../../theme/footnotesproperties.css";
 /**
- * A plugin that provides footnotes properties UI.
- */
+* A plugin that provides footnotes properties UI.
+*/
 export declare class FootnotesPropertiesUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FootnotesPropertiesUI";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ContextualBalloon, typeof WidgetToolbarRepository];
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "FootnotesPropertiesUI";
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[ContextualBalloon, WidgetToolbarRepository]>;
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
 }

package/dist/footnotesproperties/ui/footnotesdefinitionspropertiesview.d.ts

@@ -1,15 +1,15 @@
 /**
- * @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
+*/
 /**
- * Fired when the footnotes start index value has changed via {@link ~FootnotesDefinitionsPropertiesView#startIndexFieldView}.
- *
- * @eventName ~FootnotesDefinitionsPropertiesView#listStart
- */
+* Fired when the footnotes start index value has changed via {@link ~FootnotesDefinitionsPropertiesView#startIndexFieldView}.
+*
+* @eventName ~FootnotesDefinitionsPropertiesView#listStart
+*/
 export type FootnotesDefinitionsPropertiesViewListStartEvent = {
-    name: 'footnotesListStart';
-    args: [data: {
-        startIndex: number;
-    }];
+	name: "footnotesListStart";
+	args: [data: {
+		startIndex: number;
+	}];
 };

package/dist/footnotesproperties.d.ts

@@ -1,32 +1,32 @@
 /**
- * @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 footnotes/footnotesproperties
- * @publicApi
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { FootnotesPropertiesEditing } from './footnotesproperties/footnotespropertiesediting.js';
-import { FootnotesPropertiesUI } from './footnotesproperties/footnotespropertiesui.js';
+* @module footnotes/footnotesproperties
+* @publicApi
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { FootnotesPropertiesEditing } from "./footnotesproperties/footnotespropertiesediting.js";
+import { FootnotesPropertiesUI } from "./footnotesproperties/footnotespropertiesui.js";
 /**
- * The footnotes properties plugin.
- */
+* The footnotes properties plugin.
+*/
 export declare class FootnotesProperties extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FootnotesProperties";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof FootnotesPropertiesEditing, typeof FootnotesPropertiesUI];
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "FootnotesProperties";
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[FootnotesPropertiesEditing, FootnotesPropertiesUI]>;
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
 }

package/dist/footnotestracker.d.ts

@@ -1,102 +1,102 @@
 /**
- * @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 footnotes/footnotestracker
- * @publicApi
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import type { ModelElement } from '@ckeditor/ckeditor5-engine';
+* @module footnotes/footnotestracker
+* @publicApi
+*/
+import { Plugin, type Editor } from "@ckeditor/ckeditor5-core";
+import type { ModelElement } from "@ckeditor/ckeditor5-engine";
 /**
- * The footnotes tracker. It keeps track of all footnotes in the editor.
- *
- * It is used by the {@link module:footnotes/footnotesediting~FootnotesEditing} to update the list of
- * footnotes when they are added or removed.
- */
+* The footnotes tracker. It keeps track of all footnotes in the editor.
+*
+* It is used by the {@link module:footnotes/footnotesediting~FootnotesEditing} to update the list of
+* footnotes when they are added or removed.
+*/
 export declare class FootnotesTracker extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FootnotesTracker";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Returns the footnotes definitions container element.
-     *
-     * @returns The footnotes definitions container or `null` if it does not exist.
-     */
-    getFootnotesDefinitionsObjectElement(): ModelElement | null;
-    /**
-     * Returns the footnote with the given ID.
-     *
-     * @param footnoteId The ID of the footnote to find.
-     * @returns The footnote item or `null` if not found.
-     */
-    getFootnote(footnoteId: string): Footnote | null;
-    /**
-     * Returns all footnotes in the editor.
-     *
-     * @returns An array of footnote items.
-     */
-    getFootnotes(): Array<Footnote>;
-    /**
-     * Returns the registered footnote formatter.
-     *
-     * @returns The footnote formatter or `null` if not set.
-     */
-    getFootnotesFormatter(): FootnoteFormatterCallback | null;
-    /**
-     * Registers a custom footnote formatter.
-     *
-     * @param formatter The footnote formatter to register.
-     */
-    setFootnoteFormatter(formatter: FootnoteFormatterCallback): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "FootnotesTracker";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Returns the footnotes definitions container element.
+	*
+	* @returns The footnotes definitions container or `null` if it does not exist.
+	*/
+	getFootnotesDefinitionsObjectElement(): ModelElement | null;
+	/**
+	* Returns the footnote with the given ID.
+	*
+	* @param footnoteId The ID of the footnote to find.
+	* @returns The footnote item or `null` if not found.
+	*/
+	getFootnote(footnoteId: string): Footnote | null;
+	/**
+	* Returns all footnotes in the editor.
+	*
+	* @returns An array of footnote items.
+	*/
+	getFootnotes(): Array<Footnote>;
+	/**
+	* Returns the registered footnote formatter.
+	*
+	* @returns The footnote formatter or `null` if not set.
+	*/
+	getFootnotesFormatter(): FootnoteFormatterCallback | null;
+	/**
+	* Registers a custom footnote formatter.
+	*
+	* @param formatter The footnote formatter to register.
+	*/
+	setFootnoteFormatter(formatter: FootnoteFormatterCallback): void;
 }
 /**
- * Footnote item stored in the {@link module:footnotes/footnotestracker~FootnotesTracker}.
- */
+* Footnote item stored in the {@link module:footnotes/footnotestracker~FootnotesTracker}.
+*/
 export type Footnote = {
-    id: string;
-    reference: ModelElement;
-    definition: ModelElement;
+	id: string;
+	reference: ModelElement;
+	definition: ModelElement;
 };
 /**
- * Parameters for formatting footnote list values.
- */
+* Parameters for formatting footnote list values.
+*/
 export type FormatFootnoteListValueParams = {
-    /**
-     * The footnote being formatted.
-     */
-    footnote: Footnote;
-    /**
-     * The footnotes definitions container element.
-     */
-    container: ModelElement;
-    /**
-     * Number of digits needed for the highest footnote number.
-     */
-    digits: number;
-    /**
-     * The footnote number to format (1-based).
-     */
-    value: number;
+	/**
+	* The footnote being formatted.
+	*/
+	footnote: Footnote;
+	/**
+	* The footnotes definitions container element.
+	*/
+	container: ModelElement;
+	/**
+	* Number of digits needed for the highest footnote number.
+	*/
+	digits: number;
+	/**
+	* The footnote number to format (1-based).
+	*/
+	value: number;
 };
 /**
- * Footnote formatter interface.
- */
+* Footnote formatter interface.
+*/
 export type FootnoteFormatterCallback = (params: FormatFootnoteListValueParams) => string;

package/dist/footnotesui.d.ts

@@ -1,31 +1,31 @@
 /**
- * @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
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import '../theme/footnotes.css';
+* @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
+*/
+import { Plugin } from "@ckeditor/ckeditor5-core";
+import "../theme/footnotes.css";
 /**
- * The footnotes UI plugin.
- */
+* The footnotes UI plugin.
+*/
 export declare class FootnotesUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FootnotesUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "FootnotesUI";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
 }

package/dist/index.d.ts

@@ -1,21 +1,21 @@
 /**
- * @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 footnotes
- */
-import './augmentation.js';
-export { Footnotes } from './footnotes.js';
-export { FootnotesEditing } from './footnotesediting.js';
-export { FootnotesClipboard } from './footnotesclipboard.js';
-export { FootnotesUI } from './footnotesui.js';
-export { InsertFootnoteCommand } from './commands/insertfootnotecommand.js';
-export { FootnotesTracker, type Footnote, type FootnoteFormatterCallback, type FormatFootnoteListValueParams } from './footnotestracker.js';
-export type { FootnotesConfig } from './footnotesconfig.js';
-export { FootnotesStyleCommand } from './footnotesproperties/commands/footnotesstylecommand.js';
-export { FootnotesStartCommand } from './footnotesproperties/commands/footnotesstartcommand.js';
-export { FootnotesPropertiesEditing } from './footnotesproperties/footnotespropertiesediting.js';
-export { FootnotesPropertiesUI } from './footnotesproperties/footnotespropertiesui.js';
-export { FootnotesProperties } from './footnotesproperties.js';
-export type { FootnotesDefinitionsStyle, FootnotesPropertiesConfig } from './footnotesproperties/footnotespropertiesconfig.js';
+* @module footnotes
+*/
+import "./augmentation.js";
+export { Footnotes } from "./footnotes.js";
+export { FootnotesEditing } from "./footnotesediting.js";
+export { FootnotesClipboard } from "./footnotesclipboard.js";
+export { FootnotesUI } from "./footnotesui.js";
+export { InsertFootnoteCommand } from "./commands/insertfootnotecommand.js";
+export { FootnotesTracker, type Footnote, type FootnoteFormatterCallback, type FormatFootnoteListValueParams } from "./footnotestracker.js";
+export type { FootnotesConfig } from "./footnotesconfig.js";
+export { FootnotesStyleCommand } from "./footnotesproperties/commands/footnotesstylecommand.js";
+export { FootnotesStartCommand } from "./footnotesproperties/commands/footnotesstartcommand.js";
+export { FootnotesPropertiesEditing } from "./footnotesproperties/footnotespropertiesediting.js";
+export { FootnotesPropertiesUI } from "./footnotesproperties/footnotespropertiesui.js";
+export { FootnotesProperties } from "./footnotesproperties.js";
+export type { FootnotesDefinitionsStyle, FootnotesPropertiesConfig } from "./footnotesproperties/footnotespropertiesconfig.js";