@ckeditor/ckeditor5-footnotes 47.6.1 → 48.0.0-alpha.0

package/ckeditor5-metadata.json

@@ -1,65 +1,65 @@
 {
-  "plugins": [
-    {
-      "name": "Footnotes",
-      "className": "Footnotes",
-      "description": "Introduces footnotes functionality for adding references and notes.",
-      "docs": "features/footnotes.html",
-      "path": "src/footnotes.js",
-      "uiComponents": [
-        {
-          "name": "insertFootnote",
-          "type": "Button",
-          "iconPath": "@ckeditor/ckeditor5-icons/theme/icons/footnote.svg"
-        }
-      ],
-      "htmlOutput": [
-        {
-          "elements": "sup",
-          "classes": "footnote"
-        },
-        {
-          "elements": "a",
-          "classes": "footnote-backlink",
-          "attributes": "href"
-        },
-        {
-          "elements": "ol",
-          "classes": "footnotes"
-        },
-        {
-          "elements": "li",
-          "classes": "footnote-definition",
-          "attributes": "id"
-        },
-        {
-          "elements": "div",
-          "classes": "footnote-content"
-        }
-      ]
-    },
-    {
-      "name": "Footnotes Properties",
-      "className": "FootnotesProperties",
-      "description": "Provides the ability to customize footnote properties such as numbering style.",
-      "docs": "features/footnotes.html#footnote-properties",
-      "path": "src/footnotesproperties.js",
-      "uiComponents": [
-        {
-          "type": "Button",
-          "name": "footnotesStyle",
-          "label": "Footnote Style",
-          "iconPath": "@ckeditor/ckeditor5-icons/theme/icons/footnote.svg"
-        }
-      ],
-      "htmlOutput": [
-        {
-          "elements": "ol",
-          "classes": "footnotes",
-          "styles": "list-style-type",
-          "attributes": "type"
-        }
-      ]
-    }
-  ]
+	"plugins": [
+		{
+			"name": "Footnotes",
+			"className": "Footnotes",
+			"description": "Introduces footnotes functionality for adding references and notes.",
+			"docs": "features/footnotes.html",
+			"path": "src/footnotes.ts",
+			"uiComponents": [
+				{
+					"name": "insertFootnote",
+					"type": "Button",
+					"iconName": "IconFootnote"
+				}
+			],
+			"htmlOutput": [
+				{
+					"elements": "sup",
+					"classes": "footnote"
+				},
+				{
+					"elements": "a",
+					"classes": "footnote-backlink",
+					"attributes": "href"
+				},
+				{
+					"elements": "ol",
+					"classes": "footnotes"
+				},
+				{
+					"elements": "li",
+					"classes": "footnote-definition",
+					"attributes": "id"
+				},
+				{
+					"elements": "div",
+					"classes": "footnote-content"
+				}
+			]
+		},
+		{
+			"name": "Footnotes Properties",
+			"className": "FootnotesProperties",
+			"description": "Provides the ability to customize footnote properties such as numbering style.",
+			"docs": "features/footnotes.html#footnote-properties",
+			"path": "src/footnotesproperties.ts",
+			"uiComponents": [
+				{
+					"type": "Button",
+					"name": "footnotesStyle",
+					"label": "Footnote Style",
+					"iconName": "IconFootnote"
+				}
+			],
+			"htmlOutput": [
+				{
+					"elements": "ol",
+					"classes": "footnotes",
+					"styles": "list-style-type",
+					"attributes": "type"
+				}
+			]
+		}
+	]
 }

package/{src → dist}/commands/insertfootnotecommand.d.ts

@@ -2,7 +2,7 @@
  * @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 { Command } from 'ckeditor5/src/core.js';
+import { Command } from '@ckeditor/ckeditor5-core';
 /**
  * The insert footnote command.
  */

package/{src → dist}/footnotes.d.ts

@@ -6,7 +6,7 @@
  * @module footnotes/footnotes
  * @publicApi
  */
-import { Plugin } from 'ckeditor5/src/core.js';
+import { Plugin } from '@ckeditor/ckeditor5-core';
 import { FootnotesEditing } from './footnotesediting.js';
 import { FootnotesClipboard } from './footnotesclipboard.js';
 import { FootnotesUI } from './footnotesui.js';

package/{src → dist}/footnotesclipboard.d.ts

@@ -5,8 +5,8 @@
 /**
  * @module footnotes/footnotesclipboard
  */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { ClipboardPipeline } from 'ckeditor5/src/clipboard.js';
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import { ClipboardPipeline } from '@ckeditor/ckeditor5-clipboard';
 import { FootnotesEditing } from './footnotesediting.js';
 /**
  * The footnotes clipboard integration plugin.

package/{src → dist}/footnotesediting.d.ts

@@ -6,8 +6,8 @@
  * @module footnotes/footnotesediting
  * @publicApi
  */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { type ViewNode } from 'ckeditor5/src/engine.js';
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import { type ViewNode } from '@ckeditor/ckeditor5-engine';
 import { FootnotesTracker } from './footnotestracker.js';
 /**
  * The footnotes editing plugin.

package/{src → dist}/footnotesproperties/commands/footnotesstartcommand.d.ts

@@ -6,7 +6,7 @@
  * @module footnotes/footnotesproperties/commands/footnotesstartcommand
  * @publicApi
  */
-import { Command } from 'ckeditor5/src/core.js';
+import { Command } from '@ckeditor/ckeditor5-core';
 /**
  * Change footnotes definitions start command.
  */

package/{src → dist}/footnotesproperties/commands/footnotesstylecommand.d.ts

@@ -6,7 +6,7 @@
  * @module footnotes/footnotesproperties/commands/footnotesstylecommand
  * @publicApi
  */
-import { Command } from 'ckeditor5/src/core.js';
+import { Command } from '@ckeditor/ckeditor5-core';
 import { type FootnotesDefinitionsStyle } from '../footnotespropertiesconfig.js';
 /**
  * Change footnotes definitions style command.

package/{src → dist}/footnotesproperties/footnotespropertiesconfig.d.ts

@@ -17,7 +17,7 @@ export interface FootnotesPropertiesConfig {
      *
      * Note: This configuration is used only when the footnotes definitions is being created after adding the first footnote.
      */
-    defaultStyle?: FootnotesDefinitionsStyle;
+    defaultListStyle?: FootnotesDefinitionsStyle;
     /**
      * The default start index of the footnotes definitions. The default is `1`.
      *
@@ -40,14 +40,42 @@ export interface FootnotesPropertiesConfig {
      *   toolbar: [ 'footnotesStyle' ]
      * };
      * ```
+     * @default `[ 'footnotesStyle' ]`
      */
     toolbar?: Array<string>;
+    /**
+     * The list of styles for footnotes definitions that will be shown in the footnotes properties dropdown
+     * created by the {@link module:footnotes/footnotesproperties/footnotespropertiesui~FootnotesPropertiesUI} feature.
+     * The order of styles in the dropdown corresponds to the order of styles in this configuration.
+     *
+     * @default `[ 'decimal', 'decimal-leading-zero', 'lower-latin', 'upper-latin', 'lower-roman', 'upper-roman' ]`
+     */
+    listStyles?: Array<FootnotesDefinitionsStyle>;
 }
 /**
- * The available styles for footnotes definitions.
+ * The list of the default styles for footnotes definitions. These styles are shown
+ * by default in the footnotes properties dropdown and are supported in the editor by default.
  */
-export declare const FOOTNOTES_DEFINITIONS_STYLES: readonly ["decimal", "decimal-leading-zero", "lower-latin", "upper-latin", "lower-alpha", "upper-alpha", "lower-roman", "upper-roman"];
+export declare const FOOTNOTES_BASE_CANONICAL_DEFINITIONS_STYLES: readonly ["decimal", "decimal-leading-zero", "lower-latin", "upper-latin", "lower-roman", "upper-roman"];
+/**
+ * The list of additional styles for footnotes definitions. These styles are supported in the editor but not shown
+ * in the footnotes properties dropdown by default. To show them in the dropdown, they must be added to the
+ * {@link module:footnotes/footnotesproperties/footnotespropertiesconfig~FootnotesPropertiesConfig#listStyles} configuration.
+ */
+export declare const FOOTNOTES_ADDITIONAL_CANONICAL_DEFINITIONS_STYLES: readonly ["arabic-indic"];
+/**
+ * The mapping of the footnotes definitions styles aliases to their canonical names.
+ */
+export declare const FOOTNOTES_DEFINITION_STYLES_ALIASES: Record<string, FootnotesDefinitionsStyle>;
+/**
+ * The all available styles for footnotes definitions.
+ */
+export declare const FOOTNOTES_DEFINITIONS_STYLES: readonly ["decimal", "decimal-leading-zero", "lower-latin", "upper-latin", "lower-roman", "upper-roman", "arabic-indic", "lower-alpha", "upper-alpha"];
 /**
  * The style of the footnotes list. It should correspond to the `list-style-type` CSS property.
  */
 export type FootnotesDefinitionsStyle = (typeof FOOTNOTES_DEFINITIONS_STYLES)[number];
+/**
+ * The style of the footnotes list without aliases. It should correspond to the `list-style-type` CSS property.
+ */
+export type FootnotesDefinitionsCanonicalStyle = Exclude<FootnotesDefinitionsStyle, `${string}-alpha`>;

package/{src → dist}/footnotesproperties/footnotespropertiesediting.d.ts

@@ -6,7 +6,8 @@
  * @module footnotes/footnotesproperties/footnotespropertiesediting
  * @publicApi
  */
-import { Plugin } from 'ckeditor5/src/core.js';
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import { type FootnotesDefinitionsCanonicalStyle } from './footnotespropertiesconfig.js';
 import { FootnotesTracker } from '../footnotestracker.js';
 import { FootnotesEditing } from '../footnotesediting.js';
 /**
@@ -34,3 +35,10 @@ export declare class FootnotesPropertiesEditing extends Plugin {
      */
     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.
+ */
+export declare function toCanonicalFootnotesListStyle(listStyle: unknown): FootnotesDefinitionsCanonicalStyle | null;

package/dist/footnotesproperties/footnotespropertiesformatters.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @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
+ */
+/**
+ * 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;

package/{src → dist}/footnotesproperties/footnotespropertiesui.d.ts

@@ -6,9 +6,9 @@
  * @module footnotes/footnotesproperties/footnotespropertiesui
  * @publicApi
  */
-import { ContextualBalloon } from 'ckeditor5/src/ui.js';
-import { WidgetToolbarRepository } from 'ckeditor5/src/widget.js';
-import { Plugin } from 'ckeditor5/src/core.js';
+import { ContextualBalloon } from '@ckeditor/ckeditor5-ui';
+import { WidgetToolbarRepository } from '@ckeditor/ckeditor5-widget';
+import { Plugin } from '@ckeditor/ckeditor5-core';
 import '../../theme/footnotesproperties.css';
 /**
  * A plugin that provides footnotes properties UI.

package/{src → dist}/footnotesproperties.d.ts

@@ -6,7 +6,7 @@
  * @module footnotes/footnotesproperties
  * @publicApi
  */
-import { Plugin } from 'ckeditor5/src/core.js';
+import { Plugin } from '@ckeditor/ckeditor5-core';
 import { FootnotesPropertiesEditing } from './footnotesproperties/footnotespropertiesediting.js';
 import { FootnotesPropertiesUI } from './footnotesproperties/footnotespropertiesui.js';
 /**

package/{src → dist}/footnotestracker.d.ts

@@ -6,8 +6,8 @@
  * @module footnotes/footnotestracker
  * @publicApi
  */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import type { ModelElement } from 'ckeditor5/src/engine.js';
+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.
  *

package/{src → dist}/footnotesui.d.ts

@@ -2,7 +2,7 @@
  * @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 'ckeditor5/src/core.js';
