Visão geral do editor de SPA

Aplicativos de página única (SPAs) podem oferecer experiências interessantes para usuários de sites. Os desenvolvedores desejam criar sites usando estruturas SPA e os autores desejam editar o conteúdo com facilidade no AEM para um site criado usando essas estruturas.

O Editor de SPA oferece uma solução abrangente para oferecer suporte à SPA no AEM. Esta página fornece uma visão geral de como SPA suporte é estruturado no AEM, como o Editor de SPA funciona e como a estrutura de SPA e AEM permanece sincronizada.

Introdução

Sites criados usando estruturas SPA comuns, como o React e o Angular, carregam seu conteúdo via JSON dinâmico e não fornecem a estrutura de HTML necessária para o Editor de página AEM poder colocar controles de edição.

Para habilitar a edição de SPA no AEM, é necessário um mapeamento entre a saída JSON do SPA e o modelo de conteúdo no repositório AEM para salvar as alterações no conteúdo.

SPA suporte no AEM introduz uma fina camada JS que interage com o código JS SPA quando carregado no Editor de páginas com o qual os eventos podem ser enviados e o local dos controles de edição pode ser ativado para permitir a edição no contexto. Esse recurso tem como base o conceito de Ponto de extremidade da API dos serviços de conteúdo , pois o conteúdo do SPA precisa ser carregado por meio dos Serviços de conteúdo.

Para obter mais detalhes sobre SPA no AEM, consulte os seguintes documentos:

Design

O componente de página de um SPA não fornece os elementos HTML de seus componentes filho por meio do arquivo JSP ou HTL. Esta operação é delegada no quadro de SPA. A representação de componentes ou modelos filhos é buscada como uma estrutura de dados JSON do JCR. Os componentes do SPA são adicionados à página de acordo com essa estrutura. Esse comportamento diferencia a composição do corpo inicial do componente de página de contrapartes não SPA.

Gerenciamento do modelo de página

A resolução e o gerenciamento do modelo de página são delegados a um PageModel biblioteca. O SPA deve usar a biblioteca do Modelo de página para ser inicializado e criado pelo Editor de SPA. A biblioteca do Modelo de página fornecida indiretamente ao componente Página de AEM por meio do aem-react-editable-components npm. O Modelo de página é um interpretador entre o AEM e o SPA e, portanto, sempre deve estar presente. Quando a página é criada, uma biblioteca adicional cq.authoring.pagemodel.messaging deve ser adicionado para permitir a comunicação com o editor de páginas.

Se o componente Página de SPA herda do componente principal da página, há duas opções para criar a cq.authoring.pagemodel.messaging categoria de biblioteca de clientes disponível:

  • Se o modelo for editável, adicione-o à política de página.
  • Ou adicione as categorias usando o customfooterlibs.html.

Para cada recurso no modelo exportado, o SPA mapeará um componente real que fará a renderização. O modelo, representado como JSON, é renderizado usando os mapeamentos de componente em um contêiner.

Mapeamento de modelo e componente no SPA

ATENÇÃO

A inclusão do cq.authoring.pagemodel.messaging deve ser limitada ao contexto do Editor de SPA.

Tipo de dados da comunicação

Quando a variável cq.authoring.pagemodel.messaging for adicionada à página, ela enviará uma mensagem para o Editor de páginas para estabelecer o tipo de dados de comunicação JSON. Quando o tipo de dados de comunicação é definido como JSON, as solicitações do GET se comunicam com os pontos finais do Modelo do Sling de um componente. Depois que uma atualização ocorre no editor de páginas, a representação JSON do componente atualizado é enviada para a biblioteca do Modelo de página. A biblioteca do Modelo de página informa o SPA de atualizações.

Comunicação SPA

Fluxo de trabalho

Você pode entender o fluxo da interação entre o SPA e o AEM pensando no Editor de SPA como um mediador entre os dois.

  • A comunicação entre o editor de páginas e o SPA é feita usando JSON em vez de HTML.
  • O editor de páginas fornece a versão mais recente do modelo de página para o SPA por meio do iframe e da API de mensagens.
  • O gerenciador de modelo de página notifica o editor de que está pronto para edição e passa o modelo de página como uma estrutura JSON.
  • O editor não altera ou nem acessa a estrutura DOM da página que está sendo criada, em vez de fornecer o modelo de página mais recente.

Fluxo de trabalho SPA

Fluxo de trabalho básico do editor de SPA

Lembrando os elementos principais do Editor de SPA, o fluxo de trabalho de alto nível da edição de um SPA no AEM é exibido ao autor da seguinte maneira.

Fluxo de trabalho de SPA animado

  1. SPA Editor é carregado.
  2. SPA é carregado em um quadro separado.
  3. O SPA solicita conteúdo JSON e renderiza componentes do lado do cliente.
  4. SPA Editor detecta componentes renderizados e gera sobreposições.
  5. O autor clica em sobrepor, exibindo a barra de ferramentas de edição do componente.
  6. SPA Editor persiste as edições com uma solicitação POST para o servidor.
  7. As solicitações SPA Editor atualizaram o JSON para o Editor de SPA, que é enviado ao SPA com um evento DOM.
  8. SPA renderiza novamente o componente relacionado, atualizando seu DOM.
OBSERVAÇÃO

Lembre-se:

  • O SPA é sempre encarregado de sua exibição.
  • O Editor de SPA é isolado do próprio SPA.
  • Em produção (publicação), o editor de SPA nunca é carregado.

