Modifica di uno SPA esterno in AEM

Quando si decide quale livello di integrazione desideri avere tra il tuo SPA esterno e il AEM, spesso devi essere in grado di modificare e visualizzare il SPA in AEM.

Panoramica

Questo documento descrive i passaggi consigliati per caricare un SPA autonomo in un’istanza AEM, aggiungere sezioni di contenuto modificabili e abilitare l’authoring.

Prerequisiti

I prerequisiti sono semplici.

  • Assicurati che un'istanza di AEM sia in esecuzione localmente.
  • Crea un progetto di base AEM SPA utilizzando AEM Project Archetype.
    • Questo costituirà la base del progetto AEM che verrà aggiornato per includere il SPA esterno.
    • Per i campioni di questo documento, utilizziamo il punto iniziale di il progetto WKND SPA.
  • Avere a portata di mano il React SPA funzionante ed esterno che si desidera integrare.

Carica SPA nel progetto AEM

Innanzitutto devi caricare il SPA esterno nel progetto AEM.

  1. Sostituisci src in /ui.frontend cartella di progetto con l'applicazione React src cartella.
  2. Includi eventuali dipendenze aggiuntive nel package.json in /ui.frontend/package.json file.
  3. Includi eventuali personalizzazioni nel /public cartella.
  4. Includi eventuali script o stili in linea aggiunti nel /public/index.html file.

Configurare la SPA remota

Ora che il SPA esterno fa parte del progetto AEM, deve essere configurato all’interno di AEM.

Includere Adobi SPA pacchetti SDK

Per sfruttare AEM funzionalità SPA, esistono dipendenze dai tre pacchetti seguenti.

@adobe/aem-spa-page-model-manager fornisce l'API per l'inizializzazione di un Model Manager e il recupero del modello dall'istanza AEM. Questo modello può quindi essere utilizzato per eseguire il rendering dei componenti AEM utilizzando le API di @adobe/aem-react-editable-components e @adobe/aem-spa-component-mapping.

Installazione

Esegui il seguente comando npm per installare i pacchetti richiesti.

npm install --save @adobe/aem-spa-component-mapping @adobe/aem-spa-page-model-manager @adobe/aem-react-editable-components

Inizializzazione di ModelManager

Prima del rendering dell’app, la ModelManager deve essere inizializzato per gestire la creazione del AEM ModelStore.

Questo deve essere fatto all'interno del src/index.js file dell'applicazione o ovunque venga eseguito il rendering della radice dell'applicazione.

A questo scopo, possiamo utilizzare initializationAsync API fornita da ModelManager.

La schermata seguente mostra come abilitare l'inizializzazione di ModelManager in una semplice applicazione React. L'unico vincolo è che initializationAsync deve essere chiamato prima ReactDOM.render().

Inizializza ModelManager

In questo esempio, la ModelManager viene inizializzato e un valore vuoto ModelStore viene creato.

initializationAsync può accettare facoltativamente un options oggetto come parametro:

  • path - All'inizializzazione, il modello nel percorso definito viene recuperato e memorizzato nel ModelStore. Può essere utilizzato per recuperare rootModel all'inizializzazione, se necessario.
  • modelClient - Consente di fornire un client personalizzato responsabile del recupero del modello.
  • model - A model oggetto passato come parametro generalmente popolato quando utilizzo di SSR.

