SCF Handlebars Helpers scf-handlebars-helpers

Handlebars Helpers (helpers) sind Methoden, die von Handlebars-Skripten aufgerufen werden können, um die Arbeit mit SCF-Komponenten zu erleichtern.

Die Implementierung umfasst eine Client-seitige und eine Server-seitige Definition. Es ist auch möglich, dass Entwickler benutzerdefinierte Helfer erstellen.

Die benutzerdefinierten SCF-Helfer, die mit AEM Communities bereitgestellt werden, werden in der Client-Bibliothek definiert:

Abkürzung abbreviate

Hilfsmittel zum Zurückgeben einer abgekürzten Zeichenfolge, die den Eigenschaften maxWords und maxLength entspricht.

Die abzukürzende Zeichenfolge wird als Kontext bereitgestellt. Wenn kein Kontext angegeben wird, wird eine leere Zeichenfolge zurückgegeben.

Zunächst wird der Kontext auf maxLength reduziert, dann wird der Kontext in Wörter aufgeteilt und auf maxWords reduziert.

Wenn safeString auf "true"gesetzt ist, ist die zurückgegebene Zeichenfolge ein SafeString.

Parameter parameters

Beispiele examples

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

Ein Hilfsprogramm zum Hinzufügen von zwei Bereichen unter einem div, einer für den Volltext und der andere für den weniger Text, mit der Möglichkeit, zwischen den beiden Ansichten umzuschalten.

Parameter parameters-1

Beispiel example

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

Hilfsmittel zum Zurückgeben einer formatierten Datums-Zeichenfolge.

Parameter parameters-2

Beispiele examples-1

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

Gleich equals

Hilfsmittel zum Zurückgeben von Inhalten in Abhängigkeit von einer Gleichheitsbedingung.

Parameter parameters-3

Beispiel example-1

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

If-wcm-mode if-wcm-mode

Ein Block-Helfer, der den aktuellen Wert von WCM mode anhand einer durch eine Zeichenfolge getrennten Liste von Modi testet.

Parameter parameters-4

Beispiel example-2

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

i18n i-n

Dieser Helfer überschreibt den Handlebars-Helfer 'i18n'.

Siehe auch Internationalisieren von Zeichenfolgen im JavaScript-Code.

Parameter parameters-5

Beispiel example-3

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

Einschließen include

Hilfsmittel zum Einschließen einer Komponente als nicht vorhandene Ressource in eine Vorlage.

Diese Methode ermöglicht die programmgesteuerte Anpassung der Ressource, als es für eine Ressource möglich ist, die als JCR-Knoten hinzugefügt wird. Siehe Hinzufügen oder Einschließen einer Communities-Komponente.

Es sind nur einige ausgewählte Communities-Komponenten verfügbar, die einbezogen werden können.

Dieser Helfer, der nur serverseitig geeignet ist, bietet Funktionen, die cq:include für JSP-Skripte ähneln.

Parameter parameters-6

Beispiel example-4

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

Enthält eine neue Kommentarkomponente unter this.id + /comments.

IncludeClientLib includeclientlib

Ein Hilfsprogramm, das eine AEM HTML-Client-Bibliothek enthält, die eine JS-, CSS- oder Design-Bibliothek sein kann. Für mehrere Einschlüsse verschiedener Typen, z. B. js und css, muss dieses Tag im Handlebars-Skript mehrmals verwendet werden.

Dieser Helfer, der nur serverseitig geeignet ist, bietet Funktionen, die ui:includeClientLib für JSP-Skripte ähneln.

Parameter parameters-7

Beispiele examples-2

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

Pretty-time pretty-time

Ein Hilfsmittel, mit dem angezeigt wird, wie viel Zeit bis zu einem Cutoff-Punkt vergangen ist, nach dem ein reguläres Datumsformat angezeigt wird.

Zum Beispiel:

Parameter parameters-8

Beispiel example-5

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

Ein Hilfsprogramm, das eine Quellzeichenfolge für HTML-Elementinhalte kodiert, um den Schutz vor XSS zu unterstützen.

HINWEIS: Dieser Assistent ist kein Validator und darf nicht zum Schreiben von Attributwerten verwendet werden.

Parameter parameters-9

Beispiel example-6

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

Xss-htmlAttr xss-htmlattr

Ein Hilfsprogramm, das eine Quellzeichenfolge zum Schreiben in einen HTML-Attributwert kodiert, um den Schutz vor XSS zu erleichtern.

HINWEIS: Dieser Helfer ist kein Validator und darf nicht zum Schreiben von verwertbaren Attributen (href, src, event handlers) verwendet werden.

Parameter parameters-10

Beispiel example-7

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

Xss-jsString xss-jsstring

Ein Hilfsprogramm, das eine Quellzeichenfolge zum Schreiben in JavaScript-Zeichenfolgeninhalte kodiert, um den Schutz vor XSS zu unterstützen.

HINWEIS: Dieser Helfer ist kein Validator und darf nicht zum Schreiben in beliebige JavaScript verwendet werden.

Parameter parameters-11

Beispiel example-8

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

Xss-validHref xss-validhref

Ein Helfer, der eine URL zum Schreiben als HTML href- oder srce-Attributwert bereinigt, um den Schutz vor XSS zu unterstützen.

HINWEIS: Dieser Helfer kann eine leere Zeichenfolge zurückgeben.

Parameter parameters-12

Beispiel example-9

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

Handlebars.js - Grundlegende Übersicht handlebars-js-basic-overview

Ein Beispiel für einen einfachen Helfer aus der Handlebars.js-Dokumentation: an-example-of-a-simple-helper-from-handlebars-js-documentation

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

würde rendern:

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

Ein Beispiel für einen Block-Helfer aus der Handlebars.js-Dokumentation: an-example-of-a-block-helper-from-handlebars-js-documentation

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

würde rendern:
<ul>
<li><a href="/people/1">Alan</a></li>
<li><a href="/people/2">Yehuda</a></li>
</ul>

Benutzerdefinierte SCF-Helfer custom-scf-helpers

Benutzerdefinierte Helfer müssen auf Server- und Client-Seite implementiert werden, insbesondere bei der Übergabe von Daten. Bei SCF werden die meisten Vorlagen serverseitig kompiliert und gerendert, da der Server die HTML für eine bestimmte Komponente generiert, wenn die Seite angefordert wird.

Benutzerdefinierte Helfer serverseitig server-side-custom-helpers

Um einen benutzerdefinierten SCF-Helfer serverseitig zu implementieren und zu registrieren, implementieren Sie einfach die Java™-Schnittstelle TemplateHelper, machen Sie sie zu einem OSGi-Dienst und installieren Sie sie als Teil eines OSGi-Bundles.

Zum Beispiel:

FooTextHelper.java 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;
    }
}

Clientseitige benutzerdefinierte Helfer client-side-custom-helpers

Die clientseitigen Helfer sind Handlebars-Skripte, die durch Aufrufen von Handlebars.registerHelper() registriert werden.
Zum Beispiel:

custom-helpers.js custom-helpers-js

function(Handlebars, SCF, $CQ) {

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

})(Handlebars, SCF, $CQ);

Die benutzerdefinierten clientseitigen Helfer müssen einer benutzerdefinierten Client-Bibliothek hinzugefügt werden.
Die clientlib muss:

Hinweis: Die SCF-Helfer sind in /etc/clientlibs/social/commons/scf/helpers.js definiert.