FootnotesPropertiesConfig
The configuration of the FootnotesProperties feature.
Read more in FootnotesProperties.
Properties
defaultListStyle : 'decimal' | 'decimal-leading-zero' | 'lower-latin' | 'upper-latin' | 'lower-roman' | 'upper-roman' | 'arabic-indic' | 'lower-alpha' | 'upper-alpha' | undefinedmodule:footnotes/footnotesproperties/footnotespropertiesconfig~FootnotesPropertiesConfig#defaultListStyleThe 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.
defaultStartIndex : number | undefinedmodule:footnotes/footnotesproperties/footnotespropertiesconfig~FootnotesPropertiesConfig#defaultStartIndexThe 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.
listStyles : Array<'decimal' | 'decimal-leading-zero' | 'lower-latin' | 'upper-latin' | 'lower-roman' | 'upper-roman' | 'arabic-indic' | 'lower-alpha' | 'upper-alpha'> | undefinedmodule:footnotes/footnotesproperties/footnotespropertiesconfig~FootnotesPropertiesConfig#listStylesThe list of styles for footnotes definitions that will be shown in the footnotes properties dropdown created by the
FootnotesPropertiesUIfeature. The order of styles in the dropdown corresponds to the order of styles in this configuration.Defaults to
`[ 'decimal', 'decimal-leading-zero', 'lower-latin', 'upper-latin', 'lower-roman', 'upper-roman' ]`toolbar : Array<string> | undefinedmodule:footnotes/footnotesproperties/footnotespropertiesconfig~FootnotesPropertiesConfig#toolbarItems to be placed in the footnotes properties toolbar.
Assuming that you use the
FootnotesPropertiesUIfeature, the following toolbar items will be available inComponentFactory:'footnotesStyle'- the dropdown for selecting the footnotes definitions style.
The default configuration for footnotes toolbar is:
const footnotesPropertiesConfig = { toolbar: [ 'footnotesStyle' ] };Copy codeDefaults to
`[ 'footnotesStyle' ]`