NEWCKEditor AI on your premises: Hook your LLM and register MCP tools. Webinar coming soon!
Sign up (with export icon)

FootnotesPropertiesConfig

Api-interface iconinterface

The configuration of the FootnotesProperties feature.

Read more in FootnotesProperties.

Properties

  • Chevron-right icon

    defaultListStyle : 'decimal' | 'decimal-leading-zero' | 'lower-latin' | 'upper-latin' | 'lower-roman' | 'upper-roman' | 'arabic-indic' | 'lower-alpha' | 'upper-alpha' | undefined

    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.

  • Chevron-right icon

    defaultStartIndex : number | undefined

    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.

  • Chevron-right icon

    listStyles : Array<'decimal' | 'decimal-leading-zero' | 'lower-latin' | 'upper-latin' | 'lower-roman' | 'upper-roman' | 'arabic-indic' | 'lower-alpha' | 'upper-alpha'> | undefined

    The list of styles for footnotes definitions that will be shown in the footnotes properties dropdown created by the FootnotesPropertiesUI feature. 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' ]`

  • Chevron-right icon

    toolbar : Array<string> | undefined

    Items to be placed in the footnotes properties toolbar.

    Assuming that you use the FootnotesPropertiesUI feature, the following toolbar items will be available in ComponentFactory:

    • 'footnotesStyle' - the dropdown for selecting the footnotes definitions style.

    The default configuration for footnotes toolbar is:

    const footnotesPropertiesConfig = {
      toolbar: [ 'footnotesStyle' ]
    };
    
    Copy code

    Defaults to `[ 'footnotesStyle' ]`