Auxiliares de Handlebars SCF

Última atualização em 2023-12-07
  • Tópicos
  • Communities
    Exibir mais informações sobre este tópico
  • Criado para:
  • User
Feature Essentials Personalização do lado do servidor ^
Personalização no lado do cliente ^

Os Handlebars Helpers (helpers) são métodos chamados de scripts Handlebars para facilitar o trabalho com componentes SCF.

A implementação inclui uma definição do lado do cliente e do lado do servidor. Também é possível para os desenvolvedores criar auxiliares personalizados.

Os auxiliares SCF personalizados fornecidos com o AEM Communities são definidos na biblioteca do cliente:

  • /etc/clientlibs/social/commons/scf/helpers.js

Abreviar

Um auxiliar para retornar uma sequência de caracteres abreviada em conformidade com as propriedades maxWords e maxLength.

A cadeia de caracteres a ser abreviada é fornecida como contexto. Se nenhum contexto for fornecido, uma string vazia será retornada.

Primeiro, o contexto é reduzido para maxLength e, em seguida, o contexto é dividido em palavras e reduzido para maxWords.

Se safeString estiver definido como true, a cadeia de caracteres retornada será SafeString.

Parâmetros

  • contexto: String

    (Opcional) O padrão é a string vazia

  • maxLength: Número

    (Opcional) Padrão é a duração do contexto.

  • maxWords: Número

    (Opcional) Padrão é o número de palavras na string aparada.

  • safeString: Booleano

    (Opcional) Retorna Handlebars.SafeString() se verdadeiro. O padrão é falso.

Exemplos

{{abbreviate subject maxWords=2}}

/*
If subject =
    "AEM Communities - Site Creation Wizard"

Then abbreviate would return
    "AEM Communities".
*/
{{{abbreviate message safeString=true maxLength=30}}}

/*
If message =
    "The goal of AEM Communities is to quickly create a community engagement site."

Then abbreviate would return
    "The goal of AEM Communities is"
*/

Content-loadmore

Um auxiliar para adicionar duas extensões em uma div, uma para o texto completo e outra para o menos texto, com a capacidade de alternar entre as duas visualizações.

Parâmetros

  • contexto: String

    (Opcional) O padrão é a cadeia de caracteres vazia.

  • numChars: Número

    (Opcional) O número de caracteres a serem exibidos quando não estiver exibindo o texto completo. O padrão é 100.

  • moreText: String

    (Opcional) O texto a ser exibido, indicando que há mais texto a ser exibido. O padrão é "mais".

  • elipsesText: String

    (Opcional) O texto a ser exibido indicando que há texto oculto. O padrão é "…".

  • safeString: Booleano

    (Opcional) Valor booleano que indica se Handlebars.SafeString() deve ser aplicado antes de retornar o resultado. O padrão é falso.

Exemplo

{{content-loadmore  context numChars=32  moreText="go on"  ellipsesText="..." }}

/*
If context =
    "Here is the initial less content and this is more content."

Then content-loadmore would return
    "Here is the initial less content<span class="moreelipses">...</span> <span class="scf-morecontent"><span>and this is more content.</span>  <a href="" class="scf-morelink" evt="click=toggleContent">go on</a></span>"
*/

DateUtil

Um auxiliar para retornar uma string de data formatada.

Parâmetros

  • contexto: Número

    (Opcional) uma diferença de valor em milissegundos de 1º de janeiro de 1970 (época). O padrão é a data atual.

  • formato: String

    (Opcional) O formato de data a ser aplicado. O padrão é "AAAA-MM-DDTHH:mm:"ss.sssZ" e o resultado aparece como "2015-03-18T18:17:13-07:00"

Exemplos

{{dateUtil this.memberSince format="dd MMM yyyy, hh:mm"}}

// returns "18 Mar 2015, 18:17"
{{dateUtil this.birthday format="MM-DD-YYYY"}}

// returns "03-18-2015"

Igual a

Um auxiliar para retornar o conteúdo dependendo de uma condição de igualdade.

Parâmetros

  • lvalue: String

    O valor à esquerda a ser comparado.

  • rvalue: String

    O valor à direita a ser comparado.

Exemplo

