@whop/elements@1.10.0 et @whop/elements-react@1.10.0.v1.0.0.
Se monte à l’intérieur de Wallet. accountId et accessToken proviennent de celui-ci. Transmettez les props et les callbacks via les options de création ou les props React. Conservez le handle créé, ou la ref React, pour appeler showStep() et refresh().
create) ou l’ouvrir en overlay modal (createOverlay).Données d’exemple. Ouvrir le Playground.
Props
user_) — nécessite payout:account:read, ainsi que payout:account:update pour provisionner le canal bancaire. Générez-le sur votre serveur avec POST /api/v1/access_tokens. S’il est omis, l’appel transporte la propre session du visiteur, qui ne répond qu’en same-origin ; les comptes professionnels se résolvent sans aucun identifiant."".true.cardDepositRequested avec le montant — l’élément ne collecte jamais de paiement par carte. Par défaut : [].addCardRequested afin que vous puissiez ouvrir votre propre parcours de saisie de carte. Par défaut : false.platformBalanceSelected, sans étape de montant. Par défaut : false.percentageFee est exprimé en POINTS de pourcentage (2.9 correspond à 2,9 %) ; fixedFee et radarFee sont en unités principales (0.3 correspond à 0,30 $). Par défaut : null.bank, crypto). Les canaux omis utilisent les frais renvoyés par le compte. percentageFee est exprimé en POINTS de pourcentage (1.5 correspond à 1,5 %) ; fixedFeeUsd est en unités principales USD (2 correspond à 2,00 $), quelle que soit la devise du dépôt. Affiche le taux avant la saisie d’un montant, puis le montant facturé ensuite. Par défaut : {}.bank, crypto, platform_balance ou l’id d’une carte enregistrée). Continue reste désactivé tant que ce canal n’est pas encore proposé, plutôt que d’approvisionner via un autre. Par défaut : "".bankSelected et reste sur l’écran du montant au lieu d’afficher les coordonnées de virement — pour les hôtes qui exécutent leur propre étape lorsque le compte dispose déjà d’un compte bancaire virtuel. Par défaut : false.depositConfirmed, afin que vous puissiez commencer à surveiller le transfert. Par défaut : false.crypto et bank ne nécessitent pas de montant ; leur bouton retour émet dismissed, car il n’y a pas de sélecteur derrière eux. Par défaut : "amount".Événements
Transmettez les callbacks dans les options de création ou dans les props React.onDepositInitiated
Le payeur a confirmé un montant et un canal. Se déclenche pour chaque canal, avant l’affichage de toute instruction — le point d’accroche pour l’analytique et le suivi du tunnel.
onCardDepositRequested
Une carte enregistrée a été choisie. Collectez le paiement de votre côté, puis appelez showStep({ step: "amount" }) pour ramener l’élément au sélecteur.
onAddCardRequested
La ligne “Add card” a été choisie — ouvrez votre parcours de saisie de carte.
onBankSelected
Le canal bancaire a été choisi alors que deferBankToHost est défini — exécutez votre étape, puis affichez vous-même les coordonnées ou appelez showStep({ step: "bank" }).
onIdentityVerificationRequested
Le visiteur a choisi le virement bancaire alors que ce compte n’a pas encore de compte bancaire virtuel. L’élément reste sur l’écran du montant et ne navigue jamais — montez en réponse votre propre vérification, comme le contrôleur verifications.
onPlatformBalanceSelected
La ligne du solde de la plateforme a été choisie. Elle ne transporte aucun montant — c’est votre propre écran qui le collecte.
onDepositConfirmed
Le payeur a indiqué avoir envoyé la crypto. since est un plancher en secondes unix à partir duquel commencer à rapprocher les transferts entrants (il remonte légèrement dans le temps, de sorte qu’un transfert envoyé quelques instants avant le clic est tout de même rapproché).
onStepChanged
L’écran visible a changé.
onDismissed
Le payeur a quitté un canal sur lequel l’élément avait été ouvert directement — fermez la surface qui le contient.
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.
showStep
Amène l’élément sur un écran. { step: "amount" } vous permet de rendre la main après avoir réglé de votre côté un dépôt par carte ou par solde de la plateforme.
Paramètres
Renvoie Promise<void>
refresh
Résout à nouveau les canaux d’approvisionnement du compte. Appelez-la après toute modification de votre côté de ce que le compte peut proposer — la fin de l’onboarding bancaire, par exemple — afin que le nouveau canal apparaisse sans attendre l’expiration du cache.
Renvoie Promise<void>
mount
Monte l’élément dans target et démarre le chargement. Les composants React se montent eux-mêmes.
Paramètres
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
Style
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 }).
