SCF Handlebars Helpers

Handlebars Helpers (ayudantes) son métodos a los que se puede llamar desde scripts Handlebars para facilitar el trabajo con componentes SCF.

La implementación incluye una definición del lado del cliente y una definición del lado del servidor. También es posible que los desarrolladores creen ayudantes personalizados.

Los ayudantes personalizados de SCF que se entregan con AEM Communities se definen en la biblioteca de cliente:

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

Abreviar

Un asistente para devolver una cadena abreviada que se ajuste a las propiedades maxWords y maxLength.

La cadena que se va a abreviar se proporciona como contexto. Si no se proporciona ningún contexto, se devuelve una cadena vacía.

En primer lugar, el contexto se recorta a maxLength y, a continuación, se divide en palabras y se reduce a maxWords.

Si safeString se establece en true, la cadena devuelta es SafeString.

Parámetros

• contexto: cadena

  (Opcional) La cadena predeterminada está vacía

• maxLength: número

  (Opcional) El valor predeterminado es la longitud del contexto.

• maxWords: número

  (Opcional) El valor por defecto es el número de palabras de la cadena recortada.

• safeString: booleano

  (Opcional) Devuelve un valor Handlebars.SafeString() si es true. El valor predeterminado es false.

Ejemplos

{{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

Un asistente puede agregar dos espacios bajo un div, uno para el texto completo y otro para el texto menos, con la capacidad de alternar entre las dos vistas.

Parámetros

• contexto: cadena

  (Opcional) El valor predeterminado es la cadena vacía.

• numChars: número

  (Opcional) El número de caracteres que se mostrarán cuando no se muestre texto completo. El valor predeterminado es 100.

• moreText: cadena

  (Opcional) Texto que se mostrará para indicar que hay más texto que mostrar. El valor predeterminado es "más".

• ellipsesText: cadena

  (Opcional) Texto que se mostrará para indicar que hay texto oculto. El valor predeterminado es "…".

• safeString: booleano

  (Opcional) Valor booleano que indica si se debe aplicar Handlebars.SafeString() antes de devolver el resultado. El valor predeterminado es false.

Ejemplos

{{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

Un asistente para devolver una cadena de fecha con formato.

Parámetros

• contexto: número

  (Opcional) un valor de milisegundos de desplazamiento desde el 1 de enero de 1970 (epoch). El valor predeterminado es la fecha actual.

• formato: cadena

  (Opcional) Formato de fecha que se aplicará. El valor predeterminado es AAAA-MM-DDTHH:mm:ss.sssZ" y el resultado será "2015-03-18T18:17:13-07:00"

Ejemplos

{{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

Un asistente para devolver contenido en función de un condicional de igualdad.

Parámetros

• lvalue: cadena

  El valor de la izquierda que se va a comparar.

• rvalue: cadena

  El valor de la derecha que se va a comparar.

Ejemplos

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

If-wcm-mode

Un asistente de bloque que prueba el valor actual de Modo WCM con una lista de modos separados por cadenas.

Parámetros

• contexto: cadena

  (Opcional) La cadena que se va a traducir. Obligatorio si no se proporciona ningún valor predeterminado.

• modo: cadena

  (Opcional) Una lista separada por comas de Modos WCM para comprobar si está configurado.

Ejemplos

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

i18n

Este asistente anula el asistente Handlebars 'i18n'.

Consulte también Internacionalización de cadenas en código JavaScript.

Parámetros

• contexto: cadena

  (Opcional) La cadena que se va a traducir. Obligatorio si no se proporciona ningún valor predeterminado.

• predeterminado: cadena

  (Opcional) La cadena predeterminada que se va a traducir. Obligatorio si no se proporciona ningún contexto.

• comentario: cadena

  (Opcional) Una sugerencia de traducción

Ejemplos

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

Incluir

Un asistente para incluir un componente como recurso no existente en una plantilla.

Esto permite personalizar el recurso mediante programación con mayor facilidad de lo que es posible para un recurso agregado como nodo JCR. Consulte Agregar o incluir un componente de Communities.

Solo se pueden incluir algunos de los componentes de las comunidades. AEM Para la versión 6.1, las que se pueden incluir son las siguientes comentarios, clasificación, críticas, y votación.

Este asistente, que solo es adecuado en el lado del servidor, proporciona una funcionalidad similar a cq:include para scripts JSP.

Parámetros

• contexto: cadena u objeto

  (Opcional, a menos que se proporcione una ruta relativa)

  Uso this para pasar el contexto actual.

  Uso this.id para obtener el recurso en id para procesar el resourceType solicitado.

• resourceType: cadena

  (Opcional) El tipo de recurso se definirá de forma predeterminada en el tipo de recurso del contexto.

• plantilla: cadena

  Ruta al script de componente.

• ruta: cadena

  (Obligatorio) La ruta al recurso. Si la ruta es relativa, se debe proporcionar un contexto; de lo contrario, se devuelve la cadena vacía.

• authoringDisabled: booleano

  (Opcional) El valor predeterminado es falso. Solo para uso interno.

Ejemplos

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

Esto incluirá un nuevo componente de comentarios en this.id + /comments.

IncludeClientLib

AEM Un asistente que incluye una biblioteca de cliente de HTML de, que puede ser una biblioteca js, css o de temáticas. Para varias inclusiones de diferentes tipos, por ejemplo js y css, esta etiqueta debe utilizarse varias veces en el script Handlebars.

Este asistente, que solo es adecuado en el lado del servidor, proporciona una funcionalidad similar a ui:includeClientLib para scripts JSP.

Parámetros

• categorías: cadena

  (Opcional) Una lista de categorías de biblioteca de cliente separadas por comas. Esto incluirá todas las bibliotecas de JavaScript y CSS para las categorías dadas. El nombre de la temática se extrae de la solicitud.

• tema: cadena

  (Opcional) Una lista de categorías de biblioteca de cliente separadas por comas. Esto incluirá todas las bibliotecas relacionadas con temas (tanto CSS como JS) para las categorías dadas. El nombre de la temática se extrae de la solicitud.

• js: cadena

  (Opcional) Una lista de categorías de biblioteca de cliente separadas por comas. Esto incluirá todas las bibliotecas de JavaScript para las categorías dadas.

• css: cadena

  (Opcional) Una lista de categorías de biblioteca de cliente separadas por comas. Esto incluirá todas las bibliotecas CSS para las categorías dadas.

Ejemplos

// 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">

Tiempo bonito

Un asistente para mostrar cuánto tiempo ha pasado hasta un punto de corte, después del cual se muestra un formato de fecha normal.

Por ejemplo:

• Hace 12 horas
• Hace 7 días

Parámetros

• contexto: número

  Un tiempo en el pasado para compararlo con el 'ahora'. El tiempo se expresa como un desplazamiento de valor de milisegundos desde el 1 de enero de 1970 (época).

• daysCutoff: número

  Número de días transcurridos antes de cambiar a una fecha real. El valor predeterminado es 60.

Ejemplos

{{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

Un asistente que codifica una cadena de origen para el contenido de elementos HTML para ayudar a protegerse contra XSS.

NOTA: no es un validador y no se debe utilizar para escribir valores de atributo.

Parámetros

• contexto: objeto

  HTML que se va a codificar.

Ejemplos

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

Xss-htmlAttr

Un asistente que codifica una cadena de origen para escribir en un valor de atributo de HTML para ayudar a protegerse contra XSS.

NOTA: no es un validador y no debe utilizarse para escribir atributos procesables (href, src, controladores de eventos).

Parámetros

• contexto: objeto

  HTML que se va a codificar.

Ejemplos

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

Xss-jsString

Un asistente que codifica una cadena de origen para escribir en el contenido de la cadena JavaScript para ayudar a protegerse contra XSS.

NOTA: este no es un validador y no debe usarse para escribir en JavaScript arbitrario.

Parámetros

• contexto: objeto

  HTML que se va a codificar.

Ejemplos

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

Xss-validHref

Un asistente que sanea una dirección URL para escribir como un valor de atributo HTML href o srce para ayudar a protegerse contra XSS.

NOTA: esto puede devolver una cadena vacía

Parámetros

• contexto: objeto

  Dirección URL para sanear.

Ejemplos

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

Información general básica de Handlebars.js

• Una llamada de ayuda de Handlebars es un identificador simple (la variable name del asistente), seguido de cero o más parámetros separados por espacios.

• Los parámetros pueden ser un objeto simple String, number, boolean o JSON, así como una secuencia opcional de pares clave-valor (argumentos hash) como últimos parámetros.

• Las claves de los argumentos hash deben ser identificadores simples.

• Los valores de los argumentos hash son expresiones Handlebars: identificadores simples, rutas o cadenas.

• El contexto actual, this, siempre está disponible para los ayudantes de Handlebars.

• El contexto puede ser una cadena, un número, un booleano o un objeto de datos JSON.

• Es posible pasar un objeto anidado en el contexto actual como contexto, como this.url o this.id (consulte los siguientes ejemplos de ayudantes simples y de bloque).

• Los ayudantes de bloque son funciones a las que se puede llamar desde cualquier lugar de la plantilla. Pueden invocar un bloque de la plantilla cero o más veces con un contexto diferente cada vez. Contienen un contexto entre {{#name}} and {{/name}}.

• Handlebars proporciona un parámetro final a los ayudantes llamados "options". El objeto especial "options" incluye

  • Datos privados opcionales (options.data)
  • Propiedades clave-valor opcionales de la llamada (options.hash)
  • Capacidad para invocarse a sí mismo (options.fn())
  • Capacidad para invocar lo contrario a sí mismo (options.inverse())

• Se recomienda que el contenido de la cadena HTML devuelto por un asistente sea SafeString.

Un ejemplo de un asistente simple de la documentación de 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);

Se renderizaría:

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

Un ejemplo de un asistente de bloque de la documentación de 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);

Se renderizaría:
<ul>
<li><a href="/people/1">Alan</a></li>
<li><a href="/people/2">Yehuda</a></li>
</ul>

Ayudantes de SCF personalizados

Los ayudantes personalizados deben implementarse del lado del servidor y del lado del cliente, especialmente al pasar datos. Para SCF, la mayoría de las plantillas se compilan y se representan en el servidor, ya que el servidor genera el HTML de un componente determinado cuando se solicita la página.

Ayudantes personalizados del lado del servidor

Para implementar y registrar un asistente SCF personalizado en el lado del servidor, simplemente implemente la interfaz de Java TemplateHelper, conviértalo en un Servicio OSGi e instálelo como parte de un paquete OSGi.

Por ejemplo:

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;
    }
}

Ayudantes personalizados del lado del cliente

Los ayudantes del lado del cliente son scripts Handlebars registrados invocando Handlebars.registerHelper().
Por ejemplo:

custom-helpers.js

function(Handlebars, SCF, $CQ) {

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

})(Handlebars, SCF, $CQ);

Los ayudantes personalizados del lado del cliente deben agregarse a una biblioteca de cliente personalizada.
La clientlib debe:

• Incluir una dependencia en cq.social.scf.
• Cargar después de cargar Handlebars.
• Be incluido.

Nota: Los ayudantes de SCF se definen en /etc/clientlibs/social/commons/scf/helpers.js.

Recursos de Business.Adobe.com

Ecommerce Integrations Asset Collections Content Intelligence Embedded Charts Dynamic Forms Digital Asset Management