Sistema de estilos style-system
O sistema de estilos permite ao autor do modelo definir classes de estilo na política de conteúdo de um componente para que autores de conteúdo possam selecioná-las ao editarem o componente em uma página. Esses estilos podem ser variações visuais alternativas de um componente, tornando esse componente mais flexível.
Isso elimina a necessidade de desenvolver um componente personalizado para cada estilo ou personalizar a caixa de diálogo do componente para habilitar essa funcionalidade de estilo. Isso resulta em mais componentes reutilizáveis que podem ser adaptados de forma rápida e fácil às necessidades de autores(as) de conteúdo sem nenhum desenvolvimento de back-end do AEM.
Caso de uso use-case
Os autores de modelo não precisam apenas da capacidade de configurar como os componentes funcionam para os autores de conteúdo, mas também de configurar várias variações visuais alternativas de um componente.
Da mesma forma, autores(as) de conteúdo precisam não apenas da capacidade de estruturar e organizar seu conteúdo, mas também de escolher como ele será apresentado visualmente.
O Sistema de estilos fornece uma solução unificada para os requisitos do autor de modelo e do autor de conteúdo:
- Autores(as) de modelos podem definir classes de estilo na política de conteúdo dos componentes.
- Os autores de conteúdo podem então selecionar essas classes em uma lista suspensa ao editar o componente em uma página para aplicar os estilos correspondentes.
A classe de estilo é então inserida no elemento de wrapper de decoração do componente para que o(a) desenvolvedor(a) do componente não precise se preocupar em manipular os estilos além de fornecer suas regras CSS.
Visão geral overview
O uso do Sistema de estilos geralmente funciona da seguinte maneira.
-
O web designer cria diferentes variações visuais de um componente.
-
O desenvolvedor de HTML recebe a saída dos componentes em HTML e as variações visuais desejadas para implementar.
-
O desenvolvedor de HTML define as classes CSS que correspondem a cada variação visual e que devem ser inseridas no elemento que envolve os componentes.
-
O desenvolvedor de HTML implementa o código CSS correspondente (e, opcionalmente, o código JS) para cada uma das variações visuais, de modo a serem exibidas conforme a definição.
-
O desenvolvedor do AEM coloca o CSS fornecido (e o JS opcional) em uma Biblioteca do cliente e a implanta.
-
O desenvolvedor do AEM ou o autor do modelo define os modelos de página e edita a política de cada componente estilizado, adicionando as classes CSS definidas, fornecendo nomes amigáveis a cada estilo e indicando quais estilos podem ser combinados.
-
O autor da página do AEM pode escolher os estilos criados no editor de páginas no menu de estilo da barra de ferramentas do componente.
Observe que apenas as três últimas etapas são realizadas no AEM. Isso significa que todo o desenvolvimento de CSS e JavaScript necessários pode ser feito sem o AEM.
Na verdade, a implementação de estilos requer apenas a implantação no AEM e a seleção dos componentes dos modelos desejados.
O diagrama a seguir ilustra a arquitetura do Sistema de estilos.
Utilização use
Para demonstrar o recurso, usaremos como exemplo a implementação da WKND do componente de título do componente principal.
As seções a seguir, Como um autor de conteúdo e Como um autor de modelo descrevem como testar a funcionalidade do Sistema de estilos usando o Sistema de estilos da WKND.
Se você desejar usar o Sistema de estilos em seus próprios componentes, faça o seguinte:
- Instale o CSS como bibliotecas de clientes, conforme discutido na seção Visão geral.
- Configure as classes CSS que deseja disponibilizar para autores(as) de conteúdo, conforme descrito na seção Como autor(a) de modelo.
- Autores(as) de conteúdo podem usar os estilos conforme descrito na seção Como autor(a) de conteúdo.
Como autor de conteúdo as-a-content-author
-
Depois de instalar o projeto WKND, navegue até a página inicial principal no idioma inglês da WKND em
http://<host>:<port>/sites.html/content/wknd/language-masters/ene edite a página. -
Selecione um componente de Título mais abaixo da página
-
Clique no botão Estilos na barra de ferramentas do componente Lista para abrir o menu de estilos e alterar a aparência do componente.
note note NOTE Neste exemplo, os estilos de Cores (Preto, Branco e Cinza) são mutuamente exclusivos, enquanto as opções de Estilo (Sublinhado, Alinhar à direita e Miniespaçamento) podem ser combinadas. Isso pode ser configurado no modelo como o autor do modelo.
Como autor de modelo as-a-template-author
-
Ao editar a página inicial mestra no idioma inglês do WKND em
http://<host>:<port>/sites.html/content/wknd/language-masters/en, edite o modelo da página em Informações da página > Editar modelo.
-
Edite a política do componente de Título tocando ou clicando no botão Política do componente.
-
Na guia Estilos das propriedades, é possível ver como os estilos foram configurados.
- Nome do grupo: os estilos podem ser agrupados no menu de estilo que o(a) autor(a) do conteúdo verá ao configurar o estilo do componente.
- Estilos podem ser combinados: permite que vários estilos dentro desse grupo sejam selecionados ao mesmo tempo.
- Nome do estilo: a descrição do estilo que será exibida para o(a) autor(a) do conteúdo ao configurar o estilo do componente.
- Classes CSS: o nome real da classe CSS associada ao estilo.
Use as alças de arrastar para configurar a ordem dos grupos e dos estilos. Use os ícones de adição ou exclusão para adicionar ou remover grupos ou estilos.
Configurar setup
Os Componentes principais versão 2 e posteriores estão habilitados para se beneficiarem do Sistema de estilos e não exigem configuração adicional.
As etapas a seguir são necessárias apenas para ativar o Sistema de estilos para os seus próprios componentes personalizados ou para habilitar a guia Estilos opcional na caixa de diálogo Editar.
Habilitar guia Estilo na caixa de diálogo Design enable-styles-tab-design
Para que um componente funcione com o Sistema de estilos do AEM e mostre a guia Estilo na caixa de diálogo Design, o desenvolvedor do componente deve incluir essa guia com as seguintes configurações no componente:
path = "/mnt/overlay/cq/gui/components/authoring/dialog/style/tab_design/styletab"sling:resourceType = "granite/ui/components/coral/foundation/include"
Com o componente configurado, os estilos configurados pelos autores da página serão inseridos automaticamente pelo AEM no elemento de decoração que AEM envolve automaticamente cada componente editável. O componente em si não precisa fazer mais nada para que isso aconteça.
Habilitar a guia Estilos na caixa de diálogo Editar enable-styles-tab-edit
A partir do AEM versão 6.5.3.0, uma guia Estilos opcional na caixa de diálogo Editar agora está disponível. Diferentemente da guia Design, a guia Editar não é essencial para o funcionamento do sistema de estilos, mas é uma interface alternativa e opcional para um autor de conteúdo definir estilos.
A guia Editar pode ser incluída de maneira semelhante na guia Design:
path = "/mnt/overlay/cq/gui/components/authoring/dialog/style/tab_edit/styletab"sling:resourceType = "granite/ui/components/coral/foundation/include"
Estilos com nomes de elemento styles-with-element-names
Um desenvolvedor também pode configurar uma lista de nomes de elementos permitidos para os estilos no componente por meio da propriedade de matriz da sequência cq:styleElements. Em seguida, na guia Estilos da política na caixa de diálogo de design, o(a) autor(a) do modelo também pode escolher um nome de elemento a ser definido para cada estilo. Isso definirá o nome de elemento do wrapper.
Essa propriedade é definida no nó cq:Component. Por exemplo:
/apps/<yoursite>/components/content/list@cq:styleElements=[div,section,span]
- HTL tem precedência sobre tudo:
data-sly-resource="${'path/to/resource' @ decorationTagName='span'} - Entre os vários estilos ativos, o primeiro estilo na lista de estilos configurados na política do componente é aplicado.
- Por fim, a
cq:htmlTag/cq:tagNamedo componente será considerada um valor de fallback.
Essa capacidade de definir nomes de estilo é útil para componentes muito genéricos, como o Contêiner de layout ou o componente de Fragmento do conteúdo, para oferecer-lhes significado adicional.
Por exemplo, permite que um Contêiner de layout receba uma semântica como <main>, <aside>, <nav> e assim por diante.