Attributes and Types attributes-types
Learn about the data attributes and item types that the Universal Editor requires.
Introduction introduction
In order for an app to be editable by the Universal Editor, it must be properly instrumented. This includes including the proper metadata so the editor can edit the content of the app. This document details the attributes and item types of those metadata.
NOTE
Content validation is performed on the server side. The Universal Editor simply works with the data attributes. Validation that they fit the model/structure must be addressed at the API level.
Data Properties data-properties
Data Property
Description
data-aue-resourceURN to the resource, see the section Instrument the Page of the document Getting Started with the Universal Editor in AEM
data-aue-propAttribute of the resource, see the section Instrument the Page of the document Getting Started with the Universal Editor in AEM
data-aue-typeType of the editable item (for example, text, image, and reference)
data-aue-filterDefines which references can be used
data-aue-labelDefines a custom label for a selectable item which is displayed in the editor
In case
In case
data-aue-model is set, the label is retrieved by way of the modeldata-aue-modelDefines a model which is used for form-based editing in the properties rail
data-aue-behaviorDefines the behavior of an instrumentation, for example, stand alone text or image can also mimic a component to make it moveable or deletable
Item Types item-types
data-aue-typeDescription
data-aue-resourcedata-aue-propdata-aue-filterdata-aue-labeldata-aue-modeldata-aue-behaviortextText is editable within the HTML tags, but only in simple text format, no rich text formatting available, this is commonly used on title components, for example
Optional
Required
n/a
Optional
n/a
Optional
richtextText is editable with full rich text capabilities. RTE is shown in the right panel
Optional
Required
n/a
Optional
n/a
Optional
mediaThe editable is an asset, for example, image or video
Optional
Required
Optional
list of image or video filter criteria which is passed on to the asset selector
list of image or video filter criteria which is passed on to the asset selector
Optional
n/a
Optional
containerThe editable behaves as container for components aka Paragraph System.
Depends
see below
see below
Depends
see below
see below
Optional
a list of allowed components
a list of allowed components
Optional
n/a
n/a
componentThe editable is a component. It doesn’t add additional functionality. It is required to indicate movable/deletable parts of the DOM and for opening the properties rail and its fields
Required
n/a
n/a
Optional
Optional
n/a
referenceThe editable is a reference, for example, Content Fragment, Experience Fragment or Product
Depends
see below
see below
Depends
see below
see below
Optional
list of Content Fragment, Product, or Experience Fragment filter criteria which is passed on to the reference selector
list of Content Fragment, Product, or Experience Fragment filter criteria which is passed on to the reference selector
Optional
Optional
n/a
Depending on the use case data-aue-prop or data-aue-resource may or may not be required. For example:
data-aue-resourceis required if you query Content Fragments via GraphQL and you want to make the list editable in-context.data-aue-propis required in case you have a component rendering the content of a referenced Content Fragment and you want to update the reference within the component.
Behaviors behaviors
data-aue-behaviorDescription
componentUsed to allow standalone text, richtext, and media mimic components so they are also moveable and deletable on the page
containerUsed to allow containers to be treated as their own components so they are movable and deletable on the page
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab