/** * @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/footnotespropertiesconfig * @publicApi */ /** * The configuration of the {@link module:footnotes/footnotesproperties~FootnotesProperties} feature. * * Read more in {@link module:footnotes/footnotesproperties~FootnotesProperties}. */ export interface FootnotesPropertiesConfig { /** * The default style of the footnotes definitions. The default is `'decimal'`. * * Note: This configuration is used only when the footnotes definitions is being created after adding the first footnote. */ defaultListStyle?: FootnotesDefinitionsStyle; /** * The default start index of the footnotes definitions. The default is `1`. * * Note: This configuration is used only when the footnotes definitions is being created after adding the first footnote. */ defaultStartIndex?: number; /** * Items to be placed in the footnotes properties toolbar. * * Assuming that you use the * {@link module:footnotes/footnotesproperties/footnotespropertiesui~FootnotesPropertiesUI} feature, * the following toolbar items will be available in {@link module:ui/componentfactory~ComponentFactory}: * * * `'footnotesStyle'` - the dropdown for selecting the footnotes definitions style. * * The default configuration for footnotes toolbar is: * * ```ts * const footnotesPropertiesConfig = { * toolbar: [ 'footnotesStyle' ] * }; * ``` * @default `[ 'footnotesStyle' ]` */ toolbar?: Array; /** * 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; } /** * 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_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; /** * The all available styles for footnotes definitions. */ export declare const FOOTNOTES_DEFINITIONS_STYLES: readonly [...typeof FOOTNOTES_BASE_CANONICAL_DEFINITIONS_STYLES, ...typeof FOOTNOTES_ADDITIONAL_CANONICAL_DEFINITIONS_STYLES, "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;