Cette page documente
@whop/elements@1.10.0 et @whop/elements-react@1.10.0.v1.0.0.
Se monte à l’intérieur de Dashboard. 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().
Données d’exemple. Ouvrir le Playground.
Props
Affiche le bouton Refund en haut à droite et le menu d’actions. Les actions de modification nécessitent des gestionnaires d’événements. Par défaut :
true.Affiche le nom, le nom d’utilisateur, l’e-mail, le téléphone et l’adresse de facturation du client lorsque c’est autorisé. Par défaut :
true.Affiche le produit, le plan, le moyen de paiement, les métadonnées du paiement et les identifiants du paiement. Par défaut :
true.Affiche le parcours client. Lit l’API Events limitée au compte uniquement lorsque la section est visible. Par défaut :
true.Événements
Transmettez les callbacks dans les options de création ou dans les props React.onRefundRequested
Confirmez et autorisez un remboursement dans votre application. Activé uniquement lorsque le paiement est remboursable et qu’un gestionnaire est fourni.
onRetryRequested
Confirmez et autorisez une nouvelle tentative de débit dans votre application.
onVoidRequested
Confirmez et autorisez l’annulation de ce paiement dans votre application.
onInvoiceRequested
Affichez ou téléchargez la facture dans votre application.
onCustomerSelected
Ouvre le client dans votre application.
onMessageRequested
Ouvre votre interface de messagerie client.
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.
refresh
Recharge le paiement et ses frais une fois qu’une action de l’hôte est terminée.
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 à <Dashboard>. Définissez-la globalement avec WhopElements({ appearance }).
