Personalização do lado do cliente client-side-customization

Há várias abordagens para personalizar a aparência e/ou o comportamento de um componente do AEM Communities no lado do cliente.

Duas abordagens principais são a sobreposição ou a extensão de um componente.

Sobreposição um componente altera o componente padrão e afeta todas as referências ao componente.

A extensão de um componente, com nome exclusivo, limita o escopo das alterações. O termo "estender" é usado alternadamente com "substituir".

Sobreposições overlays

Sobrepor um componente é um método para fazer modificações em um componente padrão e afetar todas as instâncias que usam o padrão.

A sobreposição é realizada modificando uma cópia do componente padrão no diretório /apps, em vez de modificar o componente original no diretório /libs. O componente é construído com um caminho relativo idêntico, exceto que "libs" é substituído por "apps".

O diretório /apps é o primeiro local pesquisado para resolver solicitações e, se não for encontrado, a versão padrão no diretório/libs será usada.

O componente padrão no diretório /libs nunca deve ser modificado, pois os patches e upgrades futuros podem alterar o diretório /libs de qualquer maneira necessária enquanto mantêm as interfaces públicas.

Isso é diferente de estender um componente padrão em que o desejo é fazer modificações para um uso específico, criando um caminho exclusivo para o componente e confiando na referência ao componente padrão original no diretório /libs como o tipo de super recurso.

Para obter um exemplo rápido de sobreposição do componente de comentários, tente o tutorial do Componente de Sobreposição de Comentários.

Extensões extensions

Estender (substituir) um componente é um método de fazer modificações para um uso específico sem afetar todas as instâncias que usam o padrão. O componente estendido é nomeado exclusivamente na pasta /apps e faz referência ao componente padrão na pasta /libs, portanto, o design e o comportamento padrão de um componente não são modificados.

Isso é diferente de sobrepor o componente padrão, onde a natureza do Sling resolve referências relativas à pasta apps/ antes de pesquisar na pasta libs/, portanto, o design ou comportamento de um componente é modificado globalmente.

Para obter um exemplo rápido de extensão do componente de comentários, tente o tutorial Estender componente de comentários.

Vínculo do JavaScript javascript-binding

O script HBS do componente deve ser vinculado aos objetos, modelos e visualizações do JavaScript que implementam esse recurso.

O valor do atributo data-scf-component pode ser o padrão, como social/tally/components/hbs/rating, ou um componente estendido (personalizado) para funcionalidade personalizada, como weretail/components/hbs/rating.

Para vincular um componente, todo o script do componente deve ser delimitado em um elemento <div> com os seguintes atributos:

Por exemplo, de /apps/weretail/components/hbs/rating/rating.hbs:

<div class="we-Rating" data-component-id="`{{id}}`" data-scf-component="weretail/components/hbs/rating">

     <!-- HTML with HBS accessing the rating component -->

</div>

Propriedades personalizadas custom-properties

Ao estender ou sobrepor um componente, é possível adicionar propriedades a uma caixa de diálogo modificada.

Todas as propriedades definidas em um componente/recurso podem ser acessadas fazendo referência às chaves de propriedade no modelo handlebars:

{{properties.<property_name>}}

Aplicação de capa a CSS skinning-css

A personalização de componentes para corresponder ao tema geral do site pode ser realizada alterando cores, fontes, imagens, botões, links, espaçamento e até mesmo o posicionamento em uma determinada extensão.

A atribuição de capa pode ser obtida substituindo seletivamente os estilos da estrutura ou escrevendo folhas de estilos totalmente novas. Os componentes SCF definem classes CSS namespace, modulares e semânticas que afetam os vários elementos que compõem um componente.

Para aplicar capa a um componente:

Os estilos personalizados agora substituirão os estilos de estrutura padrão, e o componente será renderizado com a nova capa.

Extensão do JavaScript extending-javascript

Para estender uma implementação do JavaScript de componentes, é necessário:

forum.js: Exemplo de extensão do Forum - HBS forum-js-sample-extension-of-forum-hbs

(function($CQ, _, Backbone, SCF) {
    "use strict";
    var GMForumView = SCF.ForumView.extend({
        viewName: "GMForum",
        showComposer: function(e) {
            SCF.ForumView.prototype.toggleComposer.apply(this);
            var cancel = this.$el.find('.cancel-new-topic');
            cancel.toggle();
        },
        hideComposer: function(e) {
            SCF.ForumView.prototype.toggleComposer.apply(this);
            var cancel = this.$el.find('.cancel-new-topic');
            cancel.toggle();
        }
    });

    SCF.registerComponent('social/forum/components/hbs/post', SCF.Post, SCF.PostView);
    SCF.registerComponent('social/forum/components/hbs/topic', SCF.Topic, SCF.TopicView);
    SCF.registerComponent('social/forum/components/hbs/forum', SCF.Forum, GMForumView );
})($CQ, _, Backbone, SCF);

Tags de script script-tags

As tags de script são uma parte inerente da estrutura do lado do cliente. Eles são a cola que ajuda a vincular a marcação gerada no lado do servidor aos modelos e visualizações no lado do cliente.

As tags de script nos scripts SCF não devem ser removidas ao sobrepor ou substituir componentes. As tags de script SCF criadas automaticamente para inserção de JSON no HTML são identificadas com o atributo data-scf-json=true.

Clientlibs para SCF clientlibs-for-scf

O uso de bibliotecas do lado do cliente (clientlibs) fornece um meio de organizar e otimizar a JavaScript e o CSS usados para renderizar conteúdo no cliente.

As clientlibs do SCF seguem um padrão de nomenclatura muito específico para duas variantes, que variam somente pela presença de "autor" no nome da categoria:

Clientlibs completos complete-clientlibs

As bibliotecas de clientes completas (não de autor) incluem dependências e são convenientes para inclusão com ui:includeClientLib.

Essas versões são encontradas em:

Por exemplo:

O guia de Componentes da Comunidade lista as clientlibs completas necessárias para cada componente do SCF.

Clientlibs para componentes das comunidades descreve como adicionar clientlibs a uma página.

Clientlibs do autor author-clientlibs

As clientlibs da versão do autor são reduzidas ao JavaScript mínimo necessário para implementar o componente.

Essas clientlibs nunca devem ser incluídas diretamente, mas em vez disso estão disponíveis para serem incorporadas a outras clientlibs, que são criadas manualmente para um site.

Essas versões são encontradas na pasta SCF libs:

Por exemplo:

Observação: embora as clientlibs do autor nunca incorporem outras bibliotecas, elas listam suas dependências. Quando incorporadas em outras bibliotecas, as dependências não são automaticamente extraídas e também devem ser incorporadas.

As clientlibs do autor necessárias podem ser identificadas inserindo-se "author" nas clientlibs listadas para cada componente do SCF no guia de Componentes da Comunidade.

Considerações sobre uso usage-considerations

Cada site é diferente na forma como eles gerenciam as bibliotecas de clientes. Vários fatores incluem: