Desenvolvimento de componentes de AEM

AEM componentes são usados para manter, formatar e renderizar o conteúdo disponibilizado nas suas páginas da Web.

• Ao criar páginas, os componentes permitem que os autores editem e configurem o conteúdo.

  • Ao construir um site Commerce, os componentes podem, por exemplo, coletar e renderizar informações do catálogo.
    Consulte Desenvolvimento de comércio eletrônico para obter mais informações.

  • Ao construir um site Communities, os componentes podem fornecer informações e coletar informações de seus visitantes.
    Consulte Desenvolvimento de comunidades para obter mais informações.

• Na instância de publicação, os componentes renderizam o conteúdo, apresentando-o como você precisa para os visitantes do site.

Amostras de código

Esta página fornece a documentação de referência (ou links para a documentação de referência) necessária para desenvolver novos componentes para o AEM. Consulte Desenvolvimento de componentes de AEM - Amostras de código para obter alguns exemplos práticos.

Estrutura

A estrutura básica de um componente é abordada na página AEM Componentes - Noções básicas. Esse documento abrange as interfaces de usuário habilitadas para toque e clássica. Mesmo que você não precise usar as configurações clássicas em seu novo componente, isso pode ajudar a conhecê-las ao herdar dos componentes existentes.

Extensão de componentes e caixas de diálogo existentes

Dependendo do componente que você deseja implementar, pode ser possível estender ou personalizar uma instância existente, em vez de definir e desenvolver toda a estrutura do zero.

Ao estender ou personalizar um componente ou caixa de diálogo existente, você pode copiar ou replicar toda a estrutura ou a estrutura necessária para a caixa de diálogo antes de fazer suas alterações.

Extensão de um componente existente

A extensão de um componente existente pode ser alcançada com Hierarquia do tipo de recurso e os mecanismos de herança relacionados.

Personalização de uma caixa de diálogo de componente existente

Também é possível substituir uma caixa de diálogo componente usando o Sling Resource Merger e definindo a propriedade sling:resourceSuperType.

Isso significa que você só precisa redefinir as diferenças necessárias, em vez de redefinir toda a caixa de diálogo (usando sling:resourceSuperType). Esse agora é um método recomendado para estender uma caixa de diálogo de componentes

Consulte o Sling Resource Merger para obter mais detalhes.

Como definir a marcação

Seu componente será renderizado com HTML. Seu componente precisa definir o HTML necessário para obter o conteúdo necessário e, em seguida, renderizá-lo conforme necessário, nos ambientes de autor e publicação.

Usando a Linguagem de modelo HTML

O HTML Templating Language (HTL), introduzido com o AEM 6.0, substitui o JSP (JavaServer Pages) como o sistema de modelo preferencial e recomendado do lado do servidor para HTML. Para desenvolvedores da Web que precisam criar sites corporativos robustos, o HTL ajuda a aumentar a segurança e a eficiência do desenvolvimento.

Desenvolvimento da lógica de conteúdo

Essa lógica opcional seleciona e/ou calcula o conteúdo a ser renderizado. É chamado de expressões HTL com o padrão Use-API apropriado.

O mecanismo para separar a lógica da aparência ajuda a esclarecer o que é chamado para uma determinada exibição. Também permite lógica diferente para diferentes exibições do mesmo recurso.

Uso do Java

A API de uso do Java do HTL permite que um arquivo HTL acesse métodos de ajuda em uma classe Java personalizada. Isso permite usar o código Java para implementar a lógica de seleção e configuração do conteúdo do componente.

Como usar o JavaScript

A API de uso do JavaScript do HTL permite que um arquivo HTL acesse o código de ajuda gravado em JavaScript. Isso permite usar o código JavaScript para implementar a lógica de seleção e configuração do conteúdo do componente.

Usar bibliotecas HTML do lado do cliente

Sites modernos dependem muito de processamento no lado do cliente impulsionado por códigos complexos de JavaScript e CSS. Organizar e otimizar a veiculação desse código pode ser um problema complicado.

Para ajudar a lidar com esse problema, o AEM fornece Pastas de biblioteca do lado do cliente, que permitem armazenar o código do lado do cliente no repositório, organizá-lo em categorias e definir quando e como cada categoria de código deve ser apresentada ao cliente. O sistema de bibliotecas do lado do cliente cuida da produção dos links corretos na página da Web final para carregar o código correto.

