Skip to main content
Cette page documente @whop/elements@1.10.0 et @whop/elements-react@1.10.0.
Depuis 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.
Se monte n’importe où dans votre hiérarchie de vues. Prend un accountId et charge ses propres données ; range choisit la période sur laquelle il s’ouvre. La racine est une VStack : elle s’adapte à son contenu et remplit la largeur que vous lui donnez.

Données d’exemple. Ouvrir le Playground.

Props

string
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 : "".
"1D" | "1W" | "1M" | "1Y" | "ALL"
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".
string
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 : "".
string
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 : "".
object | null
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.
string
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 : "".
boolean
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.
boolean
Masque le total et sa variation, en conservant le graphique et les boutons de période. Par défaut : false.
boolean
Masque le graphique, en conservant le total et les boutons de période. Par défaut : false.
number
La hauteur du graphique, en pixels. Par défaut : 210.

É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.
object

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.
object | null

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.
object

Méthodes

Appelez-les sur le handle renvoyé par create, 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ètres
string | HTMLElement
requis

destroy

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ètres
Partial<BalanceElementProps>
requis

Style

Stylisez ces parties via appearance.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.
Avec React, transmettez appearance à <Wallet>. Définissez-la globalement avec WhopElements({ appearance }).

Paramètres

String
requis
Le compte dont la vue lit l’argent. Utilisez un ID de compte préfixé par biz_. Un ID d’utilisateur préfixé par user_ lit le propre solde du visiteur et nécessite une authentification du visiteur (WhopSDK.configureWithOAuth), et non un jeton de compte.
String
La devise dans laquelle le total et le graphique sont affichés. Par défaut : "usd".
WalletBalanceRange
La période sur laquelle le graphique s’ouvre : .oneDay, .oneWeek, .oneMonth, .oneYear, .all. Par défaut : .oneMonth, et le visiteur peut la modifier avec le sélecteur.

États

Affiche un graphique provisoire pendant le chargement des données. Si la période de comparaison échoue, la variation est masquée plutôt que devinée : tout nombre à l’écran a donc réellement été mesuré. Un ID de compte qui ne peut pas être résolu affiche Couldn't load this account. au lieu d’un indicateur de chargement sans fin.

Bon à savoir

  • Appuyez et faites glisser sur le graphique pour le parcourir. Le chiffre principal suit le point sous votre doigt et revient au total lorsque vous relâchez.
  • L’historique du solde n’est disponible que pour les ID de compte préfixés par biz_ : un compte personnel préfixé par user_ affiche donc le total sans graphique.
  • Se combine avec ListElement, qui décompose le même total en avoirs individuels.
Appelez WhopSDK.configure(tokenProvider:) une seule fois au lancement. Les vues attendent le jeton. Consultez Premiers pas. Appliquez un thème avec .whopTheme(_:).