Attributs et types

Découvrez les attributs et les types de données requis par l’éditeur universel.

Présentation

Pour que l’éditeur universel puisse modifier une application, cette dernière doit être correctement instrumentée. L’application doit inclure des métadonnées appropriées afin que l’éditeur puisse en modifier le contenu. Ce document décrit les attributs et les types de ces métadonnées.

REMARQUE

La validation du contenu se produit côté serveur. L’éditeur universel fonctionne simplement avec les attributs de données. La validation de leur adéquation au modèle/à la structure doit être traitée au niveau de l’API.

Propriétés des données

Propriété des données Description
itemid URN de la ressource : consultez la section Instrumenter la page du document Prise en main de l’éditeur universel dans AEM.
itemprop Attribut de la ressource : consultez la section Instrumenter la page du document Prise en main de l’éditeur universel dans AEM.
itemtype Type d’élément modifiable (par exemple, texte, image, référence, etc.).
data-editor-itemfilter Définit les références qui peuvent être utilisées.
data-editor-itemlabel Définit un libellé personnalisé pour un élément sélectionnable affiché dans l’éditeur.
Si itemmodel est défini, le libellé est récupéré via le modèle.
data-editor-itemmodel Définit un modèle qui sera utilisé pour la modification basée sur les formulaires dans le rail des propriétés.
data-editor-behavior Définit le comportement d’une instrumentation ; par exemple, un texte ou une image autonome peut également reproduire un composant pour qu’il puisse être modifié ou supprimé.

Types d’éléments

itemtype Description itemid itemprop data-editor-itemfilter data-editor-itemlabel data-editor-itemmodel data-editor-behvior
text Le texte est modifiable dans les balises HTML, mais uniquement dans un format de texte simple, sans mise en forme de texte enrichi. Ce format est généralement utilisé sur les composants de titre. Facultatif Requis n/a Facultatif n/a Facultatif
richtext Le texte est modifiable avec des fonctionnalités de texte enrichi complètes. L’éditeur de texte enrichi s’affiche dans le panneau de droite. Facultatif Requis n/a Facultatif n/a Facultatif
media L’élément modifiable est une ressource, par exemple une image ou une vidéo. Facultatif Requis Liste
facultative des critères de filtre d’image ou vidéo transmise au sélecteur de ressources.		 Facultatif n/a Facultatif
container L’élément modifiable se comporte comme un conteneur pour les composants, c’est-à-dire le système de paragraphe. Selon le cas
voir ci-dessous.		 Selon le cas
voir ci-dessous.		 Une liste
facultative des composants autorisés		 Facultatif n/a n/a
component L’élément modifiable est un composant. N’ajoute pas de fonctionnalités supplémentaires. Cela sera nécessaire pour indiquer les parties qui peuvent être déplacées/supprimées du DOM et pour ouvrir le rail de propriétés et ses champs. Requis n/a n/a Facultatif Facultatif n/a
reference L’élément modifiable est une référence : par exemple, un fragment de contenu, un fragment d’expérience ou un produit. Selon le cas
voir ci-dessous.		 Selon le cas
voir ci-dessous.		 Une liste
facultative des critères de filtre des fragments de contenu, des produits ou des fragments d’expérience transmise au sélecteur de références.		 Facultatif Facultatif n/a

Selon le cas d’utilisation, itemprop ou itemid peuvent être requis. Par exemple :

  • itemid est requis si vous interrogez des fragments de contenu via GraphQL et que vous souhaitez rendre la liste modifiable en contexte.
  • itemprop est requis si un composant effectue le rendu du contenu d’un fragment de contenu référencé et que vous souhaitez mettre à jour la référence dans le composant.

Comportements

data-editor-behavior Description
component Peut être utilisé pour permettre à un texte autonome, un texte enrichi et des médias de reproduire les composants afin qu’ils puissent être déplacés et supprimés sur la page.

Ressources supplémentaires

Pour en savoir plus sur l’éditeur universel, consultez ces documents.

Sur cette page