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 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 refresh().
Vous pouvez monter cet élément inline (create) ou l’ouvrir en overlay modal (createOverlay).

Données d’exemple. Ouvrir le Playground.

Props

string
Un jeton à portée limitée pour la lecture et l’écriture privilégiées — nécessite payout:transfer_funds pour les transferts directs, payout:withdraw_funds pour les listes de destinataires et airdrop_link:manage pour les liens de réclamation. S’il est omis, la lecture transporte la propre session du visiteur, qui ne répond qu’en same-origin.
string
Remplace l’en-tête du sélecteur de destinataire. S’il est omis, l’en-tête est “Choose recipient”.
boolean
Active la recherche de destinataires. Suggère des personnes et des entreprises lorsqu’il y a moins de six destinataires enregistrés, et lance la recherche depuis Add recipient après la saisie. Par défaut : true.
Affiche l’action de lien de réclamation dans le sélecteur de destinataire. À désactiver pour un hôte sans airdrop_link:manage. Par défaut : true.
SendRecipient | null
Ignore le sélecteur et s’ouvre directement sur l’écran du montant pour ce destinataire — pour une rangée d’action “payer cette personne”. Aucun bouton retour n’est alors affiché, puisqu’il n’y a pas de sélecteur derrière. Par défaut : null.
string
Présélectionne une devise dans le sélecteur de l’écran du montant. Se rabat sur currency, puis sur USD. Par défaut : "".

Événements

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

onStepChanged

L’écran visible a changé.
object

onSendCompleted

Un transfert a réussi. Actualisez tout ce qui, de votre côté, lit le solde ou l’activité du compte.
object

onLinkCreated

Un lien de réclamation a été créé. Actualisez tout ce qui, de votre côté, lit le solde du compte.
object

onDone

Le visiteur a cliqué sur “Done” sur un écran de succès — 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.
object

Méthodes

Appelez-les sur le handle renvoyé par create, ou via une ref React.

refresh

Récupère à nouveau les soldes du compte et la liste des destinataires. Appelez-la après toute modification de votre côté de ce qui peut être proposé. 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
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<SendElementProps>
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 }).