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 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

boolean
Affiche le menu d’actions de l’en-tête, le bouton Export et le bouton des paramètres du tableau. Par défaut : true.
boolean
Affiche le menu d’actions à trois points sur chaque ligne de paiement. Par défaut : true.
boolean
Affiche les six encadrés de statut de paiement au-dessus des filtres. Par défaut : true.
boolean
Affiche la colonne et le filtre de suivi pour les comptes vendant des produits physiques. Les données de suivi nécessitent shipment:basic:read. Par défaut : true.

Événements

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

onPaymentSelected

Ouvre les détails du paiement dans votre application.
object

onInvoiceRequested

Ouvre la facture dans votre application.
object

onUserSelected

Ouvre l’acheteur dans votre application.
object

onRefundRequested

L’utilisateur a demandé un remboursement. Votre application doit le confirmer et l’autoriser côté serveur. Les contrôles de remboursement ne sont activés que lorsque ce callback est fourni.
object

onSettingsRequested

Ouvre les paramètres de paiement du compte dans votre application.

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

Recharge les paiements après un remboursement ou une autre modification. 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<PaymentsTableElementProps>
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 à <Dashboard>. Définissez-la globalement avec WhopElements({ appearance }).