Desenvolvimento de componentes AEM

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

• Quando páginas de criação, 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 do eCommerce 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 conforme necessário aos 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 AEM. Consulte Desenvolvimento de componentes AEM - Exemplos de código para obter alguns exemplos práticos.

Estrutura

A estrutura básica de um componente é abordada na página AEM Componentes - Informaçõ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, pode ajudar a conhecê-las ao herdar dos componentes existentes.

Estendendo componentes e caixas de diálogo existentes

Dependendo do componente que você deseja implementar, talvez seja 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 uma caixa de diálogo existente, é possível copiar ou replicar toda a estrutura ou a estrutura necessária para a caixa de diálogo antes de fazer as alterações.

Extensão de um componente existente

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

Personalizando uma caixa de diálogo de componente existente

Também é possível substituir uma caixa de diálogo componente usando Fusão de Recursos de Sling 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 método agora é recomendado para estender uma caixa de diálogo de componente

Consulte Fusão de recursos Sling para obter mais detalhes.

Definição da marcação

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

Uso da linguagem do modelo HTML

O HTML Templating Language (HTL), introduzido com 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. Ele é chamado das 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 visualização. Também permite lógica diferente para visualizações diferentes do mesmo recurso.

Uso do Java

A HTL Java Use-API permite que um arquivo HTL acesse métodos auxiliares 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 HTL permite que um arquivo HTL acesse o código auxiliar escrito 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.

Usando bibliotecas HTML do lado do cliente

Sites modernos dependem muito do processamento no cliente, conduzido por códigos complexos de JavaScript e CSS. Organizar e otimizar a entrega desse código pode ser um problema complicado.

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

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

Configuração do comportamento de edição

Você pode 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 os ouvintes relacionados aos eventos no componente. A configuração é comum à interface habilitada para toque e clássica, embora com certas diferenças específicas.

O comportamento editar 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 e nós secundários específicos.

Configuração do comportamento de Pré-visualização

O cookie WCM Mode é definido ao alternar para o modo Pré-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 se atualizarem especificamente e, em seguida, dependem do valor do cookie.

Criando e Configurando uma Caixa de Diálogo

As caixas de diálogo são usadas para permitir que o autor interaja com o componente. O uso de 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 Coral e Granite

A interface do usuário do Coral e a interface do usuário do Granite definem 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 mais informações sobre como desenvolver componentes usando os tipos de recursos Coral e Granite, consulte: Construção de componentes Experience Manager usando os tipos de recursos Coral/Granite.

Para obter detalhes completos, consulte:

• Interface do usuário do Coral

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

• Interface do usuário Granite

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

Criando uma Nova Caixa de Diálogo

Caixas de diálogo para a interface habilitada para toque:

• são nomeados 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 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 (isto é, uma marcação renderizada por um script de componente junto com o comportamento/estilo fornecido por uma biblioteca de cliente).

Para obter exemplos, consulte:

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

Personalizar campos de diálogo

Criando um novo campo

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

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

Se você considerar sua caixa de diálogo como um container simples para um elemento de formulário, 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 do usuário do Granite oferta 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 diálogos (ou, de modo mais geral, em formulários).

Depois de criar seu tipo de recurso, você pode instanciar seu campo adicionando um novo nó na caixa de diálogo, com a propriedade sling:resourceType referindo-se ao tipo de recurso que você acabou de apresentar.

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

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

Para que a biblioteca do cliente seja carregada exclusivamente para a caixa de diálogo do seu componente (isto é, ela não será carregada para outro componente), é necessário definir a propriedade extraClientlibs​* da sua caixa de diálogo com 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 seu campo for específico dessa caixa de diálogo e não for necessário em outras caixas de diálogo.

Para que a biblioteca do cliente seja carregada para todas as caixas de diálogo, defina a propriedade de categoria da biblioteca do cliente como cq.authoring.dialog. Esse é o nome da categoria da biblioteca do cliente que é 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 seu 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 pela 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)
• Estenda um determinado widget da biblioteca de widgets subjacente (no caso da interface do usuário Granite, esta é a interface do usuário Coral), seguindo a API da biblioteca de widgets (herança JS/CSS)

Acesso aos campos de diálogo

