Widget-JavaScript-Referenz

Für Entwickler und Agenturen. Wollen Sie das Widget nur auf Ihrer Seite haben, nutzen Sie stattdessen die Installationsanleitungen, das Dashboard generiert diesen Code für Sie.

Aufbau des Snippets

Drei Teile. Teil 1 lädt die Bibliothek einmal pro Seite. Teil 2 initialisiert ein Widget. Teil 3 ist der Container, der entscheidet, wo es gerendert wird.

<!-- part 1: once per page, regardless of how many widgets -->
<script src="https://justreview.co/widget/justreview.js"></script>
<link rel="stylesheet" href="https://justreview.co/widget/justreview.css">

<!-- part 2: one block per widget -->
<script>
  initTestimonials("YOUR_USER_ID", { /* options */ });
</script>

<!-- part 3: where it appears -->
<div id="justreview-testimonials"></div>

YOUR_USER_ID ist die gehashte Kennung aus Settings. Sie ist im öffentlichen HTML unbedenklich, sie erlaubt nur das Lesen der Bewertungen, die Sie zur Veröffentlichung ausgewählt haben.

Die Funktionen

Funktion	Widget	Plan
initBadge	schwebendes Badge mit Ihrer Bewertung	Free
initSummary	Durchschnitt, Anzahl und Bewertungsverteilung	Plus
initTestimonials	Karussell mit vollständigen Bewertungen	Plus
initCounters	Bewertungsanzahl pro Quelle	Plus
initReviewsPage	vollständige Bewertungsseite mit optionalem Formular	Pro
initStars	Sterne inline	Pro

Signatur:

initTestimonials(userId, options, containerClass);

Das dritte Argument ist optional und nur nötig, wenn Sie dasselbe Widget mehrfach auf einer Seite zeigen.

Optionen

Gemeinsam

services (Array von Strings) beschränkt das Widget auf ausgewählte Quellen. Leer oder weggelassen bedeutet jede verbundene Quelle.

services: ["google", "facebook", "etsy.com"]

Verwenden Sie die internen Quellnamen. Domain-artige Quellen tragen die Domain, zum Beispiel etsy.com, booking.com, apps.apple.com. Der vom Dashboard generierte Code enthält bereits die korrekten Werte, das ist der sicherste Weg, sie richtig zu bekommen.

styles (Objekt) legt Farben, Radien und Positionierung fest. Die Farbwähler im Dashboard schreiben in dieses Objekt.

showJustReviewLogo (boolean) zeigt oder versteckt unser Logo. Es zu verstecken ist White Label, verfügbar ab Plus.

initBadge

Option	Typ	Was sie tut
enableAggregateRatings	boolean	gibt strukturierte Daten für Google aus. Pro+, und Ihr Markenname muss gesetzt sein
disableBadge	boolean	rendert das sichtbare Badge nicht. Zusammen mit obigem ergibt das nur strukturierte Daten
disableOnMobile	boolean	blendet das Badge auf kleinen Bildschirmen aus
fadeOutWhenScrollingOnMobile	boolean	blendet das Badge beim Scrollen auf Mobilgeräten aus

Das Badge ist das einzige Widget, das strukturierte Daten ausgibt. Siehe Sterne in Google-Ergebnissen.

initSummary

Option	Typ	Was sie tut
displayHeader	boolean	zeigt die Standardüberschrift
displayCustomHeader	boolean	nutzt stattdessen Ihre eigene Überschrift
customHeader	string	der Überschriftentext

initCounters

Option	Typ	Was sie tut
displayReviewsAmount	boolean	zeigt die Zahl neben jeder Quelle
config	object	Anzeigeeinstellungen pro Quelle

initStars

Option	Typ	Was sie tut
displayLogo	boolean	zeigt das JustReview-Logo neben den Sternen
displaySummary	boolean	zeigt Bewertung und Anzahl neben den Sternen

initReviewsPage

Option	Typ	Was sie tut
config	object	Layout, Sortierung und Paginierung

Das Bewertungsformular und die Moderation liegen in diesem Widget, siehe eigene Bewertungen sammeln.

Neu initialisieren, nachdem Inhalte geladen wurden

Das Widget initialisiert sich beim Laden der Seite. Später per JavaScript hinzugefügte Elemente werden nie verarbeitet, rufen Sie die Init-Funktion daher erneut auf, nachdem Ihr neuer Inhalt im DOM ist. Das vollständige Rezept, einschließlich eines MutationObserver-Fallbacks, in Widget fehlt bei dynamisch nachgeladenen Inhalten.

Dinge, die Ihnen auf die Füße fallen

Einstellungen liegen im Snippet, nicht auf unserem Server

Etwas im Dashboard zu ändern, ändert nicht, was Ihre Seite rendert. Die Konfiguration steckt im init-Aufruf auf Ihrer Seite. Generieren Sie neu und ersetzen Sie ihn, oder bearbeiten Sie das Objekt von Hand.

Die Domain-Whitelist wird serverseitig durchgesetzt

Das Widget rendert nicht auf einer Domain, die nicht in Settings steht. Das schließt Staging-Domains und Vorschau-Domains von Baukästen ein. Wix liefert eigenen Code aus einem iframe auf seinem eigenen Host aus, der separat gewhitelistet werden muss, siehe den Wix-Leitfaden.

Laden Sie die Bibliothek genau einmal

Zwei Kopien von justreview.js auf einer Seite können das Rendering stören. Bei mehreren Widgets erscheint Teil 1 einmal und Teil 2 wiederholt sich.

Minifizieren oder selbst hosten Sie justreview.js nicht. Es wird mit dem nötigen Caching und den nötigen Headern ausgeliefert, und eine veränderte Kopie bricht die Subresource Integrity für alle.

Asynchrones Laden und Skript-Kombinierer. Optimierungs-Plugins, die Skripte verzögern (defer) oder bündeln, ändern die Ausführungsreihenfolge, das ist die häufigste Ursache für ein Widget, das funktionierte und dann aufhörte. Schließen Sie justreview.js von der JavaScript-Optimierung aus.