Leia Usando bibliotecas HTML do lado do cliente para obter mais informações.

Configurar o comportamento de edição

É possível configurar o comportamento de edição de um componente, incluindo atributos, como ações disponíveis para o componente, características do editor local e ouvintes relacionados a eventos no componente. A configuração é comum à interface habilitada para toque e clássica, embora com determinadas diferenças específicas.

O comportamento de edição de um componente é configurado adicionando um nó cq:editConfig do tipo cq:EditConfig abaixo do nó do componente (do tipo cq:Component) e adicionando propriedades específicas e nós secundários.

Configuração do comportamento de visualização

O cookie Modo WCM é definido ao alternar para o modo Visualização mesmo quando a página não é atualizada.

Para componentes com uma renderização que são sensíveis ao modo WCM, eles precisam ser definidos para serem atualizados especificamente e, em seguida, dependem do valor do cookie.

Criação e configuração de uma caixa de diálogo

As caixas de diálogo são usadas para permitir que o autor interaja com o componente. Usar uma caixa de diálogo permite que autores e/ou administradores editem conteúdo, configurem o componente ou definam parâmetros de design (usando uma Caixa de diálogo de design)

Interface do usuário do Coral e do Granite

Coral UIe Granite UIdefinem a aparência moderna do AEM.

A interface do usuário do Granite fornece uma grande variedade dos componentes básicos (widgets) necessários para criar sua caixa de diálogo no ambiente de criação. Quando necessário, você pode estender essa seleção e criar seu próprio widget.

Para obter detalhes completos, consulte:

• Interface do usuário do Coral

  • Fornece uma interface do usuário consistente em todas as soluções de nuvem
  • Conceitos da interface de usuário habilitada para toque do AEM - Interface do usuário do Coral
  • Guia da interface do usuário do Coral

• Interface do usuário do Granite

  • Fornece marcação Coral UI encapsulada em componentes Sling para criar consoles e caixas de diálogo da interface do usuário
  • Conceitos da interface habilitada para toque do AEM - Interface do usuário do Granite
  • Documentação da interface de usuário do Granite

Criação de uma nova caixa de diálogo

Caixas de diálogo da interface habilitada para toque:

• são nomeadas como cq:dialog.

• são definidos como um nó nt:unstructured com o conjunto de propriedades sling:resourceType.

• estão localizados no nó cq:Component e ao lado da definição do componente.

• são renderizados no lado do servidor (como componentes do Sling), com base em sua estrutura de conteúdo e na propriedade sling:resourceType .

• use a estrutura da interface do usuário do Granite.

• contém uma estrutura de nó que descreve os campos na caixa de diálogo.

  • esses nós são nt:unstructured com a propriedade sling:resourceType necessária.

Uma estrutura de nó de exemplo pode ser:

newComponent (cq:Component)
  cq:dialog (nt:unstructured)
    content
      layout
      items
        column
          items
            file
            description

A personalização de uma caixa de diálogo é semelhante ao desenvolvimento de um componente, já que a caixa de diálogo é um componente (ou seja, uma marcação renderizada por um script de componente junto com o comportamento/estilo fornecido por uma biblioteca do cliente).

Para obter exemplos, consulte:

• /libs/foundation/components/text/cq:dialog
• /libs/foundation/components/download/cq:dialog

Personalização de campos de diálogo

Criação de um novo campo

Os widgets da interface de usuário habilitada para toque são implementados como componentes da interface de usuário do Granite.

Para criar um novo widget para usar em uma caixa de diálogo de componente para a interface habilitada para toque, é necessário criar um novo componente de campo da interface do Granite.

Se sua caixa de diálogo for considerada um contêiner simples para um elemento de formulário, você também poderá ver o conteúdo principal do conteúdo da caixa de diálogo como campos de formulário. A criação de um novo campo de formulário requer a criação de um tipo de recurso; isso equivale a criar um novo componente. Para ajudá-lo nessa tarefa, a interface de usuário do Granite oferece um componente de campo genérico do qual herdar (usando sling:resourceSuperType):

/libs/granite/ui/components/coral/foundation/form/field

Mais especificamente, a interface do usuário do Granite fornece uma variedade de componentes de campo adequados para uso em caixas de diálogo (ou, de modo mais geral, em forms).

Depois de criar o tipo de recurso, é possível instanciar o campo adicionando um novo nó na caixa de diálogo, com a propriedade sling:resourceType referindo-se ao tipo de recurso que acabou de apresentar.

