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

"individual" | "business"
La vérification que démarre le bouton. individual (KYC) débloque les versements et une carte Whop. business (KYB) couvre cela et débloque en plus le financement et les cartes professionnelles — utilisez-le pour une entreprise qui en aura besoin. Par défaut : "individual".
boolean
Affiche une invite inline compacte sans la description d’accompagnement. Par défaut : false.

Événements

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

onVerificationRequested

L’utilisateur a appuyé sur le bouton de vérification. L’élément ne navigue jamais — montez votre propre vérification en réponse, comme le contrôleur verifications.
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

Relit le compte. Appelez-la lorsque l’utilisateur revient de la vérification, pour que la bannière reflète le nouvel état sans attendre l’expiration du cache. 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<VerificationElementProps>
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 }).