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 accessToken proviennent de Wallet. 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().

Données d’exemple. Ouvrir le Playground.

Props

boolean
Désactivé, l’élément n’effectue aucune lecture et affiche un solde nul. Par défaut : true.
boolean
Affiche les montants dans l’avoir sélectionné. Désactivez cette option pour valoriser la même répartition du solde en USD. Par défaut : true.
boolean
Affiche le titre de la devise et le total au-dessus des lignes. Désactivez cette option lorsque la surface environnante les affiche déjà. Par défaut : true.
boolean
Dessine la marge intérieure de la page autour de l’élément. Désactivez cette option lorsque la surface environnante la fournit déjà. Par défaut : true.

Événements

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

onBreakdownSelected

Une ligne de solde ou le segment de barre correspondant a été cliqué. L’hôte peut ouvrir les détails pour available, pending, reserve ou debt.
object

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 le solde après un mouvement d’argent effectué par l’hôte. 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<BreakdownElementProps>
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 }).