Panoramica dell’editor di SPA

Le applicazioni a pagina singola (SPA) possono offrire esperienze coinvolgenti agli utenti di siti web. Gli sviluppatori desiderano essere in grado di creare siti utilizzando framework SPA e gli autori desiderano modificare i contenuti all’interno di AEM per un sito creato utilizzando tali frameworks.

L’editor di SPA offre una soluzione completa per il supporto di SPA in AEM. Questa pagina offre una panoramica di come è strutturato il supporto SPA in AEM, come funziona l’editor di SPA e come il framework SPA mantiene la sincronizzazione con AEM.

Introduzione

I siti costruiti utilizzando framework SPA comuni come React e Angular caricano il contenuto tramite JSON dinamico e non forniscono la struttura di HTML necessaria affinché l’editor pagina di AEM possa inserire controlli di modifica.

Per abilitare la modifica delle SPA all’interno di AEM, è necessaria una mappatura tra l’output JSON della SPA e il modello di contenuto nell’archivio AEM per salvare le modifiche al contenuto.

Il supporto SPA in AEM introduce un livello JS sottile che interagisce con il codice JS SPA caricato nell’Editor pagina con cui è possibile inviare eventi e attivare la posizione dei controlli di modifica per consentire la modifica nel contesto. Questa funzione si basa sul concetto di endpoint API di Content Services, in quanto il contenuto dell’SPA deve essere caricato tramite Content Services.

Per ulteriori dettagli su SPA in AEM, consulta i seguenti documenti:

Design

Il componente pagina per una SPA non fornisce gli elementi HTML dei suoi componenti figlio tramite il file JSP o HTL. Questa operazione è delegata al framework SPA. La rappresentazione dei componenti o del modello figlio viene recuperata come struttura dati JSON dal JCR. I componenti SPA vengono quindi aggiunti alla pagina in base a tale struttura. Questo comportamento differenzia la composizione iniziale del corpo del componente della pagina dalle controparti non SPA.

Gestione dei modelli di pagina

La risoluzione e la gestione del modello di pagina sono delegate a una libreria PageModel. La SPA deve utilizzare la libreria Modello di pagina per essere inizializzata e creata dall’editor di SPA. La libreria Modello di pagina fornita indirettamente al componente Pagina AEM tramite l’npm aem-react-editable-components. Il Modello di pagina è un interprete tra AEM e SPA e quindi deve essere sempre presente. Quando si crea la pagina, deve essere aggiunta una libreria addizionale cq.authoring.pagemodel.messaging per abilitare la comunicazione con l’editor pagina.

Se il componente pagina SPA eredita dal componente core della pagina, sono disponibili due opzioni per rendere la categoria libreria client cq.authoring.pagemodel.messaging disponibile:

  • Se il modello è modificabile, aggiungilo al criterio della pagina.
  • Oppure aggiungi le categorie utilizzando il customfooterlibs.html.

Per ogni risorsa nel modello esportato, la SPA mappa un componente effettivo che esegue il
rendering. Viene quindi eseguito il rendering del modello, rappresentato come JSON, utilizzando le mappature dei componenti all’interno di un contenitore.

Mappatura di modelli e componenti in SPA

ATTENZIONE

L’inclusione della categoria cq.authoring.pagemodel.messaging deve essere limitata al contesto dell’editor di SPA.

Tipo di dati di comunicazione

Quando viene aggiunta la categoria cq.authoring.pagemodel.messaging alla pagina, invia un messaggio all’editor pagina per stabilire il tipo di dati di comunicazione JSON. Quando il tipo di dati di comunicazione è impostato su JSON, le richieste di GET comunicheranno con i punti finali del modello Sling di un componente. Dopo che si verifica un aggiornamento nell’editor di pagine, la rappresentazione JSON del componente aggiornato viene inviata alla libreria Modello di pagina. La libreria Modello di pagina informa quindi la SPA degli aggiornamenti.

