Quando um componente em uma página da Web é renderizado, um elemento HTML pode ser gerado, vinculando o componente renderizado dentro de si mesmo. Isso serve principalmente a dois propósitos:
Para desenvolvedores, o AEM oferece lógica simples e clara controlando as tags de decoração que envolvem componentes incluídos. Se e como a tag de decoração é renderizada é definida pela combinação de dois fatores, nos quais essa página se aprofundará:
Estas são algumas recomendações gerais de quando incluir o elemento invólucro que devem ajudar a evitar problemas inesperados:
As seguintes propriedades e nós podem ser aplicados aos componentes para controlar o comportamento da tag de decoração:
cq:noDecoration {boolean}
: Essa propriedade pode ser adicionada a um componente e um valor verdadeiro força o AEM a não gerar elementos do invólucro sobre o componente.cq:htmlTag
nó : Esse nó pode ser adicionado em um componente e pode ter as seguintes propriedades:
cq:tagName {String}
: Isso pode ser usado para especificar uma tag HTML personalizada para ser usada para envolver os componentes em vez do elemento DIV padrão.class {String}
: Isso pode ser usado para especificar nomes de classe css a serem adicionados ao invólucro.Em geral, o comportamento do invólucro no HTL pode ser resumido da seguinte maneira:
data-sly-resource="foo"
).O comportamento do invólucro também pode ser totalmente controlado.
cq:noDecoration
e cq:tagName
) também pode definir a tag do invólucro.É possível controlar totalmente o comportamento das tags do invólucro de scripts HTL e sua lógica associada.
Para obter mais informações sobre como desenvolver em HTL, consulte a Documentação HTL.
Essa árvore decisória resume a lógica que determina o comportamento das tags do invólucro.
Os três casos de uso a seguir fornecem exemplos de como as tags do invólucro são tratadas e também ilustram como é simples controlar o comportamento desejado das tags do invólucro.
Todos os exemplos a seguir pressupõem a seguinte estrutura de conteúdo e componentes:
/content/test/
@resourceType = "test/components/one"
child/
@resourceType = "test/components/two"
/apps/test/components/
one/
one.html
two/
two.html
cq:htmlTag/
@cq:tagName = "article"
@class = "component-two"
O caso de uso mais comum é quando um componente inclui outro componente por motivos de reutilização de código. Nesse caso, o componente incluído não deseja ser editável com sua própria barra de ferramentas e caixa de diálogo, portanto, nenhum invólucro é necessário e as propriedades do componente cq:htmlTag
é ignorado. Esse pode ser considerado o comportamento padrão.
one.html: <sly data-sly-resource="child"></sly>
two.html: Hello World!
Saída resultante em /content/test.html
:
Hello World!
Um exemplo seria um componente que inclui um componente de imagem principal para exibir uma imagem, normalmente nesse caso usando um recurso sintético, que consiste em incluir um componente filho virtual ao passar para o recurso data-sly um objeto de Mapa que representa todas as propriedades que o componente teria.
Outro caso de uso comum é quando componentes de contêiner incluem componentes filhos editáveis, como um Contêiner de layout. Nesse caso, cada filho incluído precisa imperativamente de um invólucro para que o editor funcione (a menos que explicitamente desativado com o cq:noDecoration
propriedade).
Como o componente incluído é, neste caso, um componente independente, ele precisa de um elemento wrapper para que o editor funcione e para definir seu layout e estilo a serem aplicados. Para acionar esse comportamento, há a decoration=true
opção.
one.html: <sly data-sly-resource="${'child' @ decoration=true}"></sly>
two.html: Hello World!
Saída resultante em /content/test.html
:
<article class="component-two">Hello World!</article>
Pode haver qualquer número de casos complexos, que podem ser facilmente obtidos com a possibilidade de o HTL fornecer explicitamente:
decorationTagName='ELEMENT_NAME'
Para definir o nome do elemento do invólucro.cssClassName='CLASS_NAME'
Para definir os nomes de classe CSS a serem definidos nela.one.html: <sly data-sly-resource="${'child' @ decorationTagName='aside', cssClassName='child'}"></sly>
two.html: Hello World!
Saída resultante /content/test.html
:
<aside class="child">Hello World!</aside>