+import { Plugin } from '@ckeditor/ckeditor5-core';
 import '../theme/footnotes.css';
 /**
  * The footnotes UI plugin.

package/dist/index-content.css

@@ -3,62 +3,80 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 :root{
-	--ck-content-footnotes-list-background-color:none;
-	--ck-content-footnotes-list-separator-color:hsl(0, 0%, 0%);
-	--ck-content-footnote-font-size:var(--ck-content-font-size-small);
+  --ck-content-footnotes-list-background-color:none;
+  --ck-content-footnotes-list-separator-color:#000;
+  --ck-content-footnote-font-size:var(--ck-content-font-size-small);
 }
+
 .ck-content .footnote{
-		margin-inline-end:0.2em;
-	}
+  margin-inline-end:.2em;
+}
+
 .ck-content .footnotes{
-		position:relative;
-		margin:0.9em 0 1.5em;
-		font-size:var(--ck-content-footnote-font-size);
-		background-color:var(--ck-content-footnotes-list-background-color);
-	}
+  font-size:var(--ck-content-footnote-font-size);
+  background-color:var(--ck-content-footnotes-list-background-color);
+  margin:.9em 0 1.5em;
+  position:relative;
+}
+
 .ck-content .footnotes-divider{
-		border:none;
-		border-top:1px solid var(--ck-content-footnotes-list-separator-color);
-		width:min(30%, 350px);
-		margin:0 0 1em 0;
-		height:1px;
-		background:none;
-	}
+  border:none;
+  border-top:1px solid var(--ck-content-footnotes-list-separator-color);
+  background:none;
+  width:min(30%, 350px);
+  height:1px;
+  margin:0 0 1em;
+}
+
+[dir="rtl"] :is(.ck-content .footnotes-divider){
+  margin-left:auto;
+  margin-right:0;
+}
+
 .ck-content .footnotes-list{
-		padding-inline-start:3em;
-		margin:0;
-	}
+  margin:0;
+  padding-inline-start:3em;
+}
+
 .ck-content .footnote-backlink{
-		display:inline-block;
-		margin-inline-end:1ch;
-		user-select:none;
-		vertical-align:top;
-		width:auto;
-	}
+  user-select:none;
+  vertical-align:top;
+  width:auto;
+  margin-inline-end:1ch;
+  display:inline-block;
+}
+
 .ck-content .footnote-content{
-		display:inline-block;
-		width:calc(100% - 2em);
-		padding:0 4px;
-		vertical-align:top;
-	}
+  vertical-align:top;
+  width:calc(100% - 2em);
+  padding:0 4px;
+  display:inline-block;
+}
+
 .ck-content .footnote-content > p:first-of-type{
-			margin-top:0;
-		}
+  margin-top:0;
+}
+
 .ck-content .footnote-content > p:last-of-type{
-			margin-bottom:0;
-		}
+  margin-bottom:0;
+}
+
 .ck-content .footnote-content ol{
-			list-style-type:decimal;
-		}
+  list-style-type:decimal;
+}
+
 .ck-content .footnote-content ol ol{
-			list-style-type:lower-latin;
-		}
+  list-style-type:lower-latin;
+}
+
 .ck-content .footnote-content ol ol ol{
-			list-style-type:lower-roman;
-		}
+  list-style-type:lower-roman;
+}
+
 .ck-content .footnote-content ol ol ol ol{
-			list-style-type:upper-latin;
-		}
+  list-style-type:upper-latin;
+}
+
 .ck-content .footnote-content ol ol ol ol ol{
-			list-style-type:upper-roman;
-		}
+  list-style-type:upper-roman;
+}

package/dist/index-editor.css

@@ -3,79 +3,79 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 :root{
-	--ck-content-footnotes-list-background-color:none;
-	--ck-content-footnotes-list-separator-color:hsl(0, 0%, 0%);
-	--ck-content-footnote-font-size:var(--ck-content-font-size-small);
-	--ck-footnotes-widget-label-background-color:hsl(0, 0%, 46%);
+  --ck-content-footnotes-list-background-color:none;
+  --ck-content-footnotes-list-separator-color:#000;
+  --ck-content-footnote-font-size:var(--ck-content-font-size-small);
+  --ck-footnotes-widget-label-background-color:#757575;
 }
-[dir="rtl"] .ck-content .footnotes-divider{
-			margin-left:auto;
-			margin-right:0;
-	}
+
 .ck.ck-editor__editable .footnotes.ck-widget{
-		display:flow-root;
-		position:relative;
-		margin:0.9em 0 0.85em;
-	}
+  margin:.9em 0 .85em;
+  display:flow-root;
+  position:relative;
+}
+
 .ck.ck-editor__editable .footnotes.ck-widget:not(:hover):not(.ck-widget_selected){
-			outline:1px solid var(--ck-color-base-border);
-		}
-.ck.ck-editor__editable .footnotes.ck-widget[data-footnotes-list-label]::after{
-			content:attr(data-footnotes-list-label);
+  outline:1px solid var(--ck-color-base-border);
+}
 
-			position:absolute;
-			top:-1px;
-			right:10px;
-			padding:var(--ck-spacing-tiny) var(--ck-spacing-medium);
-			background-color:var(--ck-footnotes-widget-label-background-color);
+.ck.ck-editor__editable .footnotes.ck-widget[data-footnotes-list-label]:after{
+  content:attr(data-footnotes-list-label);
+  padding:var(--ck-spacing-tiny) var(--ck-spacing-medium);
+  background-color:var(--ck-footnotes-widget-label-background-color);
+  font-size:10px;
+  font-family:var(--ck-font-face);
+  color:#fff;
+  white-space:nowrap;
+  line-height:16px;
+  position:absolute;
+  top:-1px;
+  right:10px;
+}
+
+[dir="rtl"] :is(.ck.ck-editor__editable .footnotes.ck-widget[data-footnotes-list-label]:after){
+  left:10px;
+  right:auto;
+}
 
-			font-size:10px;
-			font-family:var(--ck-font-face);
-			line-height:16px;
-			color:hsl(0, 0%, 100%);
-			white-space:nowrap;
-		}
-[dir="rtl"] .ck.ck-editor__editable .footnotes.ck-widget[data-footnotes-list-label]::after{
-				left:10px;
-				right:auto;
-	}
 .ck.ck-editor__editable .footnotes-divider{
-		margin-top:0;
-	}
+  margin-top:0;
+}
+
 .ck.ck-editor__editable .footnotes-list{
-		margin-top:0;
-		margin-bottom:0.65em;
-	}
+  margin-top:0;
+  margin-bottom:.65em;
+}
 
 :root{
-	--ck-footnotes-styles-list-style-button-size:44px;
+  --ck-footnotes-styles-list-style-button-size:44px;
 }
 
 .ck.ck-footnotes-definitions-properties > .ck-footnotes-definitions-styles-list{
-		display:grid;
-		row-gap:var(--ck-spacing-medium);
-		column-gap:var(--ck-spacing-medium);
-		padding:var(--ck-spacing-large);
-		grid-template-columns:repeat( 4, auto);
-	}
+  row-gap:var(--ck-spacing-medium);
+  column-gap:var(--ck-spacing-medium);
+  padding:var(--ck-spacing-large);
+  grid-template-columns:repeat(4, auto);
+  display:grid;
+}
 
 .ck.ck-footnotes-definitions-properties > .ck-footnotes-definitions-styles-list .ck-button{
-			width:var(--ck-footnotes-styles-list-style-button-size);
-			height:var(--ck-footnotes-styles-list-style-button-size);
-			padding:0;
-			margin:0;
-			box-sizing:content-box;
-		}
+  width:var(--ck-footnotes-styles-list-style-button-size);
+  height:var(--ck-footnotes-styles-list-style-button-size);
+  box-sizing:content-box;
+  margin:0;
+  padding:0;
+}
 
 .ck.ck-footnotes-definitions-properties > .ck-footnotes-definitions-styles-list .ck-button .ck-icon{
-				width:var(--ck-footnotes-styles-list-style-button-size);
-				height:var(--ck-footnotes-styles-list-style-button-size);
-			}
+  width:var(--ck-footnotes-styles-list-style-button-size);
+  height:var(--ck-footnotes-styles-list-style-button-size);
+}
 
 .ck.ck-footnotes-definitions-properties > .ck-collapsible{
-		border-top:1px solid var(--ck-color-base-border);
-	}
+  border-top:1px solid var(--ck-color-base-border);
+}
 
 .ck.ck-footnotes-definitions-properties > .ck-collapsible .ck-footnotes-definitions-properties__start-index .ck-input{
-			min-width:100%;
-		}
+  min-width:100%;
+}