Comunicazione SPA

Flusso di lavoro

È possibile comprendere il flusso dell’interazione tra SPA e AEM pensando all’editor di SPA come mediatore tra i due.

  • La comunicazione tra l’editor di pagine e la SPA viene effettuata utilizzando JSON invece di HTML.
  • L’editor di pagina fornisce alla SPA la versione più recente del modello di pagina tramite l’API iframe e messagistica.
  • Il gestore dei modelli di pagina notifica all’editor che è pronto per essere modificato e trasmette il modello di pagina come struttura JSON.
  • L’editor non modifica né accede nemmeno alla struttura DOM della pagina in fase di creazione, ma fornisce l’ultimo modello di pagina.

Flusso di lavoro SPA

Flusso di lavoro dell’editor di SPA di base

Tenendo presenti gli elementi chiave dell’editor di SPA, il flusso di lavoro di alto livello per la modifica di una SPA in AEM viene visualizzato dall’autore come segue.

Flusso di lavoro SPA animato

  1. Viene caricato l’editor di SPA.
  2. SPA viene caricato in un frame separato.
  3. SPA richiede contenuti JSON ed esegue il rendering dei componenti lato client.
  4. L’editor di SPA rileva i componenti renderizzati e genera sovrapposizioni.
  5. L’autore fa clic su sovrapponi e visualizza la barra degli strumenti di modifica del componente.
  6. L’Editor SPA mantiene le modifiche con una richiesta POST al server.
  7. L’editor SPA richiede JSON aggiornato all’editor SPA, che viene inviato alla SPA con un evento DOM.
  8. La SPA riesegue il rendering del componente interessato, aggiornandone il DOM.
NOTA

Nota bene:

  • Alla SPA è sempre affidata la sua visualizzazione.
  • L’Editor SPA è isolato dalla SPA stessa.
  • Nella produzione (pubblicazione), l’editor SPA non viene mai caricato.

Flusso di lavoro client-server di modifica delle pagine

Questa è una panoramica più dettagliata dell’interazione client-server durante la modifica di una SPA.

Flusso di lavoro client-server di modifica

  1. La SPA si inizializza e richiede il modello di pagina a Sling Model Exporter.

  2. Sling Model Exporter richiede le risorse che compongono la pagina dall’archivio.

  3. L’archivio restituisce le risorse.

  4. Sling Model Exporter restituisce il modello della pagina.

  5. La SPA crea un’istanza dei suoi componenti in base al modello di pagina.

  6. 6a Il contenuto informa l’editor che è pronto per l’authoring.

    6b L’editor pagina richiede le configurazioni di authoring dei componenti.

    6c L’editor pagina riceve le configurazioni dei componenti.

  7. Quando l’autore modifica un componente, l’editor pagina pubblica una richiesta di modifica al POST servlet predefinito.

  8. La risorsa viene aggiornata nell’archivio.

  9. La risorsa aggiornata viene fornita al POST servlet.

  10. Il POST servlet predefinito informa l’editor pagina che la risorsa è stata aggiornata.

  11. L’editor pagina richiede il nuovo modello di pagina.

  12. Le risorse che compongono la pagina sono richieste all’archivio.

  13. Le risorse che compongono la pagina vengono fornite dall’archivio a Sling Model Exporter.

  14. Il modello di pagina aggiornato viene restituito all’editor.

  15. L’editor pagina aggiorna il riferimento al modello di pagina della SPA.

  16. La SPA aggiorna i suoi componenti in base al riferimento al nuovo modello di pagina.

  17. Le configurazioni dei componenti degli editor pagina vengono aggiornate.

    17a La SPA segnala all’editor pagina che il contenuto è pronto.

    17b L’editor pagina fornisce alla SPA le configurazioni dei componenti.

    17c La SPA fornisce le configurazioni dei componenti aggiornate.

Flusso di lavoro di authoring

