Composite Components em SPAs

Os componentes compostos usam a natureza modular dos componentes AEM ao combinar vários componentes básicos em um único componente. Um caso de uso comum de componente composto é o componente de cartão, composto por uma combinação dos componentes de imagem e texto.

Quando os componentes compostos são implementados corretamente na estrutura do Editor de aplicativo de página única (SPA) do AEM, os autores de conteúdo podem arrastar e soltar esses componentes da mesma forma que fariam com qualquer outro componente, mas ainda têm a capacidade de editar individualmente cada componente que compõe o componente composto.

Este artigo demonstra como você pode adicionar um componente composto ao seu aplicativo de página única para funcionar perfeitamente com o Editor de SPA AEM.

Caso de uso

Este artigo usará o componente de cartão típico como exemplo de caso de uso. Os cartões são um elemento comum da interface do usuário para muitas experiências digitais e geralmente são compostos de uma imagem e texto ou legenda associados. Um autor deseja poder arrastar e soltar todo o cartão, mas poder editar individualmente a imagem do cartão e personalizar o texto associado.

Pré-requisitos

Os seguintes modelos de suporte para casos de uso de componentes compostos exigem os seguintes pré-requisitos.

• Sua instância de desenvolvimento do AEM está sendo executada localmente na porta 4502 com um projeto de amostra.
• Você tem um aplicativo React externo de trabalho habilitado para edição no AEM.
• O aplicativo React é carregado no editor AEM usando o componente RemotePage.

Adicionar componentes compostos a um SPA

Há três modelos diferentes para implementar seu componente composto dependendo de sua implementação do SPA no AEM.

• O componente não existe no projeto AEM.
• O componente existe em seu projeto AEM, mas o conteúdo necessário não existe.
• O componente e seu conteúdo necessário existem no projeto AEM.

As seções a seguir fornecem exemplos de implementação de cada caso usando o componente de cartão como exemplo.

O componente não existe no projeto AEM.

Comece criando os componentes que compõem o componente composto, ou seja, os componentes da imagem e seu texto.

1. Crie o componente de texto no seu projeto AEM.

2. Adicione o correspondente resourceType do projeto no do componente editConfig nó.

    resourceType: 'wknd-spa/components/text'
   

3. Use o withMappable auxiliar para ativar a edição do componente.

   export const AEMText = withMappable(Text, TextEditConfig);
   

O componente de texto será semelhante ao seguinte.

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

Se você criar um componente de imagem de uma maneira semelhante, poderá combiná-lo com a variável AEMText em um novo componente de cartão, usando os componentes de imagem e texto como filhos.

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

Esse componente composto resultante agora pode ser colocado em qualquer lugar no aplicativo e o adicionará espaços reservados para um componente de texto e imagem no Editor de SPA. Na amostra abaixo, o componente de cartão é adicionado ao componente inicial abaixo do título.

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

Isso exibirá um espaço reservado vazio para um texto e uma imagem no editor. Ao inserir valores para eles usando o editor, eles são armazenados no caminho de página especificado, ou seja, /content/wknd-spa/home no nível raiz com os nomes especificados em itemPath.

O componente existe em seu projeto AEM, mas o conteúdo necessário não existe.

Nesse caso, o componente de cartão já foi criado no projeto AEM contendo os nós de título e imagem. Os nós secundários (texto e imagem) têm os tipos de recursos correspondentes.

Você pode então adicioná-lo ao SPA e recuperar seu conteúdo.

1. Crie um componente correspondente no SPA para isso. Certifique-se de que os componentes secundários sejam mapeados de acordo com os tipos de recursos de AEM correspondentes no projeto SPA. Neste exemplo, usamos o mesmo AEMText e AEMImage componentes conforme detalhado no caso anterior.

   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. Como não há conteúdo para o imagecard adicione o cartão à página. Incluir o contêiner existente do AEM no SPA.

   • Se já houver um contêiner no projeto AEM, podemos incluí-lo no SPA e adicionar o componente ao contêiner do AEM.
   • Verifique se o componente de placa está mapeado ao tipo de recurso correspondente no SPA.

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

3. Adicionar o criado wknd-spa/components/imagecard aos componentes permitidos para o componente de contêiner no modelo de página.

Agora a variável imagecard pode ser adicionado diretamente ao contêiner no editor de AEM.

O componente e seu conteúdo necessário existem no projeto AEM.

Se o conteúdo existir no AEM, ele pode ser incluído diretamente no SPA, fornecendo o caminho para o conteúdo.

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

A variável AEMCard o componente é o mesmo que o definido no caso de uso anterior. Aqui, o conteúdo definido no local acima no projeto AEM é incluído no SPA.