Fluxo de trabalho de edição de página do cliente-servidor

Esta é uma visão geral mais detalhada da interação cliente-servidor ao editar um SPA.

Fluxo de trabalho de edição do servidor cliente

  1. O SPA é inicializado e solicita o modelo de página do Exportador de Modelo do Sling.

  2. O Exportador do Modelo Sling solicita os recursos que compõem a página do repositório.

  3. O repositório retorna os recursos.

  4. O Exportador de Modelo do Sling retorna o modelo da página.

  5. O SPA instancia seus componentes com base no modelo da página.

  6. 6a O conteúdo informa ao editor que está pronto para criação.

    6b O editor de páginas solicita as configurações de criação do componente.

    6c O editor de páginas recebe as configurações do componente.

  7. Quando o autor edita um componente, o editor de páginas posta uma solicitação de modificação no servlet POST padrão.

  8. O recurso é atualizado no repositório.

  9. O recurso atualizado é fornecido ao servlet do POST.

  10. O servlet POST padrão informa ao editor de páginas que o recurso foi atualizado.

  11. O editor de páginas solicita o novo modelo de página.

  12. Os recursos que compõem a página são solicitados do repositório.

  13. Os recursos que compõem a página são fornecidos pelo repositório ao Exportador do Modelo do Sling.

  14. O modelo de página atualizado é retornado ao editor.

  15. O editor de páginas atualiza a referência do modelo de página do SPA.

  16. O SPA atualiza seus componentes com base na nova referência do modelo de página.

  17. As configurações de componentes dos editores de página são atualizadas.

    17 bis O SPA sinaliza ao editor de páginas que o conteúdo está pronto.

    17-B O editor de páginas fornece o SPA com configurações de componentes.

    17c O SPA fornece configurações atualizadas do componente.

Fluxo de trabalho de criação

Esta é uma visão geral mais detalhada que foca na experiência de criação.

Fluxo de trabalho de criação de SPA

  1. O SPA busca o modelo da página.

  2. 2 bis O modelo de página fornece ao editor os dados necessários para a criação.

    2b Quando notificado, o orquestrador de componentes atualiza a estrutura de conteúdo da página.

  3. O orquestrador de componentes consulta o mapeamento entre um tipo de recurso AEM e um componente SPA.

  4. O orquestrador de componentes instancia dinamicamente o componente de SPA com base no modelo de página e no mapeamento de componentes.

  5. O editor de páginas atualiza o modelo de página.

  6. 6a O modelo de página fornece dados de criação atualizados para o editor de página.

    6b O modelo de página despacha alterações no orquestrador de componentes.

  7. O orquestrador de componentes busca o mapeamento de componentes.

  8. O orquestrador de componentes atualiza o conteúdo da página.

  9. Quando o SPA conclui a atualização do conteúdo da página, o editor de páginas carrega o ambiente de criação.

Requisitos e limitações

Para permitir que o autor use o editor de páginas para editar o conteúdo de um SPA, o aplicativo SPA deve ser implementado para interagir com o SDK do Editor de SPA do AEM. Consulte a Introdução ao SPA no AEM usando o React documento pelo mínimo que você precisa saber para executar o seu.

Estruturas suportadas

O SDK do Editor de SPA oferece suporte às seguintes versões mínimas:

  • React 16.x e up
  • Angular 6.x e superior

As versões anteriores dessas estruturas podem funcionar com o SDK SPA Editor do AEM, mas não são compatíveis.

Estruturas adicionais

Estruturas de SPA adicionais podem ser implementadas para funcionar com o SDK do AEM SPA Editor. Consulte a SPA Blueprint documento para os requisitos que uma estrutura deve atender para criar uma camada específica de estrutura composta por módulos, componentes e serviços para trabalhar com o Editor de SPA de AEM.

Uso de vários seletores

Seletores personalizados adicionais podem ser definidos e usados como parte de um SPA desenvolvido para o SDK de SPA AEM. No entanto, esse suporte exige que o model seletor será o primeiro seletor e a extensão será .json conforme exigido pelo exportador JSON.

Requisitos do editor de texto

Se você quiser usar o editor no local de um componente de texto criado SPA há uma configuração adicional necessária.

  1. Defina um atributo (pode ser qualquer) no elemento wrapper de contêiner que contém o HTML de texto. No caso do projeto SPA WKND, é um <div> e o seletor que foi usado é data-rte-editelement.
  2. Definir a configuração editElementQuery no componente de texto AEM correspondente cq:InplaceEditingConfig que aponte para esse seletor, por exemplo data-rte-editelement. Isso permite que o editor saiba qual elemento HTML envolve o texto HTML.

Para obter mais informações sobre o editElementQuery e a configuração do editor de rich text, consulte Configure o Editor de Rich Text.

Limitações

O SDK do Editor de SPA AEM é totalmente compatível com o Adobe e continua sendo aprimorado e expandido. Os seguintes recursos de AEM ainda não são compatíveis com o Editor de SPA:

  • Modo de destino
  • ContextHub
  • Edição de imagem embutida
  • Editar configurações (por exemplo, ouvintes
  • Desfazer / Refazer
  • Distorção de hora e diff de página
  • Recursos que executam a regravação de HTML no lado do servidor, como o Verificador de links, o serviço de regravação de CDN, a redução de URL etc.
  • Modo de desenvolvedor
  • AEM inicializações

Nesta página