Cette page documente
@whop/elements@1.10.0 et @whop/elements-react@1.10.0.v1.0.0.
Se monte à l’intérieur de
Balances, dans Wallet. accountId et currency proviennent de Wallet. Transmettez les props et les callbacks via les options de création ou les props React.Données d’exemple. Ouvrir le Playground.
Props
Un jeton à portée limitée pour les lectures. Un compte nécessite
company:balance:read pour le total et stats:read pour le graphique ; le propre solde d’un utilisateur nécessite user:balance:read. Générez-le sur votre serveur avec POST /api/v1/access_tokens et définissez-en un nouveau avant son expiration. Sans lui, les lectures utilisent la propre session du visiteur, qui ne fonctionne qu’en same-origin. Par défaut : "".La période sur laquelle s’ouvrir. Les boutons la modifient ensuite, ou redéfinissez cette prop pour la contrôler vous-même. Par défaut :
"1M".La date d’ouverture du compte, sous forme d’horodatage ISO 8601.
ALL commence à cette date au lieu de sa valeur par défaut de cinq ans, de sorte qu’un compte plus ancien conserve tout son historique. Par défaut : "".Ajoute le nom du compte au libellé :
Total balance · Acme normalement, et Acme balance on Jul 9 lorsque le visiteur lit un point. Sans lui, le libellé est simplement Total balance. Par défaut : "".La plage sélectionnée sur le graphique, sous forme d’horodatages ISO 8601. Définissez-la pour contrôler vous-même la sélection, ou
null pour effacer celle du visiteur. Renvoyez ce que signale rangeBrushed, et l’effacement d’un filtre ailleurs sur votre page efface aussi la sélection ici. Par défaut : null.Un instant à marquer sur le graphique, sous forme d’horodatage ISO 8601 — le point que désigne un autre élément de votre page, comme la ligne sous le pointeur dans une liste d’activité. Cela équivaut à ce que le visiteur survole lui-même ce point, et c’est ignoré lorsque l’instant tombe en dehors de la fenêtre affichée ou lorsque le visiteur lit le graphique. Par défaut :
"".Pour un utilisateur, additionne son propre argent et celui de chaque compte qu’il possède, au lieu de son seul argent. Ignoré pour un compte, qui est déjà un compte unique. Par défaut :
false.Masque le total et sa variation, en conservant le graphique et les boutons de période. Par défaut :
false.Événements
Transmettez les callbacks dans les options de création ou dans les props React.onRangeChanged
La période visible a changé. Répercutez-la si un autre élément de votre page lit la même période.onRangeBrushed
Le visiteur a fait glisser le pointeur sur le graphique pour sélectionner une plage, ou a effacé la sélection (null). Fournit des horodatages ISO 8601 ainsi que la période dans laquelle ils ont été lus, afin que vous puissiez filtrer vos propres vues, comme une liste d’activité ou un tableau, sur la même période.onLoaderStart
S’exécute après le premier affichage du squelette de chargement et avant onReady.onReady
S’exécute après le premier affichage complet de l’élément.onError
S’exécute lorsque l’élément ne parvient pas à se charger ou plante. L’affichage de repli reste visible. Utilisez code pour une gestion programmatique. sourceKey identifie une source d’état hôte en échec.Méthodes
Appelez-les sur le handle renvoyé parcreate, ou via une ref React.mount
Monte l’élément dans target et démarre le chargement. Les composants React se montent eux-mêmes.Paramètresdestroy
Supprime l’élément et libère son frame et ses abonnements. Vous pouvez l’appeler plusieurs fois. React supprime l’élément automatiquement.update
Fusionne de nouvelles props dans l’élément monté. Avec React, modifiez plutôt les props du composant.ParamètresStyle
Stylisez ces parties viaappearance.classes. Utilisez le camel case ou le kebab case pour les noms de propriétés et incluez les unités. Les feuilles de style de la page ne peuvent pas atteindre le frame de l’élément. Le framework valide chaque déclaration avant de l’injecter.appearance à <Wallet>. Définissez-la globalement avec WhopElements({ appearance }).
