Skip to main content
Cette page documente @whop/elements@1.10.0 et @whop/elements-react@1.10.0.
Depuis v1.0.0.

Playground

Assemblez les éléments avec des données d’exemple. Manipulez les contrôles, ajoutez et organisez des éléments, et observez les événements se déclencher en direct :

Options

Transmettez-les à whop.wallet.create({ … }), ou comme props sur <Wallet> avec React.
string
Code de devise ISO 4217 à trois lettres pour les champs de montant. Un code inconnu revient à usd. Par défaut : "usd".
string
Jeton optionnel à portée limitée transmis aux enfants du wallet adossés à des données. Sans lui, les lectures utilisent la session du visiteur.
boolean
Affiche la page de solde d’un avoir à la place du graphique et de la liste des soldes lorsqu’une ligne est cliquée. Désactivé par défaut afin qu’un hôte qui effectue son routage sur balanceSelected ne soit pas recouvert par un second écran. Par défaut : false.
string
requis
ID du compte ou de l’utilisateur dont ces surfaces lisent l’argent. Les ID de compte sont préfixés par biz_ ; les ID d’utilisateur sont préfixés par user_ et ne peuvent lire que le propre solde du visiteur.
Appearance
Personnalisation visuelle des éléments de ce groupe. Remplace le WhopElements({ appearance }) global. Modifiez-la en direct avec update({ appearance }).
WhopElementsLocale
Langue du texte de l’interface des éléments de ce groupe. Définissez-la sur l’une des langues intégrées à l’application pour remplacer la configuration globale. Toute autre valeur revient à la langue par défaut.

Événements

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

onIdentityVerificationRequested

Un dépôt nécessite une vérification d’identité. Gérez ce callback pour ouvrir vos paramètres ou votre parcours de vérification ; Wallet ne navigue pas.
object

onLoadingChange

S’exécute lorsque l’état de chargement groupé change. La valeur est true tant qu’un élément monté est encore en cours de chargement.
boolean

Méthodes

Appelez-les sur le handle Wallet obtenu via whop.wallet.create({ … }) ou useWallet().

update

Fusionne de nouvelles options de handle dans chaque élément monté. Avec React, modifiez plutôt les props du namespace. Paramètres
Partial<WalletOptions>
requis

destroy

Détruit chaque élément et sous-contrôleur créé par ce handle, supprime le frame du contrôleur et libère ses abonnements. Vous pouvez l’appeler plusieurs fois, mais un handle détruit refuse tout autre appel — créez un nouveau handle pour recommencer. React supprime le groupe automatiquement lorsque le provider est démonté.

Éléments

Les éléments montés par ce groupe. Chacun a sa propre page :

ActionsElement

La rangée d’actions du compte issue du tableau de bord des soldes de Whop. Deposit, Send, Withdraw et Convert ouvrent les overlays intégrés du contrôleur Wallet. Accept ouvre le créateur de liens de paiement de Whop pour un compte professionnel, ou la création d’entreprise pour un compte personnel. Chaque bouton émet aussi son événement de demande afin que la page hôte puisse observer l’action.

Balances

Trois vues de l’argent d’un compte. La vue du solde affiche le total, un graphique de son évolution et un sélecteur de période. La vue de liste affiche les avoirs qui composent ce total, valorisés en dollars. La vue de répartition divise une devise en montants disponibles, en attente, en réserve et négatifs, sans contrôles de mouvement d’argent. Lorsque openHoldingOnSelect est activé, une ligne de la liste remplace le canevas de cette unité — le graphique et la liste — par la page de solde de cet avoir, au lieu de simplement signaler le clic. (sous-contrôleur, 4 éléments)

Reports

L’historique du solde et l’activité financière qui le sous-tend, avec des exports CSV. Les relevés de compte sont disponibles dans le tableau de bord Whop. (sous-contrôleur, 2 éléments)

ActivityElement

L’activité du registre d’un compte : chaque mouvement d’argent entrant ou sortant, du plus récent au plus ancien. La liste se pagine au fil du défilement, et les lignes signalent celle qui a été touchée au lieu de naviguer, afin que vous puissiez ouvrir votre propre écran de détail.

