Example extensions

To help you develop your own extensions, we've included some examples covering a range of use cases in our GitHub repository. These extensions are just included as a guide to give you some ideas about the kind of extensions you can create. If you have any questions about using any of the example extensions, just raise an issue in the extension's GitHub repository.

There's also a curated list of awesome UI extensions for Dynamic Content.

Content field extensions

Content field extensions extend the functionality of the content form. We've included some example extensions on GitHub and you can register these on your hub or use the code as the basis for your own extensions.

Generative rich text editor extension

This extension replaces the built in rich text editor with a customizable editor that features embeddable content items, enhanced markdown support and a ChatGPT powered AI assistant.

The AI assistant helps improve your content production and editing workflow, and lets you generate and edit content using natural language. You might want to use it to get some inspiration to start a blog post, for example, or to rewrite text in a different style, or shorten text to match a word count, there are many possible uses.

This extension was written in TypeScript and uses the React framework.

Find it on GitHub.

Using the generative rich text editor extension

When you create some content that uses the extension, the AI prompt icon is shown in the toolbar as shown in the image below. When clicking the icon, the AI Assistant dialog is shown and from here you can enter a natural language prompt which is sent to ChatGPT. In this example we're asking the assistant to write a blog post about hats. We can then use this text as a starting point for our own blog.

A blog called "The Power of Hats" is generated and added to the rich text field in the content form. When you select some text you'll notice some shortcuts at the bottom of the text field. You can choose a shortcut to improve, shorten or expand the selected text.

You can also enter your own prompt to rewrite the post in a certain number of characters or a certain style, for example. You can also add your own shortcuts.

Configuration

To use the AI assistant feature you'll need an OpenAI account and then create a API key and add it to installation parameters for the extension. See generative rich text extension configuration on the GitHub repo for more details.

note

ChatGPT is not affiliated with Amplience and therefore any impact to ChatGPT services such as updates, busy periods, or outages are outside of Amplience control. By using this feature, you are solely responsible for ensuring that AI generated content complies with internal company policies, applicable laws and OpenAI's Terms.

There's a schema example for the generative rich text editor which is set up so that, if you choose to use the AI assistant features, all you need to do is add your OpenAI API key.

Troubleshooting

The AI assistant dialog is not opened when you click the icon

• Check that your OpenAI API Key has been added to the extensions's installation parameters for a registered extension, or in the parameters section of the property of the schema that uses the extension. See the generative rich text extension configuration for full details.

• Verify that your OpenAI key has sufficient credit. You may need to open a paid OpenAI account to ensure that you have sufficient credits to continue to make requests.

The OpenAI prompt icon is not displayed in the toolbar

If you have set up a custom toolbar layout, you will need to add the AI icon to the icon list. See the note about custom toolbar layouts in the GitHub read me.

AI alt text generator extension

This extension saves you time by using the power of AI to automatically generate alt text (text descriptions) for images. Alt text is used by screen reading software to describe the image to visually impaired users. It's also used by search engines when your website is crawled and helps to improve your search ranking. Including alt text with all images improves the user experience for all users because if an image fails to load, then the image description is displayed in place of the image rather than just a blank space.

Find it on GitHub.

Using the extension

To use the extension you need to create a content type schema that contains an image and a string property to contain the image alt text. The alt text property is configured to use the extension and includes a reference to the image property for which the alt text will be generated.

An example of content created using the extension is shown below. An image is added to the content item and the content is saved. The AI alt text button is now highlighted.

When the button is clicked, an image description is generated by the AI alt text service and added to the alt text field. In this example it identifies that the image shows a woman in a pink jacket standing against a white backdrop.

If you change the image, just click the button again to generate new alt text.

Schema example

There's a schema example that's set up to use the AI alt text generator extension. All you need to do is follow the instructions to register the extension.

Usage notes

• This extension can only be used on hubs that are linked to an organization. If you use the extension on a hub that has not been migrated to roles based permissions, then the AI assistant button will not be highlighted
• There is a limit of 50 generated captions per organization per day
• Content must be saved before the AI alt text button is enabled

note

This extension is classified as a labs preview, intended to demonstrate AI capabilities and to gather feedback. It is provided for use as is and without support or warranty. To provide feedback you can raise an issue in its GitHub repository.

Image transformation extension

The image transformation extension makes it easy for a user to apply Dynamic Media parameters to an image by choosing options in the user interface. The selected parameters are saved with the content item and can be used by your rendering code to transform the image on the fly using Dynamic Media.

This extension was developed using the Angular framework.

Find it on GitHub.

Product selector extension

This extension shows you how you can search for and retrieve product information from a Salesforce Commerce Cloud, SAP® Commerce Cloud or commercetools account and add it to a content item.

This extension was developed using the React framework.

Find it on GitHub.

Translation extension

