Les interfaces du tableau de bord propres à un compte, intégrées à votre site. Limitez-le à un compte avec accountId, puis montez paymentsTable pour les paiements du compte, paymentDetail pour un paiement, required-actions pour les bannières d’actions en attente que le propre tableau de bord de Whop affiche au-dessus du solde — vérification d’identité, dépôts, taxes et le reste — et verification pour le rappel limité à l’identité. Chaque interface lit avec le même identifiant, donc deux interfaces côte à côte affichent toujours le même compte. Les bannières n’affichent rien une fois que le compte n’a plus rien en attente, elles peuvent donc rester en permanence dans une mise en page, et elles signalent les appuis auxquels elles ne peuvent pas répondre elles-mêmes — Add money et Verify — pour que l’hôte monte son propre flux de dépôt ou de vérification, comme l’élément deposit du contrôleur wallet ou l’élément kyc du contrôleur verifications.
Cette page documente @whop/elements@1.10.0 et @whop/elements-react@1.10.0.
Depuis v1.0.0.
Playground
Assemblez les éléments avec des données d’exemple. Manipulez les contrôles, ajoutez et organisez des éléments, et observez les événements se déclencher en direct :
import { WhopElements, Dashboard } from "@whop/elements-react";import { loadWhop } from "@whop/elements";function Example() { return ( <WhopElements elements={loadWhop()}> <Dashboard /* options */> {/* mount elements here */} </Dashboard> </WhopElements> );}
Transmettez-les à whop.dashboard.create({ … }), ou comme props sur <Dashboard> avec React.
string
Un jeton à portée limitée avec lequel lit chaque interface de ce handle. Générez un seul jeton pour tout le handle sur votre serveur avec POST /api/v1/access_tokens, et définissez-en un nouveau avec update({ accessToken }) avant son expiration. La lecture des paiements nécessite payment:basic:read ; les e-mails des acheteurs nécessitent en plus member:email:read, le parcours client member:basic:read, la colonne de suivi shipment:basic:read, et les noms de produit et de plan d’un paiement access_pass:basic:read et plan:basic:read. Les bannières nécessitent payout:account:read, et le démarrage de la vérification depuis la barre d’actions identity:write. S’il est omis, les lectures utilisent la propre session de l’utilisateur, qui ne répond qu’en same-origin.
string
requis
ID du compte ou de l’utilisateur dont ces interfaces lisent les enregistrements. Les ID de compte sont préfixés par biz_ ; les ID d’utilisateur sont préfixés par user_, ne peuvent lire que les propres actions en attente de l’utilisateur et n’ont pas de paiements.
Appearance
Personnalisation visuelle des éléments de ce groupe. Remplace le WhopElements({ appearance }) global. Modifiez-la en direct avec update({ appearance }).
WhopElementsLocale
Langue du texte de l’interface des éléments de ce groupe. Définissez-la sur l’une des langues intégrées à l’application pour remplacer la configuration globale. Toute autre valeur revient à la langue par défaut.
Événements
Transmettez les callbacks dans les options de création ou dans les props React.
onLoadingChange
S’exécute lorsque l’état de chargement groupé change. La valeur est true tant qu’un élément monté est encore en cours de chargement.
boolean
Méthodes
Appelez-les sur le handle Dashboard obtenu via whop.dashboard.create({ … }) ou useDashboard().
update
Fusionne de nouvelles options de handle dans chaque élément monté. Avec React, modifiez plutôt les props du namespace.Paramètres
Partial<DashboardOptions>
requis
destroy
Détruit chaque élément et sous-contrôleur créé par ce handle, supprime le frame du contrôleur et libère ses abonnements. Vous pouvez l’appeler plusieurs fois, mais un handle détruit refuse tout autre appel — créez un nouveau handle pour recommencer. React supprime le groupe automatiquement lorsque le provider est démonté.
Éléments
Les éléments montés par ce groupe. Chacun a sa propre page :
RequiredActionsElement
Les bannières d’actions en attente du tableau de bord de solde de Whop — vérification d’identité, dépôts, taxes et le reste — dans l’ordre dans lequel l’API les renvoie. Un compte sans action en attente n’affiche rien du tout, donc l’élément peut rester en permanence dans une mise en page. Les textes proviennent de l’API. Appuyer sur Verify démarre une session d’identité hébergée et y redirige ; Add money signale depositRequested et reste sur place, pour que l’hôte monte son propre flux de dépôt — l’élément deposit du contrôleur wallet, par exemple ; tous les autres boutons suivent le lien propre à l’action. Lit avec l’accessToken du handle Dashboard, qui nécessite payout:account:read, plus identity:write pour démarrer la vérification. Une lecture en échec n’affiche rien plutôt qu’une erreur — une bannière ne devrait jamais devenir l’élément le plus voyant de la page de quelqu’un d’autre.
VerificationElement
Une bannière invitant le titulaire du compte à vérifier son identité, affichée uniquement tant que la vérification est en attente — un compte déjà vérifié n’affiche rien du tout, donc l’élément peut rester en permanence dans une mise en page. Le titre et les messages d’état proviennent de l’API, avec une description plus courte lorsqu’il s’agit d’inviter le titulaire du compte à démarrer la vérification, de sorte qu’ils suivent l’état réel du compte : un compte non commencé est invité à débloquer les cartes et les versements, un compte en cours d’examen apparaît comme en attente, et un compte en échec ou signalé l’indique. Appuyer sur le bouton signale verificationRequested et reste sur place, pour que l’hôte monte sa propre vérification — l’élément kyc du contrôleur verifications, par exemple. Lit avec l’accessToken du handle Dashboard, qui nécessite payout:account:read. Une lecture en échec n’affiche rien plutôt qu’une erreur — un rappel ne devrait jamais devenir l’élément le plus voyant de la page.
PaymentsTableElement
Le tableau des paiements du tableau de bord avec cartes de statut, recherche, filtres, tri, sélection de lignes, export CSV, paramètres des colonnes et pagination. Lit toutes les pages de paiements pour calculer des décomptes complets et filtrer localement ; destiné aux comptes ayant un historique de paiements modeste. Les détails des clients et les remboursements sont transmis à votre application via des événements.
PaymentDetailElement
Une page de détail de paiement avec la ventilation du tableau de bord, l’activité, le client, les détails et le parcours client. Chaque section peut être masquée. Lit payment:basic:read ; l’e-mail du client nécessite member:email:read et le parcours nécessite member:basic:read. Les événements d’action permettent à votre application de confirmer et d’autoriser les modifications ; cet élément ne rembourse, ne relance ni n’annule jamais un paiement lui-même.
Assistant
Responses are generated using AI and may contain mistakes.