Aperçu de l’éditeur d’application d’une seule page

Les applications d’une seule page (SPA) peuvent améliorer considérablement l’expérience des utilisateurs de sites web. Le souhait des développeurs est de pouvoir créer des sites avec des structures SPA. Les auteurs, pour leur part, souhaitent modifier facilement du contenu dans AEM pour un site conçu à l’aide de telles structures.

L’éditeur de SPA constitue une solution complète pour la prise en charge des SPA dans AEM. Cette page fournit un aperçu de la structure de la prise en charge des SPA dans AEM, du fonctionnement de l’éditeur de SPA et de la synchronisation entre la structure SPA et AEM.

Remarque

L’éditeur SPA est la solution recommandée pour les projets qui nécessitent un rendu côté client SPA structure (par exemple, Réagir ou Angulaire).

Présentation

Les sites créés à l’aide de structures SPA courantes, telles que React et AngularJS, chargent leur contenu via le format JSON dynamique et ne fournissent pas la structure HTML dont l’éditeur de page AEM a besoin pour passer des commandes de modification.

Pour activer la modification d’applications d’une seule page dans AEM, il faut qu’il y ait une correspondance entre la sortie JSON de l’application et le modèle de contenu dans le répertoire AEM afin d’enregistrer les modifications apportées au contenu.

La prise en charge des applications d’une seule page dans AEM s’accompagne d’une fine couche JS qui interagit avec le code JS de l’application lorsqu’elle est chargée dans l’éditeur de pages avec lequel des événements peuvent être envoyés. L’emplacement des commandes d’édition peut être activé pour permettre une modification en contexte. Cette fonction repose sur le concept de point de terminaison de l’API Content Services, étant donné que le contenu de l’application d’une seule page doit être chargé par le biais de Content Services.

Pour de plus amples informations sur les SPA dans AEM, consultez les documents suivants :

Concevoir

Le composant de page d’une application d’une seule page ne fournit pas les composants HTML de ses composants enfants via le fichier HTL ou JSP. Cette opération est déléguée à la structure SPA. La représentation des composants ou du modèle enfant est récupérée en tant que structure de données JSON à partir du JCR. Les composants SPA sont ensuite ajoutés à la page en fonction de cette structure. Ce comportement permet de différencier la composition initiale du corps du composant de page à partir d’équivalents non SPA.

Gestion du modèle de page

The resolution and the management of the page model is delegated to a provided PageModel library. Le SPA doit utiliser la bibliothèque de modèles de page pour être initialisé et écrit par l'éditeur SPA. La bibliothèque de modèle de page est fournie indirectement au composant de page AEM via le npm aem-react-editable-components. Le modèle de page est un interpréteur entre AEM et l’application d’une seule page. Par conséquent, elle doit toujours être présente. Lorsque la page est créée, une bibliothèque supplémentaire cq.authoring.pagemodel.messaging doit être ajoutée afin de permettre la communication avec l’éditeur de page.

Si le composant de page SPA hérite du composant principal de la page, deux options sont possibles pour faire en sorte que la catégorie de la bibliothèque cliente cq.authoring.pagemodel.messaging soit disponible :

  • Si le modèle est modifiable, ajoutez-le à la stratégie de page.
  • Vous pouvez également ajouter les catégories via customfooterlibs.html.

Pour chaque ressource du modèle exporté, le SPA mappe un composant réel qui effectue le rendu. Le modèle, représenté sous la forme JSON, est ensuite rendu à l’aide des mappages de composants au sein d’un conteneur.
screen_shot_2018-08-20at144152

ATTENTION

The inclusion of the cq.authoring.pagemodel.messaging category should be limited to the context of the SPA Editor.

Type de données de communication

When the cq.authoring.pagemodel.messaging category is added to the page, it will send a message to the Page Editor to establish the JSON communication data type. Lorsque le type de données de communication est défini sur JSON, les requêtes GET communiquent avec les points de terminaison du modèle Sling d’un composant. À la suite d’une mise à jour dans l’éditeur de page, la représentation JSON du composant mis à jour est envoyée à la bibliothèque modèle de page. Celle-ci informe ensuite l’application d’une seule page des mises à jour.