Você também pode usar 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 manipulação de eventos nos campos de diálogo agora é feito com ouvintes em uma biblioteca cliente personalizada. Esta é uma alteração do método mais antigo de ter ouvintes na estrutura de conteúdo.

Ouvintes em uma biblioteca de clientes personalizada

Para injetar lógica no seu campo, deve:

1. Tenha seu campo marcado com uma determinada classe CSS (o gancho).
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, é necessário saber mais sobre a biblioteca de widgets subjacente com a qual você 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: localize 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 pela Amostra de código

Ouvintes na estrutura de conteúdo

Na interface clássica com ExtJS, era comum ter ouvintes para 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 do conteúdo descreve a estrutura semântica; não deve (deve) implicar a natureza do widget subjacente. Ao não ter o código JS na estrutura de conteúdo, você pode alterar os detalhes da implementação sem precisar alterar a estrutura de conteúdo. Em outras palavras, é possível alterar a biblioteca de widgets sem precisar tocar na estrutura de conteúdo.

Detectando a disponibilidade da caixa de diálogo

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

Esse evento é acionado sempre que a caixa de diálogo é carregada (ou recarregada) e está pronto 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 usado para conectar-se ao 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 seu 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 (IU Granite)

A validação de campo na interface do usuário do Granite e nos Componentes da interface do usuário do Granite (equivalente aos 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 pela Amostra de código

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

Criando e Configurando 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 conteúdo, com a diferença de que ela é definida como um nó:

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

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

Um editor local permite que o usuário edite o 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 Extensão da criação de páginas - 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 Extensão da criação de páginas - Adicionar nova ação a uma barra de ferramentas de componentes para obter mais informações.

Configuração de um componente para o painel Referências (Emprestado/Emprestado)

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 painel Referências.

A AEM predefinida 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

Ativando e adicionando seu componente ao Sistema de parágrafo

Depois que o componente é desenvolvido, ele precisa ser habilitado para uso em um sistema de parágrafo apropriado, para que possa ser usado nas páginas necessárias.

Isso pode ser feito:

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

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

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

Este comportamento e a relação entre ativos e componentes necessária podem ser configurados:

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

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

   Criar um novo nó:

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

2. Sob isso, crie um novo nó para manter todos os mapeamentos ativo-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: público alvo; 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

Para obter exemplos, 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

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

Usando a extensão de colchetes AEM

O AEM Brackets Extension fornece um fluxo de trabalho suave para editar AEM componentes e bibliotecas de clientes. Ele é baseado no editor de códigos Colchetes.

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 os desenvolvedores de front-end com conhecimento AEM limitado a participar de projetos.
• Fornece suporte a HTL, a linguagem de modelo projetada 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 o componente precisar de atualização, então é o momento ideal para considerar migrar do JSP para HTL.

• Componentes

  • Migre o código cq:listener que usa funções específicas da interface clássica
  • Plug-in 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

  • Será necessário criar uma nova caixa de diálogo para usar na interface 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 de interface clássica, quando nenhuma caixa de diálogo tiver sido definida para a interface habilitada para toque.
  • A Ferramenta de conversão de diálogo é fornecida para ajudar a estender os componentes existentes.
  • O mapeamento do ExtJS para os Componentes de IU Granite fornece uma visão geral conveniente dos tipos de ExtJS xtypes e nós com os tipos de recursos equivalentes da IU Granite.
  • Para obter mais informações, consulte a sessão Gems AEM em Personalizando campos de diálogo.
  • Migrar de vtypes para Validação de interface de usuário granular
  • Usando ouvintes JS, para obter mais informações, consulte Tratamento de Eventos de campo e a sessão Gems AEM em Personalização de campos de diálogo.

Migração de cq:código de escuta

Se você estiver migrando um projeto projetado para a interface clássica, o código cq:listener (e clientlibs relacionados 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 habilitada para toque.

Se o seu projeto estiver sendo completamente 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 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 uma opção para diferenciar o código separado que faz referência aos objetos apropriados.

Este mecanismo de comutação pode ser implementado como:

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

Documentando seu componente

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

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

Por essa razão, é muito fácil disponibilizar qualquer marcação de documentação existente no próprio componente.

Tudo o que você precisa fazer é colocar um arquivo README.md na estrutura do componente. Esta marcação será então exibida no console do componente.

A marcação suportada é a mesma para fragmentos de conteúdo.