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 openHoldingOnSelect 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 ; transmettez aussi une closure et les lignes deviennent touchables. 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 la lecture. Un compte nécessite company:balance:read ; les avoirs d’un utilisateur ou la liste de ses comptes possédés nécessitent user:balance:read. Générez-le sur votre serveur avec POST /api/v1/access_tokens. Sans lui, la lecture utilise la propre session du visiteur, qui ne fonctionne qu’en same-origin.
boolean
Pour le compte user_… d’un utilisateur, liste son solde personnel suivi de chaque compte possédé renvoyé par le backend, au lieu de lister les avoirs de son compte personnel. Ignoré pour un compte. Par défaut : false.
boolean
Affiche chaque ligne dans la devise dans laquelle elle est détenue (€4.20, 0.00000009 cbBTC) et place la valeur en dollars en dessous. Désactivé par défaut, de sorte que chaque ligne est en dollars. Par défaut : false.
boolean
Conserve la valeur en dollars sous un avoir affiché dans sa propre devise. Ne s’applique que lorsque showSourceCurrency est activé. Par défaut : true.
boolean
Conserve la ligne personnelle lorsque includeOwnedAccounts est activé. Désactivez-la si votre application n’a aucun compte personnel à ouvrir. Par défaut : true.
number
Affiche au maximum ce nombre de lignes d’avoirs, du plus grand au plus petit. S’il y en a davantage, la liste obtient un contrôle Show all balances qui déploie le reste sur place. Sans cette option, tous les avoirs sont listés.

Événements

Transmettez les callbacks dans les options de création ou dans les props React.

onBalanceSelected

Une ligne d’avoir a été cliquée, avec includeOwnedAccounts désactivé. holding vaut usd pour la ligne en dollars combinée, sinon le symbole de l’avoir (cbBTC, EUR), et kind vous indique lequel des trois il s’agit, afin que vous puissiez router sans classer vous-même les symboles. L’élément ne navigue jamais.
object

onAccountSelected

Une ligne de compte a été cliquée, avec includeOwnedAccounts activé. accountId est le tag personnel user_… ou un tag biz_… possédé, et kind vous permet de router sans l’inspecter. L’élément ne navigue jamais.
object

onCreditsSelected

La ligne des crédits Whop a été cliquée. Les crédits ne sont utilisables que sur Whop et ne sont jamais retirables : ils se trouvent donc en dehors de toutes les lignes d’avoirs ; l’hôte ouvre son propre écran de crédits. L’élément ne navigue jamais.

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<ListElementProps>
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.
((WalletBalance) -> Void)?
Appelé avec la ligne touchée par le visiteur. Omettez-le et les lignes s’affichent sans chevrons, et le toucher ne fait rien.

WalletBalance

Ce que renvoie une sélection :
  • id: String : stable pour chaque ligne
  • symbol: String : USD, BTC, …
  • displayName: String : le nom affiché sur la ligne
  • amountUsd: Decimal : la valeur de la ligne en dollars
  • isCrypto: Bool : un avoir crypto plutôt que fiat

États

Affiche deux lignes provisoires pendant le chargement des soldes. Un ID de compte qui ne peut pas être résolu affiche Couldn't load this account. Si la lecture du solde elle-même échoue, la liste s’affiche vide plutôt que d’afficher une erreur.

Bon à savoir

  • Elle ne défile pas d’elle-même : placez-la dans une ScrollView lorsqu’elle partage un écran avec d’autres contenus.
  • Se combine avec BalanceElement, qui affiche le total du même compte et son évolution.
Appelez WhopSDK.configure(tokenProvider:) une seule fois au lancement. Les vues attendent le jeton. Consultez Premiers pas. Appliquez un thème avec .whopTheme(_:).