screen_shot_2018-08-20at143628

Workflow

Vous pouvez comprendre le flux de l'interaction entre le SPA et l'AEM en voyant l'éditeur de SPA comme un médiateur entre les deux.

  • La communication s’effectue au format JSON au lieu du format HTML.
  • L’éditeur de page fournit la dernière version du modèle de page à l’application d’une seule page par le biais de l’API de messagerie et de l’iFrame.
  • Le gestionnaire de modèles de pages informe l’éditeur qu’il est prêt pour le montage et transmet le modèle de page sous la forme d’une structure JSON.
  • L’éditeur ne modifie pas la structure DOM de la page en cours de création ; en fait, il n’y accède même pas. Au lieu de cela, il fournit le modèle de page le plus récent.

screen_shot_2018-08-20at144324

Processus de l’éditeur de SPA de base

En gardant à l’esprit les éléments clés de l’éditeur SPA, la procédure générale de modification d’un SPA au sein d’un AEM s’affiche comme suit pour l’auteur.

untitled1

  1. SPA Editeur charge.
  2. SPA est chargé dans un cadre distinct.
  3. SPA demande du contenu JSON et effectue le rendu des composants côté client.
  4. SPA Editor détecte les composants rendus et génère des incrustations.
  5. L’auteur clique sur l’incrustation et affiche la barre d’outils de modification du composant.
  6. SPA Editor conserve les modifications avec une requête de POST envoyée au serveur.
  7. SPA Editor demande la mise à jour de JSON à SPA Editor, qui est envoyé au SPA avec un Événement DOM.
  8. SPA restitue le composant concerné, en mettant à jour son DOM.
Remarque

Gardez à l’esprit :

  • Le SPA est toujours responsable de son affichage.
  • L'éditeur SPA est isolé de la SPA elle-même.
  • En production (publication), l’éditeur SPA n’est jamais chargé.

Processus de montage de page client-serveur

Il s’agit d’un aperçu plus détaillé de l’interaction client-serveur lors de la modification d’un SPA.

page_editor_spa_authingmediator-2

  1. L’application d’une seule page s’initialise et demande le modèle auprès de l’exportateur de modèle Sling.

  2. À son tour, l’exportateur demande au référentiel les ressources qui composent la page.

  3. Le référentiel renvoie alors les ressources demandées.

  4. L’exportateur de modèle Sling renvoie le modèle de la page.

  5. L’application d’une seule page instancie ses composants sur la base du modèle de page.

  6. 6a Le contenu informe l’éditeur qu’il est prêt pour la création.

    6b L’éditeur de page demande les configurations de création du composant.

    6c L’éditeur de page reçoit les configurations de composant.

  7. Lorsque l’auteur modifie un composant, l’éditeur de page envoie une demande de modification au servlet POST par défaut.

  8. La ressource est mise à jour dans le référentiel.

  9. La ressource mise à jour est fournie au servlet POST.

  10. Le servlet POST par défaut informe l’éditeur de page que la ressource a été mise à jour.

  11. L’éditeur de page demande le nouveau modèle de page.

  12. Les ressources qui composent la page font l’objet d’une demande auprès du référentiel.

  13. Les ressources qui composent la page sont fournies à l’exportateur de modèle Sling par le référentiel.

  14. Le modèle de page mis à jour est renvoyé à l’éditeur.

  15. L’éditeur de page met à jour la référence de modèle de page de l’application d’une seule page.

  16. L’application d’une seule page met à jour ses composants en fonction de la nouvelle référence de modèle de page.

  17. Les configurations de composant des éditeurs de page sont mises à jour.

    17a L’application d’une seule page signale à l’éditeur de page que le contenu est prêt.

    17b L’éditeur de page fournit les configurations de composant à l’application d’une seule page.

    17c L’application d’une seule page fournit des configurations de composant mises à jour.

Processus de création

Il s’agit d’un aperçu plus détaillé axé sur l’expérience de création.

