⇐ Fundamentos de recursos | Utilitário de personalização do servidor |
---|---|
Auxiliares da proteção contra a fraude SCF |
Para personalizar a aparência e/ou o comportamento de um componente AEM Communities no lado do cliente, há várias abordagens.
Duas abordagens principais são sobrepor ou estender um componente.
A sobreposição de um componente altera o componente padrão e afeta todas as referências ao componente.
A extensão de um componente, nomeado unicamente, limita o escopo das mudanças. O termo "extensão" é utilizado de forma permutável com "substituição".
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 localizada no diretório /libs é usada.
O componente padrão no diretório /libs nunca deve ser modificado, pois os patches e atualizações futuros são gratuitos para alterar o diretório /libs de qualquer maneira necessária, mantendo as interfaces públicas.
Isso é diferente de estender um componente padrão no qual o desejo é fazer modificações para um uso específico, criando um caminho exclusivo para o componente e contando com a referência do componente padrão original no diretório /libs como o tipo de superrecurso.
Para obter um exemplo rápido de sobreposição do componente de comentários, tente o tutorial Componente de comentários de sobreposição.
A extensão (substituição) de 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 no qual a natureza do Sling resolve as referências relativas à pasta apps/ antes de pesquisar na pasta libs/, portanto, o design ou o comportamento de um componente é modificado globalmente.
Para obter um exemplo rápido de como estender o componente de comentários, tente o tutorial Estender componentes de comentários.
O script HBS do componente deve estar vinculado aos objetos, modelos e visualizações 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, o script de componente inteiro deve estar incluído em um elemento <div> com os seguintes atributos:
data-component-id
="{{id}}"
resolve para a propriedade id do contexto
data-scf-component
="<resourcetype>
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>
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>}}
A personalização de componentes para corresponder ao tema geral do site pode ser alcançada pela "capa" - alteração de cores, fontes, imagens, botões, links, espaçamento e até mesmo posicionamento em certa medida.
A capa pode ser obtida substituindo seletivamente os estilos de estrutura ou escrevendo folhas de estilos totalmente novas. Os componentes SCF definem classes CSS namespacadas, modulares e semânticas que afetam os vários elementos que compõem um componente.
Para aplicar capa a um componente:
Identifique os elementos que deseja alterar (por exemplo - área do compositor, botões da barra de ferramentas, fonte da mensagem etc.).
Identifique a classe/regras CSS que afetam esses elementos.
Crie um arquivo de folha de estilos (.css).
Inclua a folha de estilo em uma pasta da biblioteca do cliente (clientlibs) para o seu site e verifique se ela está incluída em seus modelos e páginas com ui:includeClientLib.
Redefina as classes e regras CSS identificadas (#2) na sua folha de estilos e adicione estilos.
Os estilos personalizados substituirão os estilos de estrutura padrão e o componente será renderizado com a nova capa.
Qualquer nome de classe CSS com prefixo scf-js-* tem um uso específico no código javascript. Essas classes afetam o estado de um componente (por exemplo, alternar de oculto para visível) e não devem ser substituídas nem removidas.
Enquanto o scf-js-* classes não afetam estilos, os nomes de classe podem ser usados em folhas de estilos com a ressalva de que, como controlam os estados dos elementos, pode haver efeitos colaterais.
Para estender uma implementação do Javascript de componentes, é necessário apenas
(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);
As tags de script são uma parte inerente da estrutura do lado do cliente. Elas 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 substituir ou substituir componentes. As tags de script SCF criadas automaticamente para injetar JSON no HTML são identificadas com o atributo data-scf-json=
true.
O uso de bibliotecas do lado do cliente (clientlibs) fornece um meio de organizar e otimizar o Javascript e o CSS usados para renderizar conteúdo no cliente.
As clientlibs para SCF seguem um padrão de nomeação muito específico para duas variantes, que variam apenas pela presença de 'autor' no nome da categoria:
Variante Clientlib | Padrão para a propriedade Categoria |
---|---|
clientlib completo | cq.social.hbs.<component name=""> |
clientlib do autor | cq.social.author.hbs.<component name=""> |
Os clientlibs completos (não autores) 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 SCF.
Clientlibs for Communities Componentsdescreve como adicionar clientlibs a uma página.
As clientlibs da versão do autor são eliminadas até o Javascript mínimo necessário para implementar o componente.
Essas clientlibs nunca devem ser incluídas diretamente, mas estão disponíveis para incorporação em outras clientlibs, que são artesanais para um site.
Essas versões são encontradas na pasta libs SCF:
Por exemplo:
Observação: enquanto os clientlibs do autor nunca incorporam outras bibliotecas, eles fazem lista de suas dependências. Quando incorporadas em outras bibliotecas, as dependências não são automaticamente extraídas e também devem ser incorporadas.
Os clientlibs do autor necessários podem ser identificados inserindo "autor" nos clientlibs listados para cada componente SCF no Guia de componentes da comunidade.
Cada site é diferente em como gerenciam bibliotecas de clientes. Vários fatores incluem:
⇐ Fundamentos de recursos | Utilitário de personalização do servidor |
---|---|
Auxiliares da proteção contra a fraude SCF |