Je eerste Livedeck-widget: van starterkit tot upload
Download de starterkit, pas hem aan, upload hem als ZIP en test hem in de editor.
De starterkit is een kant-en-klare widget genaamd ‘Live Feed’: hij toont cadeaus, follows en chat als kaarten en telt de likes. Bouw van daaruit je eigen widget.
Wat zit er in het pakket
manifest.json
Naam, versie, grootte, rechten en instellingen van de widget
index.html
De startpagina. Die laadt de SDK en je bestanden.
style.css
De look
app.js
De logica: reageert op events
README.md
Korte handleiding
| Bestand | Doel |
|---|---|
| manifest.json | Naam, versie, grootte, rechten en instellingen van de widget |
| index.html | De startpagina. Die laadt de SDK en je bestanden. |
| style.css | De look |
| app.js | De logica: reageert op events |
| README.md | Korte handleiding |
De startpagina
Elke startpagina laadt de SDK via het pad /sdk/v1.js. Livedeck levert die op het adres van je widget; je zet hem zelf niet in het pakket. Laad al je andere bestanden met relatieve paden.
<!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>Reageren op events
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;
});Een widget krijgt alleen de events die hij onder permissions in manifest.json aanvraagt. Voor het voorbeeld hierboven zijn dat events.gift en events.follow.
Zippen en uploaden
- Verhoog de versie in manifest.json (bijvoorbeeld van 1.0.0 naar 1.0.1), zodat je je versies later uit elkaar kunt houden.
- Zip de bestanden. manifest.json moet bovenaan in de ZIP staan of in de ene map die alles bevat. Windows: selecteer de bestanden › rechtsklik › Kopiëren naar › Gecomprimeerde (gezipte) map. Mac: selecteer de bestanden › rechtsklik › Comprimeer.
- In het dashboard: Editor › Mijn widgets › ‘Eigen widget uploaden’. De eerste keer maak je een ontwikkelaarsprofiel aan en accepteer je de regels.
- Na ongeveer een minuut is de controle klaar. Niet goedgekeurd? Je ziet elke reden met bestand en regel, of met de gemeten waarde. Los het op en upload een nieuwe ZIP.
- Plaats de widget op het canvas en probeer hem uit met de testknoppen in de instellingen (cadeau, chat, likes en meer).
Was dit artikel nuttig?