Sammansatta komponenter i SPA

Sammansatta komponenter utnyttjar den modulära karaktären hos AEM komponenter genom att kombinera flera baskomponenter till en enda komponent. Ett vanligt användningsfall för sammansatta komponenter är kortkomponenten som består av en kombination av bild- och textkomponenterna.

När sammansatta komponenter implementeras på rätt sätt i redigeringsramverket för AEM Single Page Application (SPA) kan innehållsförfattarna dra och släppa sådana komponenter som vilken annan komponent som helst, men ändå ha möjlighet att redigera varje komponent som utgör den sammansatta komponenten separat.

I den här artikeln visas hur du kan lägga till en sammansatt komponent i ett enkelsidigt program för att fungera sömlöst med AEM SPA.

Användningsfall

I den här artikeln används den vanliga kortkomponenten som exempel på hur den används. Kort är ett vanligt gränssnittselement för många digitala upplevelser och består vanligtvis av en bild och tillhörande text eller bildtext. En författare vill kunna dra och släppa hela kortet, men kan redigera kortets bild individuellt samt anpassa den tillhörande texten.

Förutsättningar

Följande modeller för stöd av användning av sammansatta komponenter kräver följande krav.

• Din AEM-utvecklingsinstans körs lokalt på port 4502 med ett exempelprojekt.
• Du har en fungerande extern React-app som kan redigeras i AEM.
• Appen React läses in i AEM med komponenten RemotePage.

Lägga till sammansatta komponenter i en SPA

Det finns tre olika modeller för implementering av den sammansatta komponenten beroende på SPA implementering i AEM.

• Komponenten finns inte i AEM.
• Komponenten finns i AEM men det obligatoriska innehållet gör det inte.
• Komponenten och dess obligatoriska innehåll finns båda i AEM.

I följande avsnitt ges exempel på hur du implementerar varje fall med kortkomponenten som exempel.

Komponenten finns inte i AEM.

Börja med att skapa de komponenter som ska utgöra den sammansatta komponenten, dvs. komponenter för bilden och dess text.

1. Skapa textkomponenten i AEM.

2. Lägg till motsvarande resourceType från projektet i komponentens editConfig nod.

    resourceType: 'wknd-spa/components/text'
   

3. Använd withMappable hjälp för att aktivera redigering för komponenten.

   export const AEMText = withMappable(Text, TextEditConfig);
   

Textkomponenten liknar följande.

import React from 'react';
import { withMappable } from '@adobe/aem-react-editable-components';

export const TextEditConfig = {
  emptyLabel: 'Text',
  isEmpty: function(props) {
    return !props || !props.text || props.text.trim().length < 1;
  },
  resourceType: 'wknd-spa/components/text'
};

export 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>
  );
};

export const AEMText = withMappable(Text, TextEditConfig);

Om du skapar en bildkomponent på ett liknande sätt kan du kombinera den med AEMText till en ny kortkomponent, med bild- och textkomponenterna som underordnade.

import React from 'react';
import { AEMText } from './AEMText';
import { AEMImage } from './AEMImage';

export const AEMCard = ({ pagePath, itemPath}) => (
  <div>
    <AEMText
       pagePath={pagePath}
       itemPath={`text`} />
    <AEMImage
       pagePath={pagePath}
       itemPath={`image`} />
   </div>
);

Den sammansatta komponenten kan nu placeras var som helst i programmet och platshållare för en text och en bildkomponent läggs till i SPA Editor. I exemplet nedan läggs kortkomponenten till i hemkomponenten under rubriken.

function Home() {
  return (
    <div className="Home">
      <h2>Current Adventures</h2>
      <AEMCard
        pagePath='/content/wknd-spa/home' />
    </div>
  );
}

Då visas en tom platshållare för en text och en bild i redigeraren. När du anger värden för dessa med redigeraren lagras de på den angivna sidsökvägen, d.v.s. /content/wknd-spa/home på rotnivån med de namn som anges i itemPath.

Komponenten finns i AEM men det obligatoriska innehållet gör det inte.

I det här fallet har kortkomponenten redan skapats i ditt AEM med titel- och bildnoder. De underordnade noderna (text och bild) har motsvarande resurstyper.

Sedan kan du lägga till den i SPA och hämta dess innehåll.

1. Skapa en motsvarande komponent i SPA för detta. Se till att de underordnade komponenterna mappas till motsvarande AEM resurstyper i det SPA projektet. I det här exemplet använder vi samma AEMText och AEMImage komponenter som i föregående fall.

   import React from 'react';
   import { Container, withMappable, MapTo } from '@adobe/aem-react-editable-components';
   import { Text, TextEditConfig } from './AEMText';
   import Image, { ImageEditConfig } from './AEMImage';
   
   export const AEMCard = withMappable(Container, {
     resourceType: 'wknd-spa/components/imagecard'
   });
   
   MapTo('wknd-spa/components/text')(Text, TextEditConfig);
   MapTo('wknd-spa/components/image')(Image, ImageEditConfig);
   

2. Eftersom det inte finns något innehåll för imagecard lägger du till kortet på sidan. Inkludera den befintliga behållaren från AEM i SPA.

   • Om det redan finns en behållare i det AEM projektet kan vi inkludera den i SPA i stället och lägga till komponenten i behållaren från AEM.
   • Kontrollera att kortkomponenten är mappad till motsvarande resurstyp i SPA.

   <ResponsiveGrid
    pagePath='/content/wknd-spa/home'
    itemPath='root/responsivegrid' />
   

3. Lägg till skapade wknd-spa/components/imagecard till de tillåtna komponenterna för behållarkomponenten i sidmallen.

Nu imagecard kan läggas till direkt i behållaren i AEM.

Komponenten och dess obligatoriska innehåll finns båda i AEM.

Om innehållet finns i AEM kan det inkluderas direkt i SPA genom att ange sökvägen till innehållet.

<AEMCard
    pagePath='/content/wknd-spa/home'
    itemPath='root/responsivegrid/imagecard' />

The AEMCard -komponenten är densamma som definierad i det föregående användningsexemplet. Här inkluderas det innehåll som definieras på ovanstående plats i AEM projekt i SPA.

Resurser för Business.Adobe.com