Was this page helpful?

Extending and customizing Compose

App framework support

You can install Marketplace apps and custom apps in your space to customize the editing experience and integrate with other services.

Currently Compose only supports a subset of App Locations.

The following table shows the support status for the App Locations:

App Location Status
App Configuration Not supported
Page Not supported
Dialogue Supported
Entry Editor Not supported
Entry Field Supported
Entry Sidebar Not supported
No support for UI Extensions
UI Extensions are not supported in Compose.If you need custom Entry Field editors then you should consider to migrate your UI Extension into an app.

App SDK support

Not all the App SDK methods are available in Compose.

The following table displays the SDK methods which are not supported (grouped by namespace):

NamespaceMethodsStatus
sdk.navigator openNewEntry doesn't open new entry in slideIn editor but only creates a new entry
openEntry doesn't open the entry in slideIn editor but in a new window instead
openPageExtension
openCurrentAppPage
openBulkEditor
openAppConfig
not implemented: calls to these methods are ignored
sdk.space createContentType
deleteContentType
getPublishedEntries
getPublishedAssets
getEntityScheduledActions
getAllScheduledActions
not supported

Extending the Compose content models with custom fields

It's possible to extend the "Compose: Page" and "Compose: SEO" content types with custom non-reference fields. Field types that link to other entries or assets are not supported: Reference, Media and Rich text fields. If you need to include any of the non-supported fields to your page, you could consider adding these field types to your page types.

Localizing pages

Compose supports field-level and entry-level localization of page content via the locale selector at the top of the page editor. Localization for media fields is not supported, so these fields are always treated as non-localized, allowing to see and edit only the default locale’s values.

Non-localized fields are always displayed in the default locale, regardless of the selected locale. If the selected locale is different from the default one, a label is also displayed next to those fields, showing their respective locale.

Supported localization patterns and best practices

Avoid relying on required fields for localizing content. This can create a possible issue where localized required fields block publishing of an entry if that entry has not been referenced to a locale. (This is more likely to happen if you use reference fields for region-specific content). For this reason, we also recommend always enabling "Allow empty fields for this locale" when adding or editing locales.

For more about localization, see our guide on localization and read more about field-level vs entry-level localization.

If an entry has field validation errors in a locale where the entry isn't linked (i.e. the entry doesn't show up if you select that locale) those fields will be displayed when trying to publish the page. This allows the user to fix the issue in an otherwise unreachable value.

Compose dead path error duplicate video ID