{{#equals  value "some-value"}}
  <div>They are EQUAL!</div>
{{else}}
  <div>They are NOT equal!</div>
{{/equals}}

If-wcm-mode

Um auxiliar de bloco que testa o valor atual de Modo WCM contra uma lista de modos separada por sequência.

Parâmetros

  • contexto: String

    (Opcional) A sequência de caracteres a ser traduzida. Obrigatório se nenhum padrão for fornecido.

  • modo: String

    (Opcional) Uma lista separada por vírgulas de Modos WCM para testar se definido.

Exemplo

{{#if-wcm-mode mode="DESIGN, EDIT"}}
 ...
{{else}}
 ...
{{/if-wcm-mode}}

i18n

Este auxiliar substitui o auxiliar Handlebars 'i18n'.

Consulte também Internacionalizando strings no código JavaScript.

Parâmetros

  • contexto: String

    (Opcional) A sequência de caracteres a ser traduzida. Obrigatório se nenhum padrão for fornecido.

  • padrão: String

    (Opcional) A cadeia de caracteres padrão a ser traduzida. Obrigatório se nenhum contexto for fornecido.

  • comentário: String

    (Opcional) Uma dica de tradução

Exemplo

{{i18n "hello"}}
{{i18n "hello" comment="greeting" default="bonjour"}}

Incluir

Um auxiliar para incluir um componente como um recurso não existente em um modelo.

Esse método permite que o recurso seja personalizado programaticamente com mais facilidade do que é possível para um recurso adicionado como um nó JCR. Consulte Adicionar ou incluir um componente das comunidades.

Apenas alguns componentes selecionados das Comunidades estão disponíveis para inclusão.

Este auxiliar, apropriado somente no lado do servidor, fornece funcionalidade semelhante a cq:include para scripts JSP.

Parâmetros

  • contexto: sequência ou objeto

    (Opcional, exceto se fornecer um caminho relativo)

    Uso this para transmitir o contexto atual.

    Uso this.id para obter o recurso em id para renderizar o resourceType solicitado.

  • resourceType: String

    (Opcional) O tipo de recurso assume como padrão o tipo de recurso do contexto.

  • modelo: String

    Caminho para o script do componente.

  • caminho: String

    (Obrigatório) O caminho para o recurso. Se o caminho for relativo, um contexto deverá ser fornecido, caso contrário, a cadeia de caracteres vazia será retornada.

  • authoringDisabled: Booleano

    (Opcional) O padrão é falso. Somente para uso interno.

Exemplo

{{include this.id path="comments" resourceType="social/commons/components/hbs/comments"}}

Inclui um novo componente de comentários em this.id + /comentários.

IncludeClientLib

Um auxiliar que inclui uma biblioteca cliente AEM html, que pode ser um js, um css ou uma biblioteca de temas. Para várias inclusões de tipos diferentes, por exemplo, js e css, essa tag deve ser usada várias vezes no script Handlebars.

Este auxiliar, apropriado somente no lado do servidor, fornece funcionalidade semelhante a ui:includeClientLib para scripts JSP.

Parâmetros

  • categorias: String

    (Opcional) Uma lista de categorias de bibliotecas de clientes separadas por vírgulas. Inclua todas as bibliotecas JavaScript e CSS para as categorias fornecidas. O nome do tema é extraído da solicitação.

  • tema: String

    (Opcional) Uma lista de categorias de bibliotecas de clientes separadas por vírgulas. Inclua todas as bibliotecas relacionadas ao tema (CSS e JS) para as categorias fornecidas. O nome do tema é extraído da solicitação.

  • js: String

    (Opcional) Uma lista de categorias de bibliotecas de clientes separadas por vírgulas. Inclui todas as bibliotecas JavaScript para as categorias fornecidas.

  • css: String

    (Opcional) Uma lista de categorias de bibliotecas de clientes separadas por vírgulas. Inclui todas as bibliotecas CSS para as categorias fornecidas.

Exemplos

// all: js + theme (theme-js + css)
{{includeClientLib categories="cq.social.hbs.comments, cq.social.hbs.voting"}}

// returns
    <link href="/etc/clientlibs/social/hbs/tally/voting.css" rel="stylesheet" type="text/css">
    <link href="/etc/clientlibs/social/hbs/socialgraph.css" rel="stylesheet" type="text/css">
    <link href="/etc/clientlibs/social/hbs/comments.css" rel="stylesheet" type="text/css">
    <script src="/etc/clientlibs/social/hbs/tally/voting.js" type="text/javascript"></script>
    <script src="/etc/clientlibs/social/hbs/socialgraph.js" type="text/javascript"></script>
    <script src="/etc/clientlibs/social/hbs/comments.js" type="text/javascript"></script>

// only js libs
{{includeClientLib js="cq.social.hbs.comments, cq.social.hbs.voting"}}

// returns
    <script src="/etc/clientlibs/social/hbs/tally/voting.js" type="text/javascript"></script>
    <script src="/etc/clientlibs/social/hbs/socialgraph.js" type="text/javascript"></script>
    <script src="/etc/clientlibs/social/hbs/comments.js" type="text/javascript"></script>

// theme only (theme-js + css)
{{includeClientLib theme="cq.social.hbs.comments, cq.social.hbs.voting"}}

// returns
    <link href="/etc/clientlibs/social/hbs/tally/voting.css" rel="stylesheet" type="text/css">
    <link href="/etc/clientlibs/social/hbs/comments.css" rel="stylesheet" type="text/css">
    <script src="/etc/clientlibs/social/hbs/tally/voting.js" type="text/javascript"></script>
    <script src="/etc/clientlibs/social/hbs/comments.js" type="text/javascript"></script>

// css only
{{includeClientLib css="cq.social.hbs.comments, cq.social.hbs.voting"}}

// returns
    <link href="/etc/clientlibs/social/hbs/tally/voting.css" rel="stylesheet" type="text/css">
    <link href="/etc/clientlibs/social/hbs/socialgraph.css" rel="stylesheet" type="text/css">
    <link href="/etc/clientlibs/social/hbs/comments.css" rel="stylesheet" type="text/css">

Tempo bonito

Um auxiliar para exibir quanto tempo passou até um ponto de corte, após o qual um formato de data regular é exibido.

Por exemplo:

  • 12 horas atrás
  • 7 dias atrás

Parâmetros

  • contexto: Número

    Um horário no passado para comparar com 'agora'. O tempo é expresso como um deslocamento de valor em milissegundos a partir de 1° de janeiro de 1970 (época).

  • daysCutoff: Número

    O número de dias atrás antes de alternar para uma data real. O padrão é 60.

Exemplo

{{pretty-time this.published daysCutoff=7}}

/*
Depending on how long in the past, may return

  "3 minutes ago"

  "3 hours ago"

  "3 days ago"
*/

Xss-html

Um auxiliar que codifica uma cadeia de caracteres de origem para o conteúdo do elemento de HTML para ajudar a proteger contra XSS.

OBSERVAÇÃO: este auxiliar não é um validador e não deve ser usado para gravar valores de atributo.

Parâmetros

  • contexto: objeto

    O HTML a ser codificado.

Exemplo

<p>{{xss-html forum-ugc}}</p>

Xss-htmlAttr

Um auxiliar que codifica uma cadeia de caracteres de origem para gravar em um valor de atributo HTML para ajudar a proteger contra XSS.

OBSERVAÇÃO: este auxiliar não é um validador e não deve ser usado para gravar atributos acionáveis (href, src, manipuladores de eventos).

Parâmetros

  • contexto: Objeto

    O HTML a ser codificado.

Exemplo

<div id={{xss-htmlAttr id}} />

Xss-jsString

Um auxiliar que codifica uma cadeia de caracteres de origem para gravar no conteúdo de cadeia de caracteres JavaScript para ajudar a proteger contra XSS.

OBSERVAÇÃO: Este auxiliar não é um validador e não deve ser usado para gravação em JavaScript arbitrário.

Parâmetros

  • contexto: Objeto

    O HTML a ser codificado.

Exemplo

var input = {{xss-jsString topic-title}}

Xss-validHref

Um auxiliar que limpa um URL para gravar como um valor de atributo HTML href ou srce para ajudar a proteger contra XSS.

OBSERVAÇÃO: este auxiliar pode retornar uma cadeia de caracteres vazia.

Parâmetros

  • contexto: Objeto

    O URL para limpar.

Exemplo

<a href="{{xss-validHref url}}">my link</a>

Visão geral básica do Handlebars.js

  • Uma chamada de auxiliar do Handlebars é um identificador simples (o name do auxiliar), seguido por zero ou mais parâmetros separados por espaço.

  • Os parâmetros podem ser um objeto String, número, booleano ou JSON simples e uma sequência opcional de pares de valores-chave (argumentos de hash) como os últimos parâmetros.

  • As chaves nos argumentos de hash devem ser identificadores simples.

  • Os valores em argumentos de hash são expressões Handlebars: identificadores simples, caminhos ou Strings.

  • O contexto atual, this, está sempre disponível para os auxiliares do Handlebars.

  • O contexto pode ser um objeto de dados String, number, boolean ou JSON.

  • É possível passar um objeto aninhado no contexto atual como o contexto, como this.url ou this.id (consulte os exemplos a seguir de auxiliares simples e de bloco).

  • Bloquear auxiliares são funções que podem ser chamadas de qualquer lugar no modelo. Eles podem chamar um bloco do modelo zero ou mais vezes com um contexto diferente a cada vez. Eles contêm um contexto entre {{#*name*}} e {{/*name*}}.

  • Os Handlebars fornecem um parâmetro final para os auxiliares chamados de "opções". O objeto especial 'options' inclui

    • Dados particulares opcionais (options.data)
    • Propriedades de valor-chave opcionais da chamada (options.hash)
    • Capacidade de chamar a si mesmo (options.fn())
    • Capacidade de invocar o inverso de si mesmo (options.inverse())
  • Recomenda-se que o conteúdo da Cadeia de HTML retornado de um auxiliar seja um SafeString.

Um exemplo de um assistente simples da documentação do Handlebars.js:

Handlebars.registerHelper('link_to', function(title, options) {
    return new Handlebars.SafeString('<a href="/posts' + this.url + '">' + title + "!</a>");
});

var context = {posts: [
    {url: "/hello-world",
      body: "Hello World!"}
  ] };

// when link_to is called, posts is the current context
var source = '<ul>{{#posts}}<li>{{{link_to "Post"}}}</li>{{/posts}}</ul>'

var template = Handlebars.compile(source);

template(context);

Renderizaria:

<ul>
<li><a href="/posts/hello-world">Publicar!</a></li>
</ul>

Um exemplo de um assistente de bloco da documentação do Handlebars.js:

Handlebars.registerHelper('link', function(options) {
    return new Handlebars.SafeString('<a href="/people/' + this.id + '">' + options.fn(this) + '</a>');
});

var data = { "people": [
  { "name": "Alan", "id": 1 },
  { "name": "Yehuda", "id": 2 }
]};

// when link is called, people is the current context
var source = "<ul>{{#people}}<li>{{#link}}{{name}}{{/link}}</li>{{/people}}</ul>";

var template = Handlebars.compile(source);

template(data);

Renderizaria:
<ul>
<li><a href="/people/1">Alan</a></li>
<li><a href="/people/2">Yehuda</a></li>
</ul>

Auxiliares de SCF personalizados

Os auxiliares personalizados devem ser implementados no lado do servidor e no lado do cliente, especialmente ao transmitir dados. Para o SCF, a maioria dos modelos é compilada e renderizada no lado do servidor, pois o servidor gera o HTML para um determinado componente quando a página é solicitada.

Auxiliares personalizados do lado do servidor

Para implementar e registrar um auxiliar SCF personalizado no lado do servidor, basta implementar a interface Java™ TemplateHelper, torne-o um Serviço OSGi e instale-o como parte de um pacote OSGi.

Por exemplo:

FooTextHelper.java

/** Custom Handlebars Helper */

package com.my.helpers;

import java.io.IOException;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;

import com.adobe.cq.social.handlebars.api.TemplateHelper;
import com.github.jknack.handlebars.Options;

@Service
@Component
public class FooTextHelper implements TemplateHelper<String>{

    @Override
    public CharSequence apply(String context, Options options) throws IOException {
        return "foo-" + context;
    }

    @Override
    public String getHelperName() {
        return "foo-text";
    }

    @Override
    public Class<String> getContextType() {
        return String.class;
    }
}
OBSERVAÇÃO

Um auxiliar criado para o lado do servidor também deve ser criado para o lado do cliente.

O componente é renderizado novamente no lado do cliente para o usuário conectado e, se o auxiliar do lado do cliente não for encontrado, o componente desaparecerá.

Auxiliares personalizados do lado do cliente

Os auxiliares do lado do cliente são scripts Handlebars registrados chamando Handlebars.registerHelper().
Por exemplo:

custom-helpers.js

function(Handlebars, SCF, $CQ) {

    Handlebars.registerHelper('foo-text', function(context, options) {
        if (!context) {
            return "";
        }
        return "foo-" + context;
    });

})(Handlebars, SCF, $CQ);

Os auxiliares personalizados do lado do cliente devem ser adicionados a uma biblioteca personalizada do cliente.
A clientlib deve:

  • Incluir uma dependência em cq.social.scf.
  • Carregar depois que o Handlebars for carregado.
  • Ser incluído.

Observação: os auxiliares do SCF estão definidos em /etc/clientlibs/social/commons/scf/helpers.js.

Feature Essentials Personalização do lado do servidor ^
Personalização no lado do cliente ^

Nesta página