Guia de referência de componentes

Os componentes estão no centro da criação de uma experiência no AEM. Os Componentes principais e o Arquétipo de projeto AEM simplificam a introdução a um conjunto de ferramentas de componentes robustos e prontos. O Tutorial WKND leva o desenvolvedor a usar essas ferramentas e como criar componentes personalizados para criar um novo site de AEM.

Como o tutorial WKND aborda a maioria dos casos de uso, este documento destina-se somente a complementar esses recursos. Ele fornece especificações técnicas detalhadas sobre como os componentes são estruturados e configurados em AEM e não se destina a ser um guia de introdução.

Visão geral

Esta seção aborda os principais conceitos e problemas como uma introdução aos detalhes necessários ao desenvolver seus próprios componentes.

Planejamento

Antes de começar a realmente configurar ou codificar seu componente, você deve perguntar:

• O que exatamente você precisa que o novo componente faça?
• Você precisa criar seu componente do zero ou pode herdar as noções básicas de um componente existente?
• Seu componente precisará de lógica para selecionar/manipular o conteúdo?
  • A lógica deve ser mantida separada da camada da interface do usuário. O HTL foi projetado para ajudar a garantir que isso aconteça.
• Seu componente precisará de formatação CSS?
  • A formatação de CSS deve ser mantida separada das definições do componente. Defina convenções para nomear seus elementos HTML para modificá-los por meio de arquivos CSS externos.
• Quais implicações de segurança o novo componente pode apresentar?

Reutilizar componentes existentes

Antes de investir tempo na criação de um componente totalmente novo, considere personalizar ou estender os componentes existentes. O Componente principal oferece um conjunto de componentes flexíveis, robustos e bem testados e prontos para produção.

Estender componentes principais

Os Componentes principais também oferecem padrões de personalização claros que você pode usar para adaptá-los às necessidades do seu próprio projeto.

Sobreposição de componentes

Os componentes também podem ser redefinidos com uma sobreposição com base na lógica do caminho de pesquisa. No entanto, nesse caso, o Sling Resource Merger não será acionado e /apps deverá definir toda a sobreposição.

Extensão de caixas de diálogo de componentes

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.

Marcação da lógica de conteúdo e renderizaçã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.

É recomendável manter o código responsável pela marcação e renderização separadas do código que controla a lógica usada para selecionar o conteúdo do componente.

Essa filosofia é suportada pelo HTL, uma linguagem de modelo que é propositalmente limitada para garantir que uma linguagem de programação real seja usada para definir a lógica de negócios subjacente. Esse mecanismo destaca o código chamado para uma determinada visualização e, se necessário, permite uma lógica específica para diferentes visualizações do mesmo componente.

Essa lógica (opcional) pode ser implementada de diferentes maneiras e é invocada do HTL com comandos específicos:

• Usando 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 - 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 do lado do cliente - Sites modernos dependem muito do processamento no lado do cliente impulsionado por códigos complexos de JavaScript e CSS. Consulte o documento Usar bibliotecas do lado do cliente no AEM como um Cloud Service para obter mais informações.

Estrutura do componente

A estrutura de um componente de AEM é poderosa e flexível. As principais partes são:

• Tipo de recurso
• Definição do componente
• Propriedades e nós secundários de um componente
• Caixas de diálogo
• Caixas de diálogo de design

Tipo de recurso

Um elemento-chave da estrutura é o tipo de recurso.

• A estrutura de conteúdo declara intenções.
• O tipo de recurso os implementa.

Essa é uma abstração que ajuda a garantir que, mesmo quando a aparência muda com o tempo, a intenção permanece o tempo.

Definição do componente

A definição de um componente pode ser dividida da seguinte maneira:

• AEM componentes são baseados em Sling.
• AEM componentes estão localizados em /libs/core/wcm/components.
• Os componentes específicos do projeto/site estão localizados em /apps/<myApp>/components.
• AEM componentes padrão são definidos como cq:Component e têm os elementos principais:
  • propriedades do jcr - Uma lista de propriedades do jcr. Elas são variáveis e algumas podem ser opcionais se a estrutura básica de um nó de componente, suas propriedades e subnós forem definidos pela definição cq:Component.
  • Recursos - Eles definem elementos estáticos usados pelo componente.
  • Scripts - São usados para implementar o comportamento da instância resultante do componente.

Propriedades vitais

• Nó raiz:
  • <mycomponent> (cq:Component) - Nó de hierarquia do componente.
