Dokumentacja JavaScript widgetu

Dla developerów i agencji. Jeśli chcesz po prostu mieć widget na swojej stronie, użyj zamiast tego poradników instalacji, dashboard generuje ten kod za Ciebie.

Struktura fragmentu kodu

Trzy części. Część 1 ładuje bibliotekę raz na stronę. Część 2 inicjalizuje jeden widget. Część 3 to kontener, który decyduje, gdzie się renderuje.

<!-- 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 to zahaszowany identyfikator z Ustawień. Jest bezpieczny w publicznym HTML, pozwala jedynie czytać opinie, które zdecydowałeś się opublikować.

Funkcje

Funkcja	Widget	Plan
`initBadge`	pływający badge z Twoją oceną	Free
`initSummary`	średnia, liczba i rozkład ocen	Plus
`initTestimonials`	karuzela pełnych opinii	Plus
`initCounters`	liczba opinii per źródło	Plus
`initReviewsPage`	pełna strona opinii z opcjonalnym formularzem	Pro
`initStars`	gwiazdki w linii	Pro

Sygnatura:

initTestimonials(userId, options, containerClass);

Trzeci argument jest opcjonalny i potrzebny tylko wtedy, gdy pokazujesz ten sam widget więcej niż raz na stronie.

Opcje

Wspólne

services (tablica ciągów znaków) ogranicza widget do wybranych źródeł. Puste albo pominięte oznacza każde podłączone źródło.

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

Użyj wewnętrznych nazw źródeł. Źródła w stylu domen niosą domenę, na przykład etsy.com, booking.com, apps.apple.com. Wygenerowany kod z dashboardu już zawiera poprawne wartości, co jest najbezpieczniejszym sposobem, żeby je poprawnie uzyskać.

styles (obiekt) ustawia kolory, zaokrąglenia i pozycjonowanie. Selektory kolorów w dashboardzie zapisują się do tego obiektu.

showJustReviewLogo (boolean) pokazuje albo ukrywa nasze logo. Ukrycie go to White Label, dostępne od Plus.

`initBadge`

Opcja	Typ	Co robi
`enableAggregateRatings`	boolean	generuje dane strukturalne dla Google. Pro+, i Twoja nazwa marki musi być ustawiona
`disableBadge`	boolean	nie renderuje widocznego badge’a. W połączeniu z powyższym daje same dane strukturalne
`disableOnMobile`	boolean	ukrywa badge na małych ekranach
`fadeOutWhenScrollingOnMobile`	boolean	wygasza badge podczas przewijania na urządzeniach mobilnych

Badge to jedyny widget, który emituje dane strukturalne. Zobacz gwiazdki w wynikach Google.

`initSummary`

Opcja	Typ	Co robi
`displayHeader`	boolean	pokazuje domyślny nagłówek
`displayCustomHeader`	boolean	użyj własnego nagłówka zamiast domyślnego
`customHeader`	string	tekst nagłówka

`initCounters`

Opcja	Typ	Co robi
`displayReviewsAmount`	boolean	pokazuje liczbę obok każdego źródła
`config`	object	ustawienia wyświetlania per źródło

`initStars`

Opcja	Typ	Co robi
`displayLogo`	boolean	pokazuje logo JustReview obok gwiazdek
`displaySummary`	boolean	pokazuje ocenę i liczbę obok gwiazdek

`initReviewsPage`

Opcja	Typ	Co robi
`config`	object	układ, sortowanie i stronicowanie

Formularz opinii i moderacja żyją w tym widgecie, zobacz zbieraj własne opinie.

Ponowna inicjalizacja po doładowaniu treści

Widget inicjalizuje się przy ładowaniu strony. Elementy dodane później przez JavaScript nigdy nie są przetwarzane, więc wywołaj funkcję init ponownie, gdy Twoja nowa treść jest już w DOM. Pełna recepta, w tym fallback z MutationObserver, w widget brakuje na dynamicznie doładowanej treści.

Rzeczy, które Cię ugryzą

Nie minifikuj ani nie hostuj justreview.js samodzielnie. Jest serwowany z cachowaniem i nagłówkami, których potrzebuje, a zmodyfikowana kopia psuje subresource integrity wszystkim.

Ładowanie asynchroniczne i łączniki skryptów. Wtyczki optymalizacyjne, które opóźniają albo łączą skrypty, zmieniają kolejność wykonania, co jest najczęstszą przyczyną widgetu, który działał, a potem przestał. Wyklucz justreview.js z optymalizacji JavaScript.