ActivityDetailElement

Un tiroir de détail autonome pour un mouvement. Pointez-le vers une ligne d’activité financière préchargée, un ID d’activité du registre ou un ID de transaction par carte — une ligne préchargée est prioritaire, sinon l’élément récupère lui-même l’enregistrement. Une transaction par carte ouvre le reçu de la carte : marchand, montant, statut, carte débitée, titulaire sur un compte d’entreprise, date de règlement, catégorie, conversion de devise et cashback.

DepositElement

Approvisionne un compte Whop. Affiche un champ de montant et les canaux d’approvisionnement actifs du compte — crypto (une adresse de dépôt par réseau avec son QR code) et virement bancaire (les coordonnées de virement pour chaque devise de règlement). Les canaux d’un compte professionnel se résolvent sans identifiants, ils fonctionnent donc sur n’importe quelle page ; un compte personnel (user_) ne révèle ses canaux qu’à lui-même, transmettez donc accessToken pour celui-ci — s’il est omis, la propre session same-origin du visiteur suffit. Les cartes et le solde de la plateforme sont optionnels : transmettez savedCards, allowNewCard ou showPlatformBalance et l’élément collecte le montant et le choix, puis émet cardDepositRequested / addCardRequested / platformBalanceSelected et attend que vous appeliez showStep({ step: 'amount' }) une fois votre propre écran terminé.

ConvertElement

Convertit le solde en USD d’un compte en Gold, en Coinbase Wrapped Bitcoin ou en jeton d’action, et inversement, via l’API publique de swaps de Whop. Un montage cross-origin nécessite un accessToken limité à company:balance:read ainsi qu’à crypto_wallet:swap ou crypto_wallet:manage.

WithdrawElement

Collecte un montant de versement et un moyen de versement enregistré, regroupe les options de versement standard et instantané avec les frais en direct et les estimations d’arrivée, et collecte un nouveau moyen de versement si nécessaire. Lorsque l’hôte ne pilote pas le parcours, l’élément liste les moyens et crée lui-même le versement — transmettez accessToken (ou appuyez-vous sur la session same-origin du visiteur). Un hôte qui communique déjà avec l’API des versements peut toujours fournir les moyens, les limites et les indicateurs de chargement ; la confirmation émet alors withdrawalRequested pour que cet hôte crée le versement.

SendElement

Envoie de l’argent depuis un compte vers un destinataire — un utilisateur, un autre compte ou un lien de réclamation public que n’importe qui peut utiliser. Les transferts directs utilisent le canal fiat ou crypto configuré du compte source. Affiche sa propre recherche de destinataires, résolue à partir de l’ID du compte, sans autre identifiant que le jeton propre du compte. Nécessite un accessToken limité à payout:transfer_funds pour les transferts directs et à payout:withdraw_funds pour les listes de destinataires ; la recherche de destinataires d’un compte nécessite en plus company:authorized_user:read et member:basic:read, et les liens de réclamation d’un compte nécessitent airdrop_link:manage — un hôte qui ne dispose pas de l’un de ces scopes doit désactiver la prop correspondante plutôt que de laisser une ligne qui renverra une erreur 403.

CardDetailsElement

Une carte et ce qui a été dépensé avec : la carte elle-même, ses dépenses par rapport à sa limite et ses dernières transactions. S’ouvre dans un tiroir. Le visuel de la carte, la révélation de ses détails et son verrouillage proviennent de l’élément whopCard intégré, de sorte que l’hôte obtient une seule surface au lieu d’en assembler trois. Appuyer sur une transaction, ou demander la liste complète, signale la demande — le tiroir ne navigue jamais.

Cards

Les surfaces de cartes d’un compte, montées depuis un seul endroit : la liste compacte des cartes émises, la liste complète triable, le graphique des dépenses et une carte unique dont on peut révéler les détails. Montez les vues dont la page a besoin — elles partagent le compte et l’identifiant avec lesquels cette unité est créée, de sorte qu’une page affichant un graphique au-dessus d’une liste ne les configure qu’une fois. (sous-contrôleur, 5 éléments)