• Propriedades vitais:
  • jcr:title - Título do componente; por exemplo, usado como um rótulo quando o componente está listado no console Componentes e no console Componentes
  • jcr:description - Descrição do componente; usado como dica de mouse sobre o console Navegador de componentes e Componentes
  • Consulte a seção Ícone do componente para obter detalhes
• Nós Secundários Vitais:
  • cq:editConfig (cq:EditConfig) - Define as propriedades de edição do componente e permite que o componente apareça no Navegador de componentes
    • Se o componente tiver uma caixa de diálogo, ela aparecerá automaticamente no navegador Componentes ou no Sidekick, mesmo se cq:editConfig não existir.
  • cq:childEditConfig (cq:EditConfig) - Controla os aspectos da interface do usuário do autor para componentes filhos que não definem seus próprios cq:editConfig.
  • cq:dialog (nt:unstructured) - Caixa de diálogo desse componente. Define a interface que permite ao usuário configurar o componente e/ou editar conteúdo.
  • cq:design_dialog (nt:unstructured) - Edição de design para este componente

Ícone do componente

O ícone ou a abreviação do componente é definido por meio das propriedades do JCR do componente quando ele é criado pelo desenvolvedor. Essas propriedades são avaliadas na ordem a seguir e a primeira propriedade válida encontrada é usada.

1. cq:icon - Propriedade de string que aponta para um ícone padrão na biblioteca da interface do usuário do Coral para exibir no navegador de componente
   • Use o valor do atributo HTML do ícone Coral.
2. abbreviation - Propriedade String para personalizar a abreviação do nome do componente no navegador do componente
   • A abreviação deve ser limitada a dois caracteres.
   • Fornecer uma string vazia criará a abreviação dos dois primeiros caracteres da propriedade jcr:title .
     • Por exemplo, "Im" para "Image"
     • O título localizado será usado para criar a abreviação.
   • A abreviação só é traduzida se o componente tiver uma propriedade abbreviation_commentI18n , que é usada como dica de tradução.
3. cq:icon.png ou cq:icon.svg - Ícone para este componente, que é mostrado no Navegador de componentes
   • 20 x 20 pixels é o tamanho dos ícones dos componentes padrão.
     • Os ícones maiores serão baixados (no lado do cliente).
   • A cor recomendada é rgb(112, 112, 112) > #707070
   • O plano de fundo dos ícones de componentes padrão é transparente.
   • Somente os arquivos .png e .svg são compatíveis.
   • Ao importar do sistema de arquivos por meio do plug-in Eclipse, os nomes de arquivo precisam ser escapados como _cq_icon.png ou _cq_icon.svg, por exemplo.
   • .png tem precedência sobre .svg se ambos estiverem presentes.

Se nenhuma das propriedades acima (cq:icon, abbreviation, cq:icon.png ou cq:icon.svg) for encontrada no componente:

• O sistema pesquisará as mesmas propriedades nos supercomponentes após a propriedade sling:resourceSuperType .
• Se nada ou uma abreviação vazia for encontrada no nível do supercomponente, o sistema criará a abreviação das primeiras letras da propriedade jcr:title do componente atual.

Para cancelar a herança de ícones dos supercomponentes, definir uma propriedade abbreviation vazia no componente reverterá para o comportamento padrão.

O Console de Componentes exibe como o ícone de um componente específico é definido.

Exemplo de ícone SVG

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "https://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="https://www.w3.org/2000/svg" xmlns:xlink="https://www.w3.org/1999/xlink" x="0px" y="0px"
     width="20px" height="20px" viewBox="0 0 20 20" enable-background="new 0 0 20 20" xml:space="preserve">
    <ellipse cx="5" cy="5" rx="3" ry="3" fill="#707070"/>
    <ellipse cx="15" cy="5" rx="4" ry="4" fill="#707070"/>
    <ellipse cx="5" cy="15" rx="5" ry="5" fill="#707070"/>
    <ellipse cx="15" cy="15" rx="4" ry="4" fill="#707070"/>
</svg>

Propriedades e nós secundários de um componente

Muitos dos nós/propriedades necessários para definir um componente são comuns a ambas as interfaces do usuário, com diferenças que permanecem independentes para que seu componente possa funcionar em ambos os ambientes.

Um componente é um nó do tipo cq:Component e tem as seguintes propriedades e nós secundários:

Se observarmos o componente Text, podemos ver vários desses elementos:

As propriedades de interesses específicos incluem:

• jcr:title - Este é o título do componente usado para identificar o componente no Navegador de componentes.
• jcr:description - Esta é a descrição do componente.
• sling:resourceSuperType - Indica o caminho da herança ao estender um componente (substituindo uma definição).

Os nós filhos de interesse especial incluem:

• cq:editConfig - Isso controla os aspectos visuais do componente durante a edição.
• cq:dialog - Isso define a caixa de diálogo para edição de conteúdo desse componente.
• cq:design_dialog - Especifica as opções de edição de design para este componente.

Caixas de diálogo

As caixas de diálogo são um elemento essencial do seu componente, pois fornecem uma interface para os autores configurar o componente em uma página de conteúdo e fornecer entrada para esse componente. Consulte a documentação de criação para obter detalhes sobre como os autores de conteúdo interagem com componentes.

Dependendo da complexidade do componente, a caixa de diálogo pode precisar de uma ou mais guias.

Caixas de diálogo para componentes AEM:

• São nós cq:dialog do tipo nt:unstructured.
• Estão localizados em seus nós cq:Component e ao lado de suas definições de componente.
• Defina a caixa de diálogo para editar o conteúdo desse componente.
• São definidas usando componentes da interface do usuário do Granite.
• São renderizados do lado do servidor (como componentes do Sling), com base em sua estrutura de conteúdo e na propriedade sling:resourceType .
• 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.

Na caixa de diálogo , campos individuais são definidos:

Caixas de diálogo de design

As caixas de diálogo de design são semelhantes às caixas de diálogo usadas para editar e configurar o conteúdo, mas fornecem a interface para os autores de modelo pró-configurar e fornecer detalhes de design para esse componente em um modelo de página. Os modelos de página são então usados pelos autores de conteúdo para criar páginas de conteúdo. Consulte a documentação do modelo para obter detalhes sobre como os modelos são criados.

As caixas de diálogo Design são usadas ao editar um modelo de página, embora não sejam necessárias para todos os componentes. Por exemplo, os Título e Componentes de imagem têm caixas de diálogo de design, enquanto o Componente de compartilhamento de mídia social não.

Interface do usuário do Coral e do Granite

A interface do usuário do Coral e a interface do Granite definem a aparência do AEM.

• A interface do usuário do Coral fornece uma interface consistente em todas as soluções de nuvem.
• A interface de usuário do Granite fornece marcação de interface de usuário Coral embutida em componentes do Sling para criar consoles e caixas de diálogo da interface de usuário.

A interface do usuário do Granite fornece uma grande variedade de widgets básicos necessários 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 adicionais, consulte os seguintes recursos:

• Estrutura da interface AEM

Personalização de campos de diálogo

Para criar um novo widget para uso em uma caixa de diálogo de componente, é 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 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 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 acabou de apresentar.

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"]

Uso de componentes

Depois de criar um componente, é necessário ativá-lo para usá-lo. Usar isso mostra como a estrutura do componente está relacionada à estrutura do conteúdo resultante no repositório.

Adicionar seu componente ao modelo

Depois que um componente é definido, ele deve ser disponibilizado para uso. Para disponibilizar um componente para uso em um modelo, você deve habilitar o componente na política do contêiner de layout do modelo.

Consulte a documentação do modelo para obter detalhes sobre como os modelos são criados.

Componentes e o conteúdo que eles criam

Se criarmos e configurarmos uma instância do componente Title na página: /content/wknd/language-masters/en/adventures/extreme-ironing.html

Então podemos ver a estrutura do conteúdo criado no repositório:

Especificamente, se você observar o texto real de um Componente de Título:

• O conteúdo contém uma propriedade jcr:title contendo o texto real do título inserido pelo autor.
• Ela também contém uma referência sling:resourceType para a definição do componente.

As propriedades definidas dependem das definições individuais. Embora possam ser mais complexas do que acima, continuam a seguir os mesmos princípios básicos.

Hierarquia e herança de componentes

Os componentes dentro de AEM estão sujeitos à Hierarquia do tipo de recurso. Isso é usado para estender componentes usando a propriedade sling:resourceSuperType. Isso permite que o componente herde de outro componente.

Consulte a seção Reutilizar componentes para obter mais informações.

Editar comportamento

Esta seção explica como configurar o comportamento de edição de um componente. Isso inclui atributos como ações disponíveis para o componente, características do editor in.place e os ouvintes relacionados a eventos no componente.

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. As seguintes propriedades e nós secundários estão disponíveis:

• cq:editConfig propriedades do nó
• cq:editConfig nós filhos:
  • cq:dropTargets (tipo de nó nt:unstructured): define uma lista de destinos de soltar que podem aceitar uma queda de um ativo do localizador de conteúdo (um único destino de soltar é permitido)
  • cq:inplaceEditing (tipo de nó cq:InplaceEditingConfig): define uma configuração de edição no local para o componente
  • cq:listeners (tipo de nó cq:EditListenersConfig): define o que acontece antes ou depois que uma ação ocorre no componente

Há muitas configurações existentes no AEM. Você pode pesquisar facilmente propriedades específicas ou nós secundários usando a ferramenta Query em CRXDE Lite.

Espaços reservados do componente

Os componentes devem sempre renderizar algum HTML que esteja visível para o autor, mesmo quando o componente não tiver conteúdo. Caso contrário, pode desaparecer visualmente da interface do editor, tornando-a tecnicamente presente, mas invisível, na página e no editor. Nesse caso, os autores não poderão selecionar e interagir com o componente vazio.

Por isso, os componentes devem renderizar um espaço reservado, desde que não renderizem nenhuma saída visível quando a página for renderizada no editor de páginas (quando o modo WCM for edit ou preview).
A marcação HTML típica para um espaço reservado é a seguinte:

<div class="cq-placeholder" data-emptytext="Component Name"></div>

O script HTL típico que renderiza o HTML de espaço reservado acima é o seguinte:

<div class="cq-placeholder" data-emptytext="${component.properties.jcr:title}"
     data-sly-test="${(wcmmode.edit || wcmmode.preview) && isEmpty}"></div>

No exemplo anterior, isEmpty é uma variável que é verdadeira somente quando o componente não tem conteúdo e é invisível para o autor.

Para evitar a repetição, o Adobe recomenda que os implementadores de componentes usem um modelo HTL para esses espaços reservados, como o fornecido pelos Componentes principais.

O uso do template no link anterior é feito com a seguinte linha de HTL:

<sly data-sly-use.template="core/wcm/components/commons/v1/templates.html"
     data-sly-call="${template.placeholder @ isEmpty=!model.text}"></sly>

No exemplo anterior, model.text é a variável que é verdadeira somente quando o conteúdo tem conteúdo e é visível.

Um exemplo de uso desse modelo pode ser visto nos Componentes principais, como no Componente de título.

Configurar com cq:EditConfig Child Nodes

Soltar ativos em uma caixa de diálogo - cq:dropTargets

O nó cq:dropTargets (tipo de nó nt:unstructured) define o destino de soltar que pode aceitar uma queda de um ativo arrastado do localizador de conteúdo. É um nó do tipo cq:DropTargetConfig.

O nó filho do tipo cq:DropTargetConfig define um destino de soltar no componente.

Edição no local - cq:inplaceEditing

Um editor local permite que o usuário edite conteúdo diretamente no fluxo de conteúdo, sem a necessidade de abrir uma caixa de diálogo. Por exemplo, os componentes padrão Text e Title têm um editor inp-lace.

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

O nó cq:inplaceEditing (tipo de nó cq:InplaceEditingConfig) define uma configuração de edição no local para o componente. Pode ter as seguintes propriedades:

A configuração a seguir permite a edição no local do componente e define plaintext como o tipo de editor:

    <cq:inplaceEditing
        jcr:primaryType="cq:InplaceEditingConfig"
        active="{Boolean}true"
        editorType="plaintext"/>

Tratamento de eventos de campo - cq:listeners

O método de tratamento de eventos em campos de diálogo é feito com ouvintes em uma biblioteca cliente personalizada .

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

• Marque seu campo com uma determinada classe CSS (o gancho).
• 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 do Coral para identificar a qual evento você deseja reagir.

O nó cq:listeners (tipo de nó cq:EditListenersConfig) define o que acontece antes ou depois de uma ação no componente. A tabela a seguir define suas possíveis propriedades.

O manipulador de eventos pode ser implementado com uma implementação personalizada. Por exemplo (onde project.customerAction é um método estático):

afteredit = "project.customerAction"

O exemplo a seguir é equivalente à configuração REFRESH_INSERTED :

afterinsert="function(path, definition) { this.refreshCreated(path, definition); }"

Com a seguinte configuração, a página é atualizada após o componente ter sido excluído, editado, inserido ou movido:

    <cq:listeners
        jcr:primaryType="cq:EditListenersConfig"
        afterdelete="REFRESH_PAGE"
        afteredit="REFRESH_PAGE"
        afterinsert="REFRESH_PAGE"
        afterMove="REFRESH_PAGE"/>

Validação de campo

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

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.

Comportamento de visualização

O cookie Modo WCM é definido ao alternar para o modo de 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.

Documentação de componentes

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

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