The translate extension shows you how you can connect a translation service (the example uses Yandex) to provide automatic translation of strings into multiple languages. The extension is designed for use with a content item that uses field level localized strings.

This extension was written using the React framework.

Find it on GitHub.

Map extension

This extension makes it easy to search for and add a location to your content using Google Maps. In order to use the extension you'll need a Google Maps API key.

This extension was written using the React framework.

Find it on GitHub.

Brand colours extension

This extension ensures that you can select from colours that are part of your branding. Your brand colours are defined in the extension parameters.

This extension was written in TypeScript and uses the Angular framework.

Find it on GitHub.

Date time picker extension

The date time picker allows users to choose a date and time to be output as a string or a number.

This extension was written in JavaScript and uses the Svelte framework.

Find it on GitHub.

Personify XP extension

Personify XP is an anonymous personalization and analytics engine that enables you to predict visitor goals and display the most relevant content. The Personify XP content field extension integrates with the Personify XP API and can be configured to allow content to be categorized by behaviours or tags, and display a content relevance score. This helps you decide what content to create and which groups to target that content to.

We’ve included an example web app and some sample content type schemas to demonstrate the display of a personalised hero banner. The example also includes a visualization that allows you to select tags and behaviours and preview how the personalized content will display to different users.

Find it on GitHub. There is also a front end example showing the extension in use.

Hierarchy chooser extension

The hierarchy chooser extension allows users to browse and add content items from a hierarchy rather than having to find these items in the Content Library.

This extension was written using TypeScript and uses the Vue framework.

Find it on GitHub.

Shoppable image extension

This extension allows users to define Focal Points and interactive Hotspots (including Polygon Hotspots) over an image used in a content item. The functionality provided by this extension is similar to that of the POI (Point of Interest) app in Content Hub, but with the data being stored on a content item instead of an asset. Once registered, this extension is available to users when editing a content item in Dynamic Content.

The example image below illustrates how a few regions of an image have been highlighted with polygon hotspots. As shown in the image, there is a point of interest centered on the camera, and a hotspot placed on top of a watch.

This extension was written using TypeScript and the React framework.

Find it on GitHub.

Shoppable video extension

This extension allows users to enrich a video with moving interactive hotspots, and associated call-to-action buttons that can be clicked as the video plays. Once registered, this extension is available to users when editing a content item in Dynamic Content.

This extension was written using TypeScript and the Angular framework.

Find it on GitHub.

Help extension

The help extension allows you to add expandable text (in markdown format) to any content type. You can use this to provide more information about how to create content using this content type.

This extension was written using TypeScript.

Find it on GitHub.

DOM (Document Object Model) Editor extension

The DOM Editor extension allows content authors to create and edit a hierarchy of components to structure their content in an abstract manner, for use in a Document Object Model. The DOM Editor allows users to easily drag and drop components to build up a content form, while quickly seeing the result of their changes.

The DOM Editor is particularly useful for working with content forms comprising many small components wrapped into multiple larger content items, because specific items can be easily located within a content form.

Slots and components must be configured for a content type schema, specifying which components are permitted within which slots, and which slots are permitted within which components – allowing nested content to as many levels as required.

Note, components are configurable and you don’t have to set values for them, instead they can be used simply to make published content behave in a specific way.

This extension was written using Typescript and the React framework.

Find the code and configuration details on GitHub.

Dashboard extensions

Dashboard extensions are web apps that extend the functionality of the dashboard. You can install the Google Analytics and kanban extensions, or use the code included on GitHub as the basis for your own extensions.

Google Analytics extension

The Google Analytics dashboard extension is an analytics dashboard with events reports for content, editions and slots.

Find the code and configuration details on GitHub.

Kanban extension

The kanban extension that uses content item statuses to help you visualize content in progress. You can use these dashboard extensions without modification, or use them as the the basis for your own extensions.

Find the code and configuration details on GitHub.

In order to use the kanban extension you will need to specify the ids of up to 3 content item statuses defined on your hub. You can find these ids using the workflow states end point in the Dynamic Content Management API.

Deep copy extension

This extension allows users to make a deep copy of a content item including all of its dependencies. There is the option to automatically rename future copies, by using the Rename feature to specify a prefix. Alternatively, each copied items can be renamed individually. Users will see a validation status for each dependency of the selected content item.

This extension was written using TypeScript and the React framework.

Find the code and configuration details on GitHub.

GlobalLink Connect extension

GlobalLink Connect streamlines translation processes by connecting your back-end systems with Translations.com translation services, and removes the need for traditional manual file export, cutting and pasting. Our GlobalLink Connect dashboard extension provides a seamless interface to GlobalLink Connect, allowing content producers in Dynamic Content to easily submit content for translation, monitor the translation status, and to apply completed translations to localized content items.

This extension was written using Typescript and the React framework.

Find the code and configuration details on GitHub.

Related pages

Extensions overview

Registering extensions

Curated list of awesome extensions