AEM Componenti Foglia Autorizzati

  1. Crea/identifica un componente AEM per il quale verrà creato un componente React di authoring. In questo esempio, utilizziamo il componente testo del progetto WKND.

    Componente testo WKND

  2. Crea un semplice componente di testo React nel SPA. In questo esempio, un nuovo file Text.js è stato creato con il seguente contenuto.

    Text.js

  3. Crea un oggetto di configurazione per specificare gli attributi necessari per abilitare AEM modifica.

    Crea oggetto di configurazione

    • resourceType è obbligatorio per mappare il componente React al componente AEM e abilitare la modifica all’apertura nell’editor di AEM.
  4. Utilizzare la funzione wrapper withMappable.

    Usa conMappable

    Questa funzione di wrapper mappa il componente React al AEM resourceType specificata nella configurazione e abilita le funzionalità di modifica quando viene aperta nell’editor AEM. Per i componenti indipendenti, recupererà anche il contenuto del modello per il nodo specifico.

    NOTA

    In questo esempio sono disponibili versioni separate del componente: AEM componenti React con wrapping e senza wrapping. La versione con wrapping deve essere utilizzata quando si utilizza esplicitamente il componente . Quando il componente fa parte di una pagina, puoi continuare a utilizzare il componente predefinito come attualmente avviene nell’editor di SPA.

  5. Esegui il rendering del contenuto nel componente.

    Le proprietà JCR del componente testo vengono visualizzate come segue in AEM.

    Proprietà del componente testo

    Questi valori vengono passati come proprietà al nuovo creato AEMText Reagisce al componente e può essere utilizzato per eseguire il rendering del contenuto.

    import React from 'react';
    import { withMappable } from '@adobe/aem-react-editable-components';
    
    export const TextEditConfig = {
        // Empty component placeholder label
        emptyLabel:'Text',
        isEmpty:function(props) {
           return !props || !props.text || props.text.trim().length < 1;
        },
        // resourcetype of the AEM counterpart component
        resourceType:'wknd-spa-react/components/text'
    };
    
    const Text = ({ text }) => (<div>{text}</div>);
    
    export default Text;
    
    export const AEMText = withMappable(Text, TextEditConfig);
    

    Questo è il modo in cui il componente apparirà al termine delle configurazioni di AEM.

    const Text = ({ cqPath, richText, text }) => {
       const richTextContent = () => (
          <div className="aem_text" id={cqPath.substr(cqPath.lastIndexOf('/') + 1)} data-rte-editelement dangerouslySetInnerHTML={{__html: text}}/>
       );
       return richText ? richTextContent() : (<div className="aem_text">{text}</div>);
    };
    
    NOTA

    In questo esempio, sono state apportate ulteriori personalizzazioni al componente di cui è stato eseguito il rendering per farlo corrispondere al componente di testo esistente. Questo tuttavia non è correlato all’authoring in AEM.

Aggiungere componenti autorizzati alla pagina

Una volta creati i componenti React modificabili, possiamo utilizzarli in tutta l’applicazione.

Prendiamo una pagina di esempio in cui è necessario aggiungere un testo dal progetto WKND SPA. Per questo esempio, vogliamo visualizzare il testo "Hello World!" su /content/wknd-spa-react/us/en/home.html.

  1. Determinare il percorso del nodo da visualizzare.

    • pagePath: La pagina che contiene il nodo, nel nostro esempio /content/wknd-spa-react/us/en/home
    • itemPath: Percorso del nodo all'interno della pagina, nel nostro esempio root/responsivegrid/text
      • È costituito dai nomi degli elementi contenenti nella pagina.

    Percorso del nodo

  2. Aggiungi il componente nella posizione desiderata nella pagina.

    Aggiungi un componente alla pagina

    La AEMText può essere aggiunto nella posizione desiderata all’interno della pagina con pagePath e itemPath valori impostati come proprietà. pagePath è una proprietà obbligatoria.

Verifica della modifica del contenuto di testo in AEM

Ora possiamo testare il componente sulla nostra istanza AEM in esecuzione.

  1. Esegui il seguente comando Maven dal aem-guides-wknd-spa per creare e distribuire il progetto in AEM.
mvn clean install -PautoInstallSinglePackage
  1. Nell’istanza di AEM, passa a http://<host>:<port>/editor.html/content/wknd-spa-react/us/en/home.html.

Modifica del SPA in AEM

La AEMText Il componente è ora modificabile in AEM.

AEM pagine autorizzate

  1. Identifica una pagina da aggiungere per l’authoring nel SPA. Questo esempio utilizza /content/wknd-spa-react/us/en/home.html.

  2. Crea un nuovo file (ad es. Page.js) per il componente Pagina modificabile. In questo caso, è possibile riutilizzare il componente Pagina fornito in @adobe/cq-react-editable-components.

  3. Ripeti il passaggio 4 nella sezione AEM componenti foglia utilizzabili. Utilizzare la funzione wrapper withMappable sul componente.

  4. Come è stato fatto in precedenza, applica MapTo ai tipi di risorse AEM per tutti i componenti secondari all’interno della pagina.

    import { Page, MapTo, withMappable } from '@adobe/aem-react-editable-components';
    import Text, { TextEditConfig } from './Text';
    
    export default withMappable(Page);
    
    MapTo('wknd-spa-react/components/text')(Text, TextEditConfig);
    
    NOTA

    In questo esempio utilizziamo il componente di testo React senza wrapping invece del wrapping AEMText creato in precedenza. Questo perché quando il componente fa parte di una pagina/contenitore e non è stand-alone, il contenitore si occuperà della mappatura ricorsiva del componente e dell’abilitazione delle funzionalità di authoring; il wrapper aggiuntivo non è necessario per ogni elemento figlio.

  5. Per aggiungere una pagina di authoring nel SPA, segui gli stessi passaggi nella sezione . Aggiungere componenti modificabili alla pagina. Qui possiamo saltare la itemPath tuttavia.

Verifica contenuto pagina in AEM

Per verificare che la pagina possa essere modificata, segui gli stessi passaggi nella sezione . Verifica la modifica del contenuto di testo in AEM.

