Desenvolvimento de componentes de AEM developing-aem-components

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

Amostras de código code-samples

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 structure

A estrutura básica de um componente é abordada na página Componentes AEM - 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 extending-existing-components-and-dialogs

Dependendo do componente que você deseja implementar, pode ser possível estender ou personalizar uma instância existente, em vez de definir e desenvolver o 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 extending-an-existing-component

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 customizing-a-existing-component-dialog

Também é possível substituir um caixa de diálogo do componente usando o Fusão de Recursos Sling e definição da 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 a Fusão de Recursos Sling para obter mais detalhes.

Como definir a marcação defining-the-markup

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.

Utilização da Linguagem de Modelo do HTML using-the-html-template-language

O Linguagem de modelo de HTML (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 o 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 developing-the-content-logic

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 using-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.

Uso do JavaScript using-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 using-client-side-html-libraries

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, AEM fornece Pastas de bibliotecas 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.

Ler Usar bibliotecas HTML do lado do cliente para obter mais informações.

Configurar o comportamento de edição configuring-the-edit-behavior

É 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 editar o comportamento de um componente está configurado adicionando uma cq:editConfig nó 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 configuring-the-preview-behavior

O Modo WCM cookie é definido ao alternar para Visualizar 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 creating-and-configuring-a-dialog

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 o conteúdo, configurem o componente ou definam parâmetros de design (usando um Caixa de diálogo Design)

Interface do usuário do Coral e do Granite coral-ui-and-granite-ui

Interface do usuário do Coral e Interface do usuário do Granite defina a aparência moderna do AEM.

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

Para obter detalhes completos, consulte:

Criação de uma nova caixa de diálogo creating-a-new-dialog

Caixas de diálogo da interface habilitada para toque:

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:

Personalização de campos de diálogo customizing-dialog-fields

Criação de um novo campo creating-a-new-field

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 uso em uma caixa de diálogo de componentes para a interface habilitada para toque, é necessário criar um novo componente de campo da interface do usuário 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 ajudar você nessa tarefa, a interface do 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 formulários).

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 referência ao tipo de recurso que acabou de apresentar.

Criação de uma biblioteca do cliente para estilo e comportamento creating-a-client-library-for-style-and-behavior

Se quiser definir o estilo e o comportamento do seu componente, é possível criar um biblioteca do cliente que define 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 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 como 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:

Estender (Herdar de) um campo extending-inheriting-from-a-field

Dependendo dos seus requisitos, você pode:

Acesso aos campos de diálogo access-to-dialog-fields

Também é possível 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 handling-field-events

O método de tratamento de eventos em campos de diálogo agora é feito com ouvintes em uma biblioteca cliente personalizada. Isso é uma mudança no método antigo de ter ouvintes na estrutura do conteúdo.

Ouvintes em uma biblioteca personalizada do cliente listeners-in-a-custom-client-library

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

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 do 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:

Ouvintes na estrutura do conteúdo listeners-in-the-content-structure

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 dialog-ready

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

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 field-validation

Campo Obrigatório mandatory-field

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

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) field-validation-granite-ui

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 o foundation-validation API. Consulte a foundation-valdiation Documentação do Granite para obter detalhes.

Para obter exemplos, consulte:

Criação e configuração de uma caixa de diálogo de design creating-and-configuring-a-design-dialog

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 um caixa de diálogo usada para editar conteúdo, com a diferença de que é definido como um nó:

Criação e configuração de um editor no local creating-and-configuring-an-inplace-editor

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 Extensão da criação de página - Adicionar novo editor local para obter mais informações.

Personalização da barra de ferramentas do componente customizing-the-component-toolbar

O 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.

Configurar um componente para o painel de referências (emprestado/concedido) configuring-a-component-for-the-references-rail-borrowed-lent

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

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 enabling-and-adding-your-component-to-the-paragraph-system

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:

Configurar um sistema de parágrafo para que a arrastar um ativo crie uma instância de componente configuring-a-paragraph-system-so-that-dragging-an-asset-creates-a-component-instance

O AEM oferece a possibilidade de configurar um sistema de parágrafo na página para que uma instância do novo componente é criada automaticamente 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).

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

Por exemplo, consulte:

CÓDIGO NO GITHUB

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

Uso da extensão AEM Brackets using-the-aem-brackets-extension

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

A extensão:

Migração de um componente clássico migrating-from-a-classic-component

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:

Migração do cq:listener Code migrating-cq-listener-code

Se você estiver migrando um projeto que foi criado para a interface clássica, então a variável cq:listener código (e clientlibs relacionadas a componentes) pode 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 documenting-your-component

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

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

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

O Markdown suportado é igual ao do fragmentos de conteúdo.