Votre premier widget Livedeck : du kit de démarrage à l’import
Téléchargez le kit de démarrage, modifiez-le, importez-le en ZIP et testez-le dans l’éditeur.
Le kit de démarrage est un widget complet appelé « Live Feed » : il affiche les cadeaux, les follows et le chat sous forme de cartes et compte les likes. Créez le vôtre à partir de là.
Contenu du package
manifest.json
Nom, version, taille, autorisations et réglages du widget
index.html
La page de départ. Elle charge le SDK et vos fichiers.
style.css
L’apparence
app.js
La logique : réagit aux événements
README.md
Guide rapide
| Fichier | Rôle |
|---|---|
| manifest.json | Nom, version, taille, autorisations et réglages du widget |
| index.html | La page de départ. Elle charge le SDK et vos fichiers. |
| style.css | L’apparence |
| app.js | La logique : réagit aux événements |
| README.md | Guide rapide |
La page de démarrage
Chaque page de démarrage charge le SDK depuis le chemin /sdk/v1.js. Livedeck le fournit à l’adresse de votre widget : vous n’avez pas à l’ajouter au package. Chargez tous vos autres fichiers avec des chemins relatifs.
<!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>Réagir aux événements
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;
});Un widget ne reçoit que les événements qu’il demande dans permissions du fichier manifest.json. Pour l’exemple ci-dessus, il s’agit de events.gift et events.follow.
Compresser et importer
- Augmentez la version dans manifest.json (par exemple de 1.0.0 à 1.0.1) pour pouvoir distinguer vos versions plus tard.
- Compressez les fichiers en ZIP. manifest.json doit se trouver à la racine du ZIP ou dans l’unique dossier qui contient tout. Windows : sélectionnez les fichiers › clic droit › Envoyer vers › Dossier compressé. Mac : sélectionnez les fichiers › clic droit › Compresser.
- Dans le dashboard : Éditeur › Mes widgets › « Importer le vôtre ». La première fois, vous créez un profil développeur et acceptez les règles.
- La vérification prend environ une minute. Refusé ? Vous voyez chaque raison avec le fichier et la ligne, ou la valeur mesurée. Corrigez et importez un nouveau ZIP.
- Placez le widget sur le canevas et testez-le avec les boutons de test dans ses paramètres (cadeau, chat, likes, etc.).
Cet article vous a-t-il été utile ?