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 RTE functionalities are enabled
- Which components can be added to a container
- Which assets can be added to a media type
- Which RTE functionalities are enabled
- Which components can be added to a container
- Which assets can be added to a media type
data-aue-labelDefines a custom label for a selectable item which is displayed in the editor
data-aue-modelDefines a model which is used for form-based editing in the properties panel
data-aue-behaviorObsolete. It once defined the behavior of an instrumentation to allow standalone text, richtext, and media to mimic components so they were also moveable and deletable on the page, offering a single potential value of
component. This property is now ignored and when an item with data-aue-resource is a direct child of a container it is automatically considered a component.Item Types item-types
data-aue-typeDescription
data-aue-resourcedata-aue-propdata-aue-filterdata-aue-labeldata-aue-modeltextText 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
richtextText is editable with full rich text capabilities. RTE is shown in the right panel
Optional
Required
n/a
Optional
n/a
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
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
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 panel and its fields
Required
n/a
n/a
Optional
Optional
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
data-aue-resource is always required since it is the primary key indicating where content changes are written.
- It is not required directly on the tag where the
data-aue-typeis set. - In case it is not set, the
data-aue-resourceattribute of a the nearest parent will be used.
data-aue-prop is required whenever you want to edit in context except for a container where it is optional (if set the container is a content fragment and the prop points to a multi-reference field).
- The
data-aue-propis the attribute to update for the primary key ofdata-aue-resource.
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab