Upcoming Deprecations 7.14

A number of obsolete APIs of Fonto Editor will be removed in the 7.14 release, which has a planned release date of March 2021. This page describes how to move on to a replacement API. We expect this to not take longer than two days (16hrs), at most. All instructions in this list should be followed before the 7.14 release.

Most of the APIs have already been deprecated in past releases so it is possible that some of these changes have already been applied to your editor.

The instructions are grouped by their area and then sorted by difficulty.

Obsolete and unused react props

The following props or usages of props in Fonto components are deprecated:

  • The prop truncatedItemWidth of the Breadcrumbs component does not have to be set. It is safe to remove its usage.

  • The prop isFullColor of the FontoLogo component will be removed. It has been obsolete since the new Fonto logo we introduced in the 7.5 release. It is safe to remove its usage.

  • The prop onlyUpdateStateAgainAfterMs of the FXOperationButton will be removed. It is safe to remove its usage.

Unused FDS constants

Unused CVK properties

Renames

The following renames have taken place in recent Fonto versions. Currently, they still work because the old name is aliased to the new one, but this will be removed in the 7.15 release.

Operations

Files

The following files have had their extension changed:

The following files have been moved to a different directory:

  • The file addDragAndDropOperation.js was moved to the directory fontoxml-structure.

  • The file StructureView.jsx was moved to the directory fontoxml-structure.

  • The file getClosestStructureViewItem.js was moved to the directory fontoxml-structure.

  • For all of these files, simply change the fontoxml-structure-view part of the import to fontoxml-structure.

  • The file configureStructureViewItemProperties.js was moved to the directory fontoxml-families.

  • The file configureAsStructureViewItem.js was moved to the directory fontoxml-families.

  • For all of these files, simply change the fontoxml-structure-view part of the import to fontoxml-families.

Configuration variables

The following configuration variables have changed:

The configuration value maximum-number-of-find-results is now included in the find-and-replace-configuration.

The configuration value wiris-initialization-parameters is now called wiris-mathtype-initialization-parameters.

The scope property wirisEditorScriptUrl was replaced with the wiris-mathtype-script-url configuration variable.

Connectors

In the 7.8 release, we have changed how connectors work. If you use the old way of configuring connectors, please follow the Upgrade Instructions from 7.7 to 7.8 to upgrade your custom connectors if you have not already done so.

Image families

In the past, all of these families (configureAsImage, configureAsInlineImage, configureAsImageInFrame and configureAsInlineImageInFrame) assumed the application used permanent ids. For all of these families, replace the argument like this:

JavaScript

// Before:
configureAsImage(sxModule, 'self::img', 'image', 'href');
// After:
configureAsImage(sxModule, 'self::img', 'image', {referenceQuery: '@href', isPermanentId: true});

Widgets

LabelQueryWidget

A number of widgets are obsolete with the introduction of the LabelQueryWidget. Replace them accordingly:

createAttributeLabelWidget:

We are aware of a known issue in Fonto Editor 7.12.0 where the deprecation warning for createAttributeLabelWidget is thrown from the platform code of Fonto Editor.

If you see the message "createAttributeLabelWidget is deprecated and will be removed in 7.14. Please use the createLabelQueryWidget instead. See https://documentation.fontoxml.com/editor/latest/upcoming-deprecations-7-14-33444398.html for more information.", perform a manual search through your editor for "createAttributeLabelWidget" and replace occurrences as described below.

JavaScript

// Before
createAttributeLabelWidget('title')
// After:
createLabelQueryWidget('@title', { inline: true })

JavaScript

// Before
createAttributeLabelWidget('title', {
	prefix: '[',
	suffix: ']',
	defaultValue: '(no title)'
})
// After:
createLabelQueryWidget('(@title, "(no title)")[1]', {
	inline: true,
	prefixQuery: '"["',
	suffixQuery: '"]"'
})

createBulletingWidget:

JavaScript

// Before
createBulletingWidget('-')
// After:
createLabelQueryWidget('"-"')

RelatedNodesQueryWidget

createRelatedNodesWidget:

JavaScript

// Before
createRelatedNodesWidget('self::fn')
// After:
createRelatedNodesQueryWidget('descendant::fn => outermost()')

Overriding operations, actions and transforms

Overriding operations, actions and transforms trigger a warning. It will trigger an error starting from the 7.14 release. For every operation, action or transform that causes these errors, find out why the override happens and find a public API to do the same.

Rebasing forked table flow packages

The table implementations for .fontoxml-table-flow-cals, fontoxml-table-flow-xhtml, fontoxml-table-flow-tei and fontoxml-table-flow-basic are open source to allow others to fork them to make improvements. In recent releases, we have improved the performance of our versions a lot. Please rebase your local version. If you have made changes to your version, consider to pull-request them. If those changes are integrated, we will maintain those changes so that you can use the version that is supported by the platform.