Twój pierwszy widget Livedeck: od starter kitu do przesłania
Pobierz starter kit, zmień go, prześlij jako ZIP i przetestuj w edytorze.
Starter kit to gotowy widget „Live Feed”: pokazuje prezenty, obserwacje i czat jako karty oraz liczy polubienia. Na jego bazie zbuduj własny.
Co jest w paczce
manifest.json
Nazwa, wersja, rozmiar, uprawnienia i ustawienia widgetu
index.html
Strona startowa. Ładuje SDK i twoje pliki.
style.css
Wygląd
app.js
Logika: reaguje na zdarzenia
README.md
Krótki przewodnik
| Plik | Przeznaczenie |
|---|---|
| manifest.json | Nazwa, wersja, rozmiar, uprawnienia i ustawienia widgetu |
| index.html | Strona startowa. Ładuje SDK i twoje pliki. |
| style.css | Wygląd |
| app.js | Logika: reaguje na zdarzenia |
| README.md | Krótki przewodnik |
Strona startowa
Każda strona startowa ładuje SDK ze ścieżki /sdk/v1.js. Livedeck udostępnia je pod adresem twojego widgetu – nie dodajesz go sam do paczki. Wszystkie pozostałe pliki ładuj ścieżkami względnymi.
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<link rel="stylesheet" href="style.css">
<!-- Livedeck serves the SDK. Everything else lives in your package. -->
<script src="/sdk/v1.js"></script>
</head>
<body>
<div id="feed"></div>
<script src="app.js"></script>
</body>
</html>Reagowanie na zdarzenia
function show(text) {
const line = document.createElement("p");
line.textContent = text; // textContent, never innerHTML: names are viewer text
document.getElementById("feed").prepend(line);
}
livedeck.on("gift", (e) => {
// "@" + e.user.handle (username), e.gift.name, e.count, e.totalDiamonds
show("@" + e.user.handle + " sent " + e.count + "× " + e.gift.name);
});
livedeck.on("follow", (e) => {
show("@" + e.user.handle + " followed you");
});
livedeck.ready(() => {
// The overlay is connected and the settings are here.
document.body.style.color = livedeck.settings.accent;
});Widget dostaje tylko te zdarzenia, o które prosi w permissions w manifest.json. W przykładzie powyżej to events.gift i events.follow.
Spakuj i wgraj
- Podnieś wersję w manifest.json (np. z 1.0.0 na 1.0.1), żeby później odróżniać swoje wersje.
- Spakuj pliki do ZIP. manifest.json musi być na najwyższym poziomie ZIP-a albo w jedynym folderze, który zawiera wszystko. Windows: zaznacz pliki › prawy przycisk › Wyślij do › Folder skompresowany (zip). Mac: zaznacz pliki › prawy przycisk › Kompresuj.
- W panelu: Edytor › Moje widgety › „Wgraj własny”. Za pierwszym razem tworzysz profil dewelopera i akceptujesz zasady.
- Po około minucie sprawdzanie jest gotowe. Nie przeszło? Zobaczysz każdy powód z plikiem i linią albo ze zmierzoną wartością. Popraw i wgraj nowy ZIP.
- Umieść widget na płótnie i przetestuj go przyciskami testowymi w jego ustawieniach (prezent, czat, polubienia i inne).
Czy ten artykuł był pomocny?