Guia de referência de componentes components-reference-guide

Os componentes são o núcleo 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 do WKND orienta o desenvolvedor sobre como usar essas ferramentas e como criar componentes personalizados para criar um site de AEM.

Como o Tutorial WKND aborda a maioria dos casos de uso, este documento serve apenas como um complemento para esses recursos. Ele fornece especificações técnicas detalhadas sobre como os componentes são estruturados e configurados no AEM e não tem a intenção de ser um guia de introdução.

Visão geral overview

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

Planejamento planning

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

Reutilizar componentes existentes reusing-components

Antes de investir tempo na criação de um componente totalmente novo, considere personalizar ou estender componentes existentes. Os Componentes principais oferecem um conjunto de componentes flexíveis, robustos e bem testados, prontos para produção.

Extensão dos Componentes principais extending-core-components

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 overlying-components

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 deve definir toda a sobreposição.

Extensão de caixas de diálogo do componente extending-component-dialogs

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.

Lógica de conteúdo e marcação de renderização content-logic-and-rendering-markup

Seu componente é renderizado com HTML. Seu componente deve 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.

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

Esta 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 exibição e, se necessário, permite uma lógica específica para diferentes exibições do mesmo componente.

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

Estrutura do componente structure

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

Tipo de recurso resource-type

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

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

Definição de componente component-definition

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

Propriedades vitais vital-properties

Ícone do componente component-icon

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

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

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 do SVG svg-icon-example

<?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 filhos de um componente properties-and-child-nodes-of-a-component

Muitos nós/propriedades necessários para definir um componente são comuns a ambas as interfaces do usuário, com diferenças permanecendo 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 filhos:

Se você observar o componente Texto, verá vários destes elementos:

As propriedades de particular interesse incluem:

Os nós filhos de interesse específico incluem:

Caixas de diálogo dialogs

As caixas de diálogo são um elemento essencial do componente, pois fornecem uma interface para os autores configurarem o componente em uma página de conteúdo e fornecem 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, sua caixa de diálogo pode precisar de uma ou mais guias.

Caixas de diálogo para componentes do AEM:

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

Caixas de diálogo de design design-dialogs

As caixas de diálogo de design são semelhantes às caixas de diálogo usadas para editar e configurar conteúdo, mas fornecem a interface para que os autores de modelo pré-configurem e forneçam detalhes de design para esse componente em um modelo de página. Os modelos de página sã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 de design são usadas ao editar um modelo de página, embora não sejam necessárias para todos os componentes. Por exemplo, o Título e os Componentes de Imagem têm caixas de diálogo de design, enquanto o Componente de Compartilhamento de Redes Sociais não.

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

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

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:

Personalizar campos de diálogo customizing-dialog-fields

Para criar um widget para uso em uma caixa de diálogo de componente, é 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 novo campo de formulário requer a criação de um tipo de recurso; isso é 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 um 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.

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

Uso de componentes using-components

Depois de criar um componente, você deve ativá-lo para usá-lo. Seu uso mostra como a estrutura do componente está relacionada à estrutura do conteúdo resultante no repositório.

Adicionar o componente ao modelo adding-your-component-to-the-template

Depois que um componente é definido, ele deve ser disponibilizado para uso. Para disponibilizar um componente para uso em um modelo, você deve ativar 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 components-and-the-content-they-create

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

Assim, podemos ver a estrutura do conteúdo criado no repositório:

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

As propriedades definidas dependem das definições individuais. Embora possam ser mais complexas do que as anteriores, seguem ainda os mesmos princípios básicos.

Hierarquia e herança do componente component-hierarchy-and-inheritance

Os componentes dentro do AEM estão sujeitos à Hierarquia de 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 Reutilizando Componentes para obter mais informações.

Editar comportamento edit-behavior

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

Há muitas configurações existentes no AEM. Você pode pesquisar facilmente por propriedades específicas ou nós filhos usando a Ferramenta de consulta em CRXDE Lite.

Marcadores de posição do componente component-placeholders

Os componentes sempre devem renderizar algum HTML que esteja visível para o autor, mesmo quando o componente não tiver conteúdo. Caso contrário, ela pode desaparecer visualmente da interface do editor, tornando-se 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 esse motivo, 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 de HTML típica de 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 só é verdadeira quando o componente não tem conteúdo e está invisível para o autor.

Para evitar 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 modelo 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 só é verdadeira quando o conteúdo tem conteúdo e está visível.

Um exemplo de uso deste modelo pode ser visto nos Componentes Principais, como no Componente de Título.

Configuração com nós filhos cq:EditConfig configuring-with-cq-editconfig-child-nodes

Soltar o Assets em uma caixa de diálogo - cq:dropTargets cq-droptargets

O nó cq:dropTargets (tipo de nó nt:unstructured) define o destino de soltar que pode aceitar um soltar 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 liberação no componente.

Edição no local - cq:inplaceEditing cq-inplaceediting

Um editor local permite que o usuário edite o conteúdo diretamente no fluxo de conteúdo, 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.

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

A configuração a seguir habilita 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"/>

Manipulação de eventos de campo - cq:listeners cq-listeners

O método de manipulação de eventos em campos de diálogo é feito com ouvintes em uma biblioteca do cliente personalizada.

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.

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 depois que o componente é 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 field-validation

A validação de campos na interface do usuário do Granite e nos widgets da interface do 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 dialog-ready

Se você tiver uma JavaScript personalizada que deve 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.

Comportamento de visualização preview-behavior

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

Documentação de componentes documenting-components

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

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

Tudo o que você precisa fazer é colocar um arquivo README.md na estrutura do componente.

Esta marcação será exibida no Console de Componentes.

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