Skip to main content
Cette page documente @whop/elements@1.10.0 et @whop/elements-react@1.10.0.
Depuis v1.0.0. S’ouvre dans une modale depuis Balances, dans Wallet : wallet.create('balances').createOverlay('settlement'). Transmettez les props et les callbacks dans les options de création.
Cet élément est uniquement modal. Ouvrez-le avec createOverlay ; il n’a pas de montage inline.

Données d’exemple. Ouvrir le Playground.

Props

boolean
Désactivé, l’Element n’effectue aucune lecture et affiche un état de détails vide. Par défaut : true.
boolean
Affiche les montants dans l’avoir sélectionné. Désactivez cette option pour valoriser les détails en USD. Par défaut : true.

Événements

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

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 détails de règlement et de réserve. 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<SettlementElementProps>
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 }).