Criação de uma biblioteca do cliente para estilo e comportamento

Se quiser definir o estilo e o comportamento do seu componente, você pode criar uma biblioteca do cliente dedicada que defina o CSS/LESS e o JS personalizados.

Para carregar a biblioteca do cliente apenas para a caixa de diálogo do componente (ou seja, ela não será carregada para outro componente), é necessário definir a propriedade extraClientlibs​​da caixa de diálogo para o nome da categoria da biblioteca do cliente que você acabou de criar. Isso é aconselhável se a biblioteca do cliente for muito grande e/ou se o campo for específico dessa caixa de diálogo e não for necessário em outras caixas de diálogo.

Para carregar sua biblioteca do cliente para todas as caixas de diálogo, defina a propriedade category da biblioteca do cliente para cq.authoring.dialog. Esse é o nome da categoria da biblioteca do cliente incluída por padrão ao renderizar todas as caixas de diálogo. Você deseja fazer isso se a biblioteca do cliente for pequena e/ou se o campo for genérico e puder ser reutilizado em outras caixas de diálogo.

Para ver um exemplo, consulte:

• cqgems/customizingfield/components/colorpicker/clientlibs

  • fornecido pelo Amostra de código

Estender (Herdar de) um campo

Dependendo dos seus requisitos, você pode:

• Estender um determinado campo da interface do usuário do Granite por herança de componente ( sling:resourceSuperType)
• Estender um determinado widget a partir da biblioteca de widgets subjacente (no caso da interface do usuário do Granite, essa é a interface do usuário Coral), seguindo a API da biblioteca de widgets (herança JS/CSS)

Acesso aos campos de diálogo

Também é possível usar as condições de renderização ( rendercondition) para controlar quem tem acesso a guias/campos específicos na caixa de diálogo; por exemplo:

+ mybutton
  - sling:resourceType = granite/ui/components/coral/foundation/button
  + rendercondition
    - sling:resourceType = myapp/components/renderconditions/group
    - groups = ["administrators"]

Tratamento de eventos de campo

O método de tratamento de eventos em campos de diálogo agora é feito com ouvintes em uma biblioteca cliente personalizada. Esta é uma alteração no método mais antigo de ter ouvintes na estrutura de conteúdo.

Ouvintes em uma biblioteca personalizada do cliente

Para inserir lógica em seu campo, você deve:

1. Tenha seu campo marcado com uma determinada classe CSS (o hook).
2. Defina, na biblioteca do cliente, um ouvinte JS vinculado ao nome da classe CSS (isso garante que a lógica personalizada tenha escopo somente para o campo e não afete outros campos do mesmo tipo).

Para isso, você precisa saber sobre a biblioteca de widgets subjacente com a qual deseja interagir. Consulte a documentação da interface do usuário coral para identificar a qual evento você deseja reagir. Isso é muito semelhante ao processo que você tinha que executar com ExtJS no passado: encontre a página de documentação de um determinado widget e verifique os detalhes de sua API de evento.

Para ver um exemplo, consulte:

• cqgems/customizingfield/components/clientlibs/customizingfield

  • fornecido pelo Amostra de código

Ouvintes na estrutura do conteúdo

Na interface clássica com ExtJS, era normal ter ouvintes de um determinado widget na estrutura de conteúdo. Alcançar o mesmo na interface habilitada para toque é diferente do código de ouvinte JS (ou qualquer código) não é mais definido no conteúdo.

A estrutura de conteúdo descreve a estrutura semântica; não deve (deve) implicar a natureza do widget subjacente. Não tendo o código JS na estrutura de conteúdo, você pode alterar os detalhes da implementação sem precisar alterar a estrutura do conteúdo. Em outras palavras, você pode alterar a biblioteca de widgets sem precisar tocar na estrutura do conteúdo.

Detectando Disponibilidade da Caixa de Diálogo

Se você tiver um JavaScript personalizado que precisa ser executado apenas quando a caixa de diálogo estiver disponível e pronta, você deve ouvir o evento dialog-ready.

Esse evento é acionado sempre que a caixa de diálogo é carregada (ou recarregada) e está pronta para uso, o que significa que sempre que há uma alteração (criar/atualizar) no DOM da caixa de diálogo.

dialog-ready pode ser usada para conectar o código personalizado JavaScript que executa personalizações nos campos dentro de uma caixa de diálogo ou tarefas semelhantes.

Validação de campo

Campo Obrigatório

Para marcar um determinado campo como obrigatório, defina a seguinte propriedade no nó de conteúdo do campo:

• Nome: required
• Tipo: Boolean

Para ver um exemplo, consulte:

/libs/foundation/components/page/cq:dialog/content/items/tabs/items/basic/items/column/items/title/items/title

Validação de campo (interface do usuário do Granite)

A validação de campo na interface do Granite e nos Componentes da interface do usuário do Granite (equivalente a widgets) é feita usando a API foundation-validation. Consulte a documentação do foundation-valdiation Granite para obter detalhes.

Para obter exemplos, consulte:

• cqgems/customizingfield/components/clientlibs/customizingfield/js/validations.js

  • fornecido pelo Amostra de código

• /libs/cq/gui/components/authoring/dialog/clientlibs/dialog/js/validations.js

Criação e configuração de uma caixa de diálogo de design

A caixa de diálogo Design é fornecida quando um componente tem detalhes de design que podem ser editados em Modo Design.

A definição é muito semelhante à de uma caixa de diálogo usada para editar o conteúdo, com a diferença de que é definida como um nó:

• Nome do nó: cq:design_dialog
• Tipo: nt:unstructured

Criação e configuração de um editor no local

Um editor local permite que o usuário edite conteúdo diretamente no fluxo de parágrafo, sem a necessidade de abrir uma caixa de diálogo. Por exemplo, os componentes padrão Texto e Título têm um editor local.

Um editor local não é necessário/significativo para cada tipo de componente.

Consulte Estender criação de página - Adicionar novo editor local para obter mais informações.

Personalização da barra de ferramentas do componente

A Barra de ferramentas do componente dá ao usuário acesso a uma variedade de ações para o componente, como editar, configurar, copiar e excluir.

Consulte Estender criação de página - Adicionar nova ação a uma barra de ferramentas de componente para obter mais informações.

Configurar um componente para o painel de referências (emprestado/concedido)

Se o novo componente fizer referência ao conteúdo de outras páginas, você poderá considerar se deseja que ele afete as seções Conteúdo emprestado e Conteúdo emprestado do Trilho Referências.

O AEM pronto para uso verifica apenas o componente de referência. Para adicionar seu componente é necessário configurar o pacote OSGi Configuração de Referência de Conteúdo de Criação do WCM.

Crie uma nova entrada na definição, especificando seu componente, junto com a propriedade a ser verificada. Por exemplo:

/apps/<*your-Project*>/components/reference@parentPath

Ativar e adicionar seu componente ao sistema de parágrafos

Depois que o componente tiver sido desenvolvido, ele precisará ser ativado para uso em um sistema de parágrafo apropriado, para que possa ser usado nas páginas necessárias.

Isso pode ser feito:

• usando o Modo Design ao editar uma página específica.
• definição da components propriedade no sistema de parágrafo de um template.

Configurar um sistema de parágrafo para que a arrastar um ativo crie uma instância de componente

AEM oferece a possibilidade de configurar um sistema de parágrafo em sua página para que uma instância do novo componente seja criada automaticamente quando um usuário arrastar um ativo (apropriado) para uma instância dessa página (em vez de sempre ter que arrastar um componente vazio para a página).

Esse comportamento e o relacionamento ativo-componente necessário podem ser configurados:

1. Na definição de parágrafo do design da página. Por exemplo:

   • /etc/designs/<myApp>/page/par

   Crie um novo nó:

   • Nome: cq:authoring
   • Tipo: nt:unstructured

2. Em seguida, crie um novo nó para manter todos os mapeamentos de ativo para componente:

   • Nome: assetToComponentMapping
   • Tipo: nt:unstructured

3. Para cada mapeamento de ativo para componente, crie um nó:

   • Nome: texto; recomenda-se que o nome indique o tipo de ativo e componente relacionado; por exemplo, imagem
   • Tipo: nt:unstructured

   Cada um com as seguintes propriedades:

   • assetGroup:

     • Tipo: String
     • Valor: o grupo ao qual o ativo relacionado pertence; por exemplo, media

   • assetMimetype:

     • Tipo: String
     • Valor: o tipo MIME do ativo relacionado; por exemplo image/*

   • droptarget:

     • Tipo: String
     • Valor: o objetivo de queda; por exemplo, image

   • resourceType:

     • Tipo: String
     • Valor: o recurso componente relacionado; por exemplo, foundation/components/image

   • type:

     • Tipo: String
     • Valor: o tipo , por exemplo, Images

Por exemplo, consulte:

• /etc/designs/geometrixx/jcr:content/page/par/cq:authoring
• /etc/designs/geometrixx-outdoors/jcr:content/page/par/cq:authoring
• /etc/designs/geometrixx-media/jcr:content/article/article-content-par/cq:authoring

CÓDIGO NO GITHUB

Você pode encontrar o código desta página no GitHub

• Abra o projeto aem-project-archetype no GitHub
• Baixe o projeto como um arquivo ZIP

Uso da extensão AEM Brackets

A Extensão do Brackets AEM fornece um fluxo de trabalho suave para editar AEM componentes e bibliotecas de clientes. É baseado no editor de código Brackets.

A extensão:

• Facilita a sincronização (sem necessidade de Maven ou File Vault) para ajudar a aumentar a eficiência do desenvolvedor e também ajuda desenvolvedores de front-end com conhecimento de AEM limitado a participar de projetos.
• Fornece suporte HTL, a linguagem de modelo criada para simplificar o desenvolvimento de componentes e aumentar a segurança.

Migração de um componente clássico

Ao migrar um componente projetado para uso com a interface clássica para um componente que pode ser usado com a interface habilitada para toque (individual ou conjuntamente), os seguintes problemas devem ser considerados:

• HTL

  • O uso de HTL não é obrigatório, mas se seu componente precisar de atualização, é um momento ideal para considerar migrar do JSP para HTL.

• Componentes

  • Migrar o código cq:listener que usa funções específicas da interface clássica
  • Plug-in do RTE, para obter mais informações, consulte Configuração do Editor de Rich Text.
  • Migrar cq:listener código que usa funções específicas para a interface clássica

• Caixas de diálogo

  • Você precisará criar uma nova caixa de diálogo para usar na interface do usuário habilitada para toque. No entanto, para fins de compatibilidade, a interface habilitada para toque pode usar a definição de uma caixa de diálogo da interface clássica, quando nenhuma caixa de diálogo tiver sido definida para a interface habilitada para toque.
  • As Ferramentas de Modernização AEM são fornecidas para ajudar a estender os componentes existentes.
  • O mapeamento de ExtJS para os Componentes da interface do usuário do Granite fornece uma visão geral conveniente dos xtypes e tipos de nó do ExtJS com seus tipos de recursos equivalentes da interface do usuário do Granite.
  • Para personalizar campos, para obter mais informações, consulte a sessão Gems AEM em Personalizando campos de diálogo.
  • Migrar de vtypes para Validação da interface do usuário do Granite
  • Usando ouvintes JS, para obter mais informações, consulte Manipulação de eventos de campo e a sessão Gems AEM em Personalização de campos de diálogo.

Migração do cq:listener Code

Se você estiver migrando um projeto projetado para a interface clássica, o código cq:listener (e clientlibs relacionadas a componentes) poderá usar funções específicas para a interface clássica (como CQ.wcm.*). Para a migração, você deve atualizar esse código usando os objetos/funções equivalentes na interface do usuário habilitada para toque.

Se o seu projeto estiver sendo totalmente migrado para a interface habilitada para toque, é necessário substituir esse código para usar os objetos e as funções relevantes para a interface do usuário habilitada para toque.

No entanto, se o projeto precisar atender tanto à interface clássica quanto à interface habilitada para toque durante o período de migração (o cenário normal), será necessário implementar um switch para diferenciar o código separado que faz referência aos objetos apropriados.

Esse mecanismo de switch pode ser implementado como:

if (Granite.author) {
    // touch UI
} else {
    // classic UI
}

Documentação do seu componente

Como desenvolvedor, você deseja obter acesso fácil à documentação do componente, para que possa entender rapidamente:

• Descrição
• Utilização prevista
• Estrutura e propriedades do conteúdo
• APIs e pontos de extensão expostos
• Etc.

Por isso, é muito fácil tornar qualquer marcação de documentação existente disponível no próprio componente.

Basta colocar um arquivo README.md na estrutura do componente. Essa marcação será exibida no console do componente.

O Markdown suportado é o mesmo para fragmentos de conteúdo.