Modifica di una pagina in AEM

La pagina è ora modificabile in AEM con un contenitore di layout e un componente Testo secondario.

Componenti Foglia Virtuali

Negli esempi precedenti, abbiamo aggiunto componenti al SPA con contenuto AEM esistente. Tuttavia, in alcuni casi in cui il contenuto non è ancora stato creato in AEM, ma deve essere aggiunto in un secondo momento dall’autore del contenuto. Per ovviare a questo problema, lo sviluppatore front-end può aggiungere componenti nelle posizioni appropriate all’interno della SPA. Questi componenti visualizzano i segnaposto quando vengono aperti nell’editor in AEM. Una volta che il contenuto viene aggiunto all’interno di questi segnaposto dall’autore del contenuto, i nodi vengono creati nella struttura JCR e il contenuto viene mantenuto. Il componente creato consentirà lo stesso set di operazioni dei componenti foglia indipendenti.

In questo esempio, stiamo riutilizzando il AEMText creato in precedenza. Desideriamo aggiungere nuovo testo sotto il componente di testo esistente nella home page WKND. L’aggiunta dei componenti è la stessa dei normali componenti foglia. Tuttavia, itemPath può essere aggiornato al percorso in cui è necessario aggiungere il nuovo componente.

Poiché il nuovo componente deve essere aggiunto sotto il testo esistente in root/responsivegrid/text, il nuovo percorso sarebbe root/responsivegrid/{itemName}.

<AEMText
 pagePath='/content/wknd-spa-react/us/en/home'
 itemPath='root/responsivegrid/text_20' />

La TestPage dopo l’aggiunta del componente virtuale, il componente si presenta come segue.

Verifica del componente virtuale

NOTA

Assicurati che AEMText il componente ha resourceType imposta nella configurazione per abilitare questa funzione.

Ora puoi distribuire le modifiche a AEM seguendo i passaggi descritti nella sezione . Verifica la modifica del contenuto di testo in AEM. Verrà visualizzato un segnaposto per il file attualmente non esistente text_20 nodo.

Il nodo text_20 in aem

Quando l’autore del contenuto aggiorna questo componente, viene visualizzata una nuova text_20 il nodo viene creato in root/responsivegrid/text_20 in /content/wknd-spa-react/us/en/home.

Il nodo text20

Requisiti e limitazioni

Sono necessari diversi requisiti per aggiungere componenti foglia virtuali e alcune limitazioni.

  • La pagePath è obbligatoria per la creazione di un componente virtuale.
  • Il nodo della pagina fornito nel percorso in pagePath deve esistere nel progetto AEM.
  • Il nome del nodo da creare deve essere specificato nella variabile itemPath.
  • Il componente può essere creato a qualsiasi livello.
    • Se forniamo un itemPath='text_20' nell’esempio precedente, il nuovo nodo verrà creato direttamente sotto la pagina, ovvero /content/wknd-spa-react/us/en/home/jcr:content/text_20
  • Il percorso del nodo in cui viene creato un nuovo nodo deve essere valido quando viene fornito tramite itemPath.
    • In questo esempio, root/responsivegrid devono esistere in modo che il nuovo nodo text_20 può essere creato lì.
  • È supportata solo la creazione di componenti foglia. Il contenitore virtuale e la pagina saranno supportati nelle versioni future.

Contenitori virtuali

È supportata la possibilità di aggiungere contenitori, anche se il contenitore corrispondente non è ancora stato creato in AEM. Il concetto e l'approccio sono simili a componenti foglia virtuali.

Lo sviluppatore front-end può aggiungere i componenti contenitore nelle posizioni appropriate all’interno del SPA e questi componenti visualizzeranno i segnaposto quando vengono aperti nell’editor in AEM. L’autore può quindi aggiungere i componenti e il relativo contenuto al contenitore , che creerà i nodi richiesti nella struttura JCR.

Ad esempio, se un contenitore esiste già in /root/responsivegrid e lo sviluppatore desidera aggiungere un nuovo contenitore secondario:

Posizione del contenitore

newContainer non esiste ancora nel AEM.

Quando si modifica la pagina contenente questo componente in AEM, viene visualizzato un segnaposto vuoto per un contenitore in cui l’autore può aggiungere contenuto.

Segnaposto contenitore

Posizione del contenitore in JCR

Una volta che l’autore aggiunge un componente secondario al contenitore, il nuovo nodo contenitore viene creato con il nome corrispondente nella struttura JCR.

Contenitore con contenuto

Contenitore con contenuto in JCR

È possibile aggiungere al contenitore più componenti e contenuti ora, come richiesto dall’autore, e le modifiche verranno mantenute.

