Componente Página SPA

Em um SPA, o componente de página não fornece os elementos HTML de seus componentes filho, mas delega isso à estrutura de SPA. Este documento explica como isso torna o componente de página de um SPA exclusivo.

OBSERVAÇÃO

O Editor de SPA é a solução recomendada para projetos que exigem renderização do lado do cliente baseada em SPA estrutura (por exemplo, Reagir ou Angular).

Introdução

O componente de página de um SPA não fornece os elementos HTML de seus componentes filho por meio de um arquivo JSP ou HTL e objetos de recurso. Esta operação é delegada no quadro de SPA. A representação de componentes filho é buscada como uma estrutura de dados JSON (ou seja, o modelo). Os componentes de SPA são adicionados à página de acordo com o modelo JSON fornecido. Dessa forma, a composição do corpo inicial do componente de página difere de seus equivalentes HTML pré-renderizados.

Gerenciamento do modelo de página

A resolução e o gerenciamento do modelo de página são delegados em um módulo PageModelManager fornecido. O SPA deve interagir com o módulo PageModelManager quando inicializa para buscar o modelo da página inicial e registrar as atualizações do modelo - produzido principalmente quando o autor está editando a página por meio do Editor de páginas. O PageModelManager é acessível SPA projeto como um pacote npm. Sendo um interpretador entre AEM e o SPA, o PageModelManager deve acompanhar o SPA.

Para permitir a criação da página, uma biblioteca do cliente chamada cq.authoring.pagemodel.messaging deve ser adicionada para fornecer um canal de comunicação entre o SPA e o editor de página. Se o componente da página de SPA herda do componente wcm/core da página, então há as seguintes opções para disponibilizar a categoria da biblioteca do cliente cq.authoring.pagemodel.messaging:

  • Se o modelo for editável, adicione a categoria da biblioteca do cliente à política da página.
  • Adicione a categoria da biblioteca do cliente usando o customfooterlibs.html do componente da página.

Não se esqueça de limitar a inclusão da categoria cq.authoring.pagemodel.messaging no contexto do editor de páginas.

Tipo de dados da comunicação

O tipo de dados de comunicação é definido um elemento HTML dentro do componente Página de AEM usando o atributo data-cq-datatype . Quando o tipo de dados de comunicação é definido como JSON, as solicitações do GET atingem os endpoints 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 avisa o SPA de atualizações.

Componente da página de SPA -body.html

<div id="page"></div>

Além de ser uma boa prática não atrasar a geração do DOM, a estrutura do SPA exige que os scripts sejam adicionados ao final do corpo.

Componente da página de SPA -customfooterlibs.html

<sly data-sly-use.clientLib="${'/libs/granite/sightly/templates/clientlib.html'}"></sly>
<sly data-sly-test="${wcmmode.edit || wcmmode.preview}"
     data-sly-call="${clientLib.js @ categories='cq.authoring.pagemodel.messaging'}"></sly>
<sly data-sly-call="${clientLib.js @ categories='we-retail-journal-react'}"></sly>

As propriedades do meta resource que descrevem o conteúdo SPA:

Componente da página de SPA -customheaderlibs.html

<meta property="cq:datatype" data-sly-test="${wcmmode.edit || wcmmode.preview}" content="JSON"/>
<meta property="cq:wcmmode" data-sly-test="${wcmmode.edit}" content="edit"/>
<meta property="cq:wcmmode" data-sly-test="${wcmmode.preview}" content="preview"/>
<meta property="cq:pagemodel_root_url" data-sly-use.page="com.adobe.cq.sample.spa.journal.models.AppPage" content="${page.rootUrl}"/>
<sly data-sly-use.clientlib="/libs/granite/sightly/templates/clientlib.html">
    <sly data-sly-call="${clientlib.css @ categories='we-retail-journal-react'}"/>
</sly>
OBSERVAÇÃO

O seletor de modelo padrão é definido estaticamente ao solicitar a representação do Modelo do Sling de um componente.

Propriedades Meta

  • cq:wcmmode: Modo WCM dos editores (por exemplo, página, modelo)

  • cq:pagemodel_root_url: URL do modelo raiz do aplicativo. Fundamental ao acessar diretamente uma página secundária, pois o modelo de página secundário é um fragmento do modelo raiz do aplicativo. O [PageModelManager](/docs/experience-manager-65/sites-developing/spa-page-component.md) então recompõe sistematicamente o modelo inicial do aplicativo como inserindo o aplicativo de seu ponto de entrada raiz.

  • cq:pagemodel_router: Ativar ou desativar o [ModelRouter](/docs/experience-manager-65/sites-developing/spa-routing.md) da PageModelManager biblioteca

  • cq:pagemodel_route_filters: Lista separada por vírgulas ou expressões regulares para fornecer rotas que [ModelRouter](/docs/experience-manager-65/sites-developing/spa-routing.md) devem ser ignoradas.

ATENÇÃO

Este documento usa o aplicativo do diário We.Retail somente para fins de demonstração. Não deve ser utilizado para qualquer trabalho de projeto.

Qualquer projeto AEM deve aproveitar o AEM Arquétipo de Projeto, que suporta projetos SPA usando React ou Angular e aproveita o SDK SPA.Todos os projetos SPA em AEM devem ser baseados no Arquétipo Maven para SPA Kit Inicial.

Sincronização de sobreposição do editor de páginas

A sincronização das sobreposições é garantida pelo mesmo Observador de Mutações fornecido pela categoria cq.authoring.page.

Configuração da Estrutura Exportada JSON do Modelo Sling

Quando os recursos de roteamento estão ativados, a suposição é que a exportação JSON do SPA contém as diferentes rotas do aplicativo graças à exportação JSON do componente de navegação AEM. A saída JSON do componente de navegação de AEM pode ser configurada na política de conteúdo SPA página raiz por meio das duas propriedades a seguir:

  • structureDepth: Número correspondente à profundidade da árvore exportada
  • structurePatterns: Regex de matriz de regexes correspondente à página a ser exportada

Isso pode ser mostrado no conteúdo SPA de amostra em /conf/we-retail-journal/react/settings/wcm/policies/we-retail-journal/react/components/structure/page/root.

Nesta página