Questa è una panoramica più dettagliata incentrata sull’esperienza di authoring.

Flusso di lavoro di authoring SPA

  1. La SPA recupera il modello di pagina.

  2. 2a Il modello di pagina fornisce all’editor i dati necessari per l’authoring.

    2b Quando viene notificata, il componente di orchestrazione aggiorna la struttura del contenuto della pagina.

  3. L’orchestratore dei componenti esegue una query della mappatura tra un tipo di risorsa AEM e un componente SPA.

  4. L’orchestratore dei componenti crea un’istanza dinamica del componente SPA in base al modello di pagina e alla mappatura dei componenti.

  5. L’editor pagina aggiorna il modello di pagina.

  6. 6a Il modello di pagina fornisce dati di authoring aggiornati all’editor pagina.

    6b Il modello di pagina invia le modifiche all’orchestratore dei componenti.

  7. L’orchestratore dei componenti recupera la mappatura dei componenti.

  8. L’orchestratore dei componenti aggiorna il contenuto della pagina.

  9. Quando la SPA completa l’aggiornamento del contenuto della pagina, l’editor pagina carica l’ambiente di authoring.

Requisiti e limitazioni

Per consentire all’autore di utilizzare l’editor pagina per modificare il contenuto di una SPA, la tua applicazione SPA deve essere implementata per interagire con l’SDK dell’editor SPA di AEM. Leggi la documentazione Guida introduttiva alle SPA in AEM utilizzando React per apprendere gli elementi essenziali per far funzionare le tue SPA.

Framework supportati

L’SDK per l’editor di SPA supporta le seguenti versioni minime:

  • React 16.x e versioni successive
  • Angular 6.x e versioni successive

Le versioni precedenti di questi framework possono funzionare con l’SDK dell’editor di SPA di AEM, ma non sono supportate.

Framework aggiuntivi

Puoi implementare altri framework SPA per lavorare con l’SDK dell’editor di SPA di AEM. Vedi il documento Blueprint SPA per i requisiti che un framework deve soddisfare per creare un livello specifico del framework composto da moduli, componenti e servizi per lavorare con l’editor di SPA di AEM.

Utilizzo di più selettori

È possibile definire e utilizzare selettori personalizzati aggiuntivi come parte di una SPA sviluppata per l’SDK di SPA di AEM. Tuttavia, questo supporto richiede che il model selettore sia il primo e l’estensione sia .json come richiesto dall’esportatore JSON.

Requisiti dell’editor di testo

Se desideri utilizzare l’editor locale di un componente di testo creato in SPA è necessaria una configurazione aggiuntiva.

  1. Imposta un attributo (può essere qualsiasi) sull’elemento wrapper del contenitore contenente il testo HTML. Nel caso del progetto WKND per SPA, è un elemento <div> e il selettore utilizzato è data-rte-editelement.
  2. Imposta la configurazione editElementQuery sul componente di testo AEM corrispondente cq:InplaceEditingConfig che punta a tale selettore, ad esempio, data-rte-editelement. Questo consente all’editor di sapere quale elemento HTML si applica al testo di HTML.

Per ulteriori informazioni sulla proprietà editElementQuery e la configurazione dell’editor Rich Text, vedi Configura l’editor Rich Text.

Limitazioni

L’SDK dell’editor di SPA di AEM è completamente supportato da Adobe e continua a essere migliorato ed esteso. Le seguenti funzioni di AEM non sono ancora supportate dall’editor di SPA:

  • Modalità di destinazione
  • ContextHub
  • Modifica delle immagini in linea
  • Modifica le configurazioni (ad esempio ascoltatori)
  • Annulla/Ripeti
  • Differenze tra pagine e alterazione ora
  • Funzionalità che eseguono la riscrittura sul lato server di HTML, come Link Checker, servizio di rewriter CDN, accorciamento degli URL, ecc.
  • Modalità sviluppatore
  • Lanci AEM

In questa pagina