Requisiti e limitazioni

Esistono diversi requisiti per aggiungere contenitori virtuali e alcune limitazioni.

  • Il criterio per determinare quali componenti possono essere aggiunti verrà ereditato dal contenitore principale.
  • L'elemento padre immediato del contenitore da creare deve esistere già in AEM.
    • Se il contenitore root/responsivegrid esiste già nel contenitore AEM, quindi è possibile creare un nuovo contenitore fornendo il percorso root/responsivegrid/newContainer.
    • Tuttavia root/responsivegrid/newContainer/secondNewContainer non è possibile.
  • È possibile creare virtualmente un solo nuovo livello di componente alla volta.

Personalizzazioni aggiuntive

Se hai seguito gli esempi precedenti, la tua SPA esterna è ora modificabile in AEM. Tuttavia, è possibile personalizzare ulteriormente alcuni aspetti del SPA esterno.

ID nodo principale

Per impostazione predefinita, si presuppone che l’applicazione React sia sottoposta a rendering all’interno di un div dell’ID elemento spa-root. Se necessario, può essere personalizzato.

Ad esempio, supponiamo di avere un SPA in cui l'applicazione viene sottoposta a rendering all'interno di un div dell’ID elemento root. Questo deve riflettersi in tre file.

  1. In index.js della domanda React (o dove ReactDOM.render() è chiamato)

    ReactDOM.render() nel file index.js

  2. In index.html dell'applicazione React

    Index.html dell'applicazione

  3. Nel corpo del componente della pagina dell’app AEM in due passaggi:

    1. Crea un nuovo body.html per il componente pagina.

    Crea un nuovo file body.html

    1. Aggiungi il nuovo elemento principale nel nuovo body.html file.

    Aggiungi l'elemento principale a body.html

Modifica di un SPA React con Routing

Se l’applicazione React SPA esterna ha più pagine, può utilizzare il routing per determinare la pagina/componente da eseguire il rendering. Il caso d’uso di base è quello di corrispondere all’URL attualmente attivo rispetto al percorso fornito per una route. Per abilitare la modifica su tali applicazioni abilitate per il routing, il percorso da abbinare deve essere trasformato per contenere informazioni specifiche per AEM.

Nell’esempio seguente abbiamo una semplice applicazione React con due pagine. La pagina di cui eseguire il rendering è determinata dalla corrispondenza del percorso fornito al router rispetto all'URL attivo. Ad esempio, se mydomain.com/test, TestPage viene eseguito il rendering.

Instradamento in un SPA esterno

Per abilitare la modifica in AEM per questo esempio SPA, sono necessari i seguenti passaggi.

  1. Identifica il livello che fungerebbe da radice su AEM.

    • Per il nostro campione, stiamo considerando wknd-spa-react/us/en come radice del SPA. Ciò significa che tutto ciò che precede quel percorso è AEM solo pagine/contenuto.
  2. Crea una nuova pagina al livello richiesto.

    • In questo esempio, la pagina da modificare viene mydomain.com/test. test si trova nel percorso principale dell’app. Questa funzione deve essere mantenuta anche durante la creazione della pagina in AEM. Pertanto, possiamo creare una nuova pagina al livello principale definito nel passaggio precedente.
    • La nuova pagina creata deve avere lo stesso nome della pagina da modificare. In questo esempio per mydomain.com/test, la nuova pagina creata deve essere /path/to/aem/root/test.
  3. Aggiungi gli helper all'interno SPA routing.

    • La pagina appena creata non esegue ancora il rendering del contenuto previsto in AEM. Questo perché il router prevede un percorso di /test considerando che il percorso attivo AEM è /wknd-spa-react/us/en/test. Per includere la porzione AEM specifica dell’URL, è necessario aggiungere alcuni helper sul lato SPA.

    Helper di routing

    • La toAEMPath helper fornito da @adobe/cq-spa-page-model-manager può essere utilizzato per questo. Trasforma il percorso fornito per il routing in modo da includere porzioni specifiche AEM quando l'applicazione è aperta in un'istanza AEM. Accetta tre parametri:
      • Percorso necessario per il routing
      • L’URL di origine dell’istanza AEM in cui viene modificata la SPA.
      • La directory principale del progetto in AEM come determinato nel primo passaggio
    • Questi valori possono essere impostati come variabili di ambiente per una maggiore flessibilità.
  4. Verifica di modificare la pagina in AEM.

    • Distribuisci il progetto da AEM e passa alla nuova creazione test pagina. Il contenuto della pagina viene ora sottoposto a rendering e i componenti AEM sono modificabili.

Risorse aggiuntive

Il seguente materiale di riferimento può essere utile per comprendere SPA nel contesto di AEM.

In questa pagina