spa_content_authingmodel

  1. L’application d’une seule page récupère le modèle de page.

  2. 2a Le modèle de page fournit à l’éditeur les données requises pour la création.

    2b Une fois informé, l’orchestrateur de composants met à jour la structure de contenu de la page.

  3. L’orchestrateur de composants interroge le mappage entre le type de ressource AEM et un composant SPA.

  4. L’orchestrateur de composants instancie, de manière dynamique, le composant SPA sur la base du mappage entre le modèle de page et le composant.

  5. L’éditeur de page met à jour le modèle de page.

  6. 6a Le modèle de page fournit des données de création mises à jour à l’éditeur de page.

    6b Le modèle de page distribue les modifications à l’orchestrateur de composants.

  7. L’orchestrateur de composants récupère le mappage de composant.

  8. L’orchestrateur de composants met à jour le contenu de la page.

  9. Une fois que l’application d’une seule page a terminé la mise à jour du contenu de la page, l’éditeur de page charge l’environnement de création.

Conditions requises et limites

Pour permettre à l’auteur d’utiliser l’éditeur de page pour modifier le contenu d’un SPA, votre application SPA doit être mise en oeuvre pour interagir avec le SDK de l’éditeur de . Veuillez consulter le guide Prise en main des SPA dans AEM document pour obtenir un minimum de connaissances nécessaires pour que le vôtre fonctionne.

Structures prises en charge

Le SDK SPA Editor prend en charge les versions minimales suivantes :

  • Réagir à 16.x et plus
  • Angular 6.x et supérieur

Les versions précédentes de ces structures peuvent fonctionner avec l’AEM SDK SPA Editor, mais ne sont pas prises en charge.

Cadres supplémentaires

Des structures SPA supplémentaires peuvent être mises en oeuvre pour fonctionner avec AEM SDK de l’éditeur SPA. Veuillez consulter le document SPA Plan directeur pour connaître les exigences qu'un cadre doit satisfaire pour créer une couche spécifique à un cadre composée de modules, de composants et de services pour travailler avec l'AEM Éditeur.

Utilisation de plusieurs sélecteurs

D’autres sélecteurs personnalisés peuvent être définis et utilisés dans le cadre d’un SPA développé pour AEM SDK. Toutefois, cette prise en charge requiert que le model sélecteur soit le premier sélecteur et que l’extension soit .json celle requise par l’exportateur JSON.

Exigences de l’éditeur de texte

Si vous souhaitez utiliser l’éditeur en place d’un composant de texte créé dans SPA, une configuration supplémentaire est requise.

  1. Définissez un attribut (il peut s’agir de n’importe quel attribut) sur l’élément wrapper de conteneur contenant le texte HTML. Dans le cas d’un exemple de contenu du Journal WKND, il s’agit d’un <div> élément et le sélecteur utilisé est data-rte-editelementcelui qui a été utilisé.
  2. Définissez la configuration editElementQuery du composant de texte AEM correspondant cq:InplaceEditingConfig qui pointe vers ce sélecteur, par ex. data-rte-editelement. Cela permet à l’éditeur de savoir quel élément HTML encapsule le texte HTML.

Pour un exemple de la façon dont cela est fait, voir l’exemple de contenu du Journal WKND.

Pour plus d’informations sur la editElementQuery propriété et la configuration de l’éditeur de texte enrichi, voir Configurer l’éditeur de texte enrichi.

Restrictions

L’AEM SPA Editor SDK a été introduit avec l’ 6.4 Service Pack 2. Il est entièrement soutenu par l'Adobe et, en tant que nouvelle fonctionnalité, il continue d'être amélioré et élargi. Les fonctionnalités AEM suivantes ne sont pas encore prises en charge par SPA Editor :

  • Mode cible
  • ContextHub
  • Modification des images intégrées
  • Modifier les configurations (ex. auditeurs)
  • Système de style
  • Annuler/rétablir
  • Différence de page et déformation temporelle
  • Fonctionnalités de réécriture HTML côté serveur telles que le vérificateur de liens, le service de réécriture CDN, le raccourcissement d’URL, etc.
  • Mode développeur
  • aem lancements

Sur cette page