Desenvolvimento de componentes do AEM developing-aem-components

Os componentes do AEM são usados para reter, formatar e renderizar o conteúdo disponibilizado em 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 AEM. Consulte Desenvolvendo componentes para 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 do AEM - Noções básicas. Esse documento abrange as interfaces habilitadas para toque e as interfaces clássicas. Mesmo que você não precise usar as configurações clássicas no novo componente, pode ser útil estar ciente delas ao herdar de componentes existentes.

Extensão de componentes e caixas de diálogo existentes extending-existing-components-and-dialogs

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 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 as alterações.

Extensão de um componente existente extending-an-existing-component

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

Personalização de uma caixa de diálogo Componente existente customizing-a-existing-component-dialog

Também é possível substituir uma caixa de diálogo de 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). Este método agora é recomendado para estender uma caixa de diálogo de componente

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

Definição da 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 do autor e de publicação.

Uso da Linguagem de modelo do HTML using-the-html-template-language

A Linguagem de Modelo de HTML (HTL), introduzida 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 do conteúdo developing-the-content-logic

Essa lógica opcional seleciona e/ou calcula o conteúdo a ser renderizado. É chamado a partir 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 é necessário para uma determinada visualização. Também permite lógicas diferentes para visualizações diferentes do mesmo recurso.

Uso do Java using-java

A API de uso 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.

Utilização do JavaScript using-javascript

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

Uso de bibliotecas de HTML do lado do cliente using-client-side-html-libraries

Sites modernos dependem muito do processamento do lado do cliente orientado por códigos JavaScript e CSS complexos. 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 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 entregue ao cliente. O sistema de biblioteca do lado do cliente cuida de produzir os links corretos na página final da Web para carregar o código correto.

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

Configuração do 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 os ouvintes relacionados aos eventos no componente. A configuração é comum à interface habilitada para toque e à interface 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 filhos.

Configuração do comportamento de visualização configuring-the-preview-behavior

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

Para componentes com uma renderização sensível ao Modo WCM, eles precisam ser definidos para se atualizarem especificamente e, em seguida, confiar no valor do cookie.

Criando e configurando 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 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-ui-and-granite-ui

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 de componentes básicos (widgets) necessários para criar sua caixa de diálogo no ambiente de criação. Quando necessário, você pode estender esta seleção e criar seu próprio widget.

Para obter detalhes completos, consulte:

Criando uma nova caixa de diálogo creating-a-new-dialog

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

Um exemplo de estrutura de nó 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, pois a caixa de diálogo é, em si, um componente (ou seja, uma marcação renderizada por um script de componente juntamente com o comportamento/estilo fornecido por uma biblioteca do cliente).

Para obter exemplos, consulte:

Personalizar campos de diálogo customizing-dialog-fields

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

Os dispositivos para a interface habilitada para toque são implementados como componentes de interface do Granite.

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

Se você considerar sua caixa de diálogo como um contêiner simples para um elemento de formulário, também poderá ver o conteúdo principal do seu conteúdo da caixa de diálogo como campos de formulário. A criação de um campo de formulário requer a criação de um tipo de recurso; é equivalente à criação de um componente. Para ajudá-lo 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 referindo-se ao tipo de recurso que você acabou de introduzir.

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 componente, crie uma biblioteca do cliente dedicada que defina seu CSS/LESS personalizado e o JS.

Para carregar a biblioteca do cliente exclusivamente 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 como o nome da categoria da biblioteca do cliente criada. Isso é aconselhável se a biblioteca do cliente for muito grande e/ou se o campo for específico para essa caixa de diálogo e não for necessário em outras caixas de diálogo.

Para carregar a 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 que é incluído 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:

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

Dependendo das suas necessidades, você pode:

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

Você também pode 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"]

Manipulação de eventos de campo handling-field-events

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

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

Para inserir lógica no campo, você deve:

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

Para ver um exemplo, consulte:

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

Na interface clássica com ExtJS, era comum ter ouvintes de um determinado widget na estrutura do conteúdo. Fazer o mesmo na interface habilitada para toque é diferente, pois o 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; ela não deve (deve) implicar a natureza do widget subjacente. Ao não ter o código JS na estrutura do conteúdo, é possível 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 de conteúdo.

Detectando Disponibilidade da Caixa de Diálogo dialog-ready

Se você tiver uma JavaScript personalizada que precisa ser executada somente 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 usado 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 (equivalentes a widgets) é feita usando a API foundation-validation. Consulte a documentação do Granite foundation-valdiation para obter detalhes.

Para obter exemplos, consulte:

Criando e configurando uma caixa de diálogo de design creating-and-configuring-a-design-dialog

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

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

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

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 Texto e Título padrão 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 de local para obter mais informações.

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

A Barra de Ferramentas do Componente dá ao usuário acesso a um intervalo 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) configuring-a-component-for-the-references-rail-borrowed-lent

Se o seu 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.

O AEM pronto para uso verifica apenas o componente de Referência. Para adicionar seu componente, você precisa configurar o pacote OSGi Configuração da referência de conteúdo de criação WCM.

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

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

Ativação e adição do 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 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 sua página para que uma instância do seu 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 a relação necessária entre ativo e componente podem ser configurados:

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

A Extensão AEM Brackets fornece um fluxo de trabalho suave para editar componentes AEM e bibliotecas de clientes. Tem como base o editor de código Brackets.

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 (exclusiva ou conjuntamente), os seguintes problemas devem ser considerados:

Migrando o código cq:listener migrating-cq-listener-code

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

Se o projeto estiver sendo completamente migrado para a interface habilitada para toque, será necessário substituir esse código para usar os objetos e funções relevantes para a interface habilitada para toque.

No entanto, se o seu projeto precisar atender à interface clássica e à interface habilitada para toque durante o período de migração (o cenário normal), você deverá implementar uma opção 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 componente documenting-your-component

Como desenvolvedor, você deseja obter acesso fácil à documentação de componentes para compreender rapidamente:

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

Coloque um arquivo README.md na estrutura do componente. Esta marcação é exibida no console do componente.

A marcação com suporte é a mesma que para fragmentos de conteúdo.