Upgrade Instructions 9.0 → 9.1

Before making substantial changes, make sure you create a backup of the database and files!

If you have development packages in your composer manifest, update them to match as well:

Make sure to update every required Neos package to ~9.1.0! Otherwise there can be an error during updating, because of version conflicts.

After completing these steps, your package should be upgraded to the latest version of the Neos UI and ready to use. Thank you for using Neos!

Neos

The Workspace Ui comes with a new trash functionality. To enable the button you need to setup the content repository to create the new database tables and also boot the projection from its initial state 0.

./flow cr:setup
./flow subscription:replay Neos.Workspace.Ui:TrashBinProjection

Deprecation:

Legacy LinkEditor configuration / New LinkEditor

Following legacy options should be rewritten to use the declaration in linkTypes instead (see PropertyEditorReference). They will be upcasted at runtime if no new declaration in linkTypes is made. Using new and old syntax simultaneously will lead to old syntax being ignored fully.

• assets use linkTypes.Asset.enabled: false instead to disabled asset links
• nodes use linkTypes.Node.enabled: false instead to disabled asset links
• nodeTypes use linkTypes.Node.baseNodeType with a NodeType filter string instead
• startingPoint use linkTypes.Node.startingPoint instead
• placeholder obsolete finds no application in the new link editor can be safely removed

The anchor option for the inline editor to enable anchor support was removed. Instead anchors can be set via the "Advanced Options" to both Asset and Node links. For Web links the anchor is naturally part of the full link input at all times.

  inline:
    editorOptions:
      linking:
-       anchor: true
        title: true
        relNofollow: true
        targetBlank: true

Neos Ui Plugins
 

Formatting toolbar / CKEditor toolbar

With Neos Ui 9.1 we use the native CKEditor toolbar and ballon/context toolbar. For not only a unified look and feel but also to simplify plugins the new native CKEditor toolbar should be extended in plugins instead of the now legacy Neos formatting toolbar at the top. Eventually the place will no longer be reserved for old CKEditor plugins and freed to show new functionality.

As an example how the new toolbar can be used see the infamous hyphens plugin: Shel.Neos.Hyphens.

Old deprecated registry:

globalRegistry.get('ckEditor5').get('richtextToolbar')

The StyleSelect will be remove with Neos 10 please use CKEditor 5's built-in style dropdown instead:

richtextToolbar.get('style')

Accessing the FrontendConfigurationRegistry or {frontendConfiguration}

Accessing the Plugin frontend configuration via globalRegistry.set('frontendConfiguration') or {frontendConfiguration} in the bootstrap is deprecated please use the new package instead:

import {getFrontendConfigurationForPackage} from '@neos-project/neos-ui-configuration'

Example

Neos.Neos.Ui.frontendConfiguration offers an API for third party packages to deliver own settings to the UI at boot time. The Neos.Ui uses the ConfigurationProvider for its own static configuration. Settings from each package should be prefixed to avoid collisions:

 frontendConfiguration:
   'Your.Own:Package':
     someKey: someValue

Then it may be accessed via:

const {someKey} = getFrontendConfigurationForPackage('Your.Own:Package');

Accessing neos.configuration via @neos

Accessing the Neos Ui configuration via neos.configuration in react components or {configuration} in the bootstrap is deprecated please use the new package instead:

import {getConfiguration} from '@neos-project/neos-ui-registry'

Importing SynchronousRegistry

using the import is deprecated

import {SynchronousRegistry} from '@neos-project/neos-ui-extensibility'

please use the new package instead:

import {SynchronousRegistry} from '@neos-project/neos-ui-registry'

Other Neos Ui deprecations

- backend.get().endpoints.assetSearch()
- backend.get().endpoints.getJsonResource()
- selectors.CR.Nodes.getPathInNode()