Quando um componente em uma página da Web é renderizado, um elemento HTML pode ser gerado, vinculando o componente renderizado dentro dele mesmo. Isto serve principalmente dois objetivos:
Um componente só pode ser editado quando estiver envolvido com um elemento HTML.
O elemento de vinculação é usado para aplicar classes HTML que fornecem:
Para desenvolvedores, AEM lógica simples e clara do oferta 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, que esta página dividirá em:
Estas são algumas recomendações gerais de quando incluir o elemento wrapper que deve ajudar a evitar problemas inesperados:
As seguintes propriedades e nós podem ser aplicados aos componentes para controlar o comportamento de sua tag de decoração:
cq:noDecoration {boolean}
: Essa propriedade pode ser adicionada a um componente e um valor real força AEM não gerar elementos de invólucro sobre o componente.cq:htmlTag
node: Este 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 a ser usada para vincular 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.O comportamento do invólucro difere, no entanto, dependendo se HTL ou JSP for usado para incluir o elemento.
Em geral, o comportamento do invólucro em HTL pode ser resumido da seguinte forma:
data-sly-resource="foo"
).O comportamento do invólucro também pode ser totalmente controlado.
cq:noDecoration
e cq:tagName
) também podem definir a tag do invólucro.É possível controlar totalmente o comportamento das tags de wrapper dos scripts HTL e sua lógica associada.
Para obter mais informações sobre o desenvolvimento em HTL, consulte a documentação HTL.
Essa árvore decisória resume a lógica que determina o comportamento das tags de invólucro.
Os três casos de uso a seguir fornecem exemplos de como as tags de invólucro são manipuladas e também ilustram como é simples controlar o comportamento desejado das tags de 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 do código. Nesse caso, o componente incluído não é desejado para ser editável com sua própria barra de ferramentas e caixa de diálogo, portanto, nenhum invólucro é necessário e o cq:htmlTag
do componente será ignorado. Isso 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 transmitindo para o recurso inteligente de dados um objeto de mapa que representa todas as propriedades que o componente teria.
Outro caso de uso comum é quando os componentes do container incluem componentes filhos editáveis, como um Container de layout. Nesse caso, cada filho incluído precisa imperativamente de um invólucro para que o editor funcione (a menos que explicitamente desabilitado com a propriedade cq:noDecoration
).
Como o componente incluído é, nesse caso, um componente independente, ele precisa de um elemento de invólucro para que o editor funcione e defina seu layout e estilo para aplicar. Para acionar esse comportamento, há a opção decoration=true
.
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 vários casos complexos, que podem ser facilmente alcançados através da possibilidade de 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.one.html: <sly data-sly-resource="${'child' @ decorationTagName='aside', cssClassName='child'}"></sly>
two.html: Hello World!
Resultado /content/test.html
:
<aside class="child">Hello World!</aside>
Ao incluir um componente usando cq:includ
e ou sling:include
, o comportamento padrão no AEM é usar um DIV para vincular o elemento. No entanto, essa vinculação pode ser personalizada de duas formas:
cq:noDecoration
.cq:htmlTag
/ cq:tagName
ou decorationTagName
.A árvore decisória a seguir ilustra como cq:noDecoration
, cq:htmlTag
, cq:tagName
e decorationTagName
afetam o comportamento do invólucro.