Cette page documente
@whop/elements@1.10.0 et @whop/elements-react@1.10.0.v1.0.0.
Se monte à l’intérieur de
Payments. 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 select().Exclusif.
PaymentElement est une alternative à CardElement ou CardFields dans ce handle Payments. Montez-en un seul à la fois. Détruisez-le avant d’en monter un autre.Attend
BrandingElement. Cet élément reste dans son état de chargement jusqu’à ce que BrandingElement soit monté dans le même handle Payments.Données d’exemple. Ouvrir le Playground.
Props
Contrôle l’ordre d’affichage dans les deux dispositions. Les types listés apparaissent en premier, dans l’ordre. Les types non listés conservent leur ordre relatif. N’affecte pas la disponibilité. Par défaut :
[].Contrôle les wallets proposés par l’élément. Chaque clé vaut par défaut
'auto', qui propose le wallet partout où le compte, l’appareil de l’acheteur et le débit le prennent en charge. 'never' retire ce wallet de la liste des moyens. Utilisez-le lorsque votre page affiche ses propres boutons Apple Pay, Google Pay ou PayPal avec paymentRequest, afin que les acheteurs ne voient chaque wallet qu’une fois. payPal: 'never' retire le moyen PayPal. Les moyens de paiement enregistrés ne sont pas concernés. Par défaut : {}. Depuis v1.8.0.Contrôle la collecte des informations de facturation.
billingDetails: 'minimal' (par défaut) suit la matrice de chaque moyen. Par défaut, les moyens collectent le nom et le format complet du pays. Une surcharge peut ne collecter que le minimum déclaré, ou rien du tout. Pour les cartes, le minimum est le nom sur la carte, le pays et le code postal. 'full' exige le nom et le format complet du pays pour chaque nouveau moyen. 'never' masque le bloc. address: 'minimal' ne collecte que le minimum déclaré de chaque moyen, plus un pays lorsque ce minimum n’en comporte pas (et aussi le code postal lorsque billingDetails: 'full' indique que le checkout est soumis à taxe), sauf pour les wallets, la crypto, les prélèvements bancaires, les virements bancaires, les paiements par carte en présentiel et les achats intégrés, qui ne collectent aucune adresse, et sauf pour un moyen dont le prestataire exige l’adresse de facturation complète (requires_full_billing_address), dont la tuile suit les mêmes règles qu’un checkout sans indicateur ; dans les autres cas, il l’emporte sur billingDetails: 'full' ; utilisez-le lorsque le vendeur ne collecte pas d’adresse de facturation complète. phone: 'never' masque uniquement le champ de téléphone de facturation lorsque votre formulaire le collecte déjà ; transmettez billingDetails.phone à createConfirmationToken pour les moyens qui l’exigent. Transmettez plutôt l’adresse à createConfirmationToken. Le sélecteur de pays n’inclut que les pays pris en charge par le moyen et la devise de paiement. Lorsqu’un plan de paiement échelonné est sélectionné, il se limite aux pays desservis par ce plan — le pays de facturation est le pays de transaction sous lequel le débit est traité. Il se verrouille lorsqu’un seul pays est disponible. Par défaut : {"billingDetails":"minimal"}.Préremplit les informations de facturation lors du premier affichage du bloc de facturation de chaque moyen. L’acheteur peut modifier chaque champ prérempli.
address.country est un code ISO 3166-1 alpha-2 et ne s’applique que lorsque le moyen sélectionné l’accepte. phone remplit le champ de téléphone de facturation pour les moyens qui en collectent un, au format E.164 comme +14155552671 ; un numéro hors des pays de téléphone pris en charge par le moyen est ignoré. Seuls les champs affichés par le bloc sont préremplis et envoyés. Transmettez tout le reste à createConfirmationToken dans billingDetails. Depuis v1.1.0.Disposition du sélecteur.
accordion (par défaut) empile les moyens et déplie les détails inline. horizontal affiche des tuiles de largeur égale, sans défilement, avec les détails du moyen sélectionné en dessous. Au-delà de quatre moyens, une tuile More ouvre un sélecteur natif. Le moyen choisi à cet endroit occupe la dernière tuile jusqu’à la sélection suivante. La sélection et la confirmation se comportent de la même manière. Par défaut : "accordion".accordion uniquement. Ajoute de l’espacement et un style de carte distinct entre les moyens. Ignoré lorsque layout vaut horizontal. Par défaut : false.Indique s’il faut sélectionner le premier moyen proposé après la résolution. La valeur par défaut
true respecte order et émet selected et change comme une interaction de l’acheteur. Elle s’exécute une seule fois avant toute interaction de l’acheteur et ne fait rien lorsqu’aucun moyen n’est proposé. Définissez false pour monter l’élément sans sélection. Indépendamment, si une mise à jour retire le moyen sélectionné, la sélection revient au premier moyen proposé. Un élément déjà sans sélection le reste. Par défaut : true.Événements
Transmettez les callbacks dans les options de création ou dans les props React.onChange
Se déclenche lorsque la sélection change. complete: true signifie que l’acheteur a sélectionné un moyen et rempli ses champs de carte ou ses champs obligatoires. Utilisez-le pour activer la confirmation. paymentMethod est le moyen de paiement sélectionné, enregistré ou nouveau, ou null tant que rien n’est sélectionné : displayName et icons nomment le choix tel que l’élément l’affiche (avec balance.imageUrl, l’image du propriétaire d’un solde), card contient le réseau d’une carte, ses quatre derniers chiffres et son type de financement, requiresBillingPhone indique si le moyen nécessite un téléphone dans les informations de facturation, et countries liste les pays depuis lesquels le moyen peut payer dans la devise du débit. type, requiresBillingPhone et method au niveau supérieur sont dépréciés : lisez-les depuis paymentMethod. supportsBuyerFee au niveau supérieur est également déprécié, sans remplacement : Whop fixe lui-même le prix de ses frais de service acheteur.onAddressChange
Se déclenche environ 300 ms après la modification de l’adresse de facturation interne. Utilisez-le pour les taxes, la livraison ou d’autres mises à jour dépendant de l’adresse. country est un code ISO 3166-1 alpha-2. Le payload omet les autres clés d’adresse lorsqu’elles sont vides ou inutilisées pour ce pays. complete: true signifie que le bloc de facturation est valide et complet. Cet événement ne se déclenche que tant que l’élément de paiement gère la collecte de l’adresse. Avec fields.billingDetails: 'never', utilisez votre propre source d’adresse. Avec un AddressElement monté, utilisez son événement change.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.select
Sélectionne un moyen par le même chemin qu’une interaction de l’acheteur. Par exemple, select('cashapp') déplie la tuile et émet selected et change. Les cartes restent à complete: false tant que leurs champs ne sont pas remplis. Les moyens inconnus, indisponibles ou soumis à une condition de montant sont rejetés avec le code METHOD_NOT_OFFERED. select(null) efface la sélection et émet change avec complete: false. À utiliser avec autoSelect={false} pour un contrôle externe complet.ParamètresRenvoie Promise<void>mount
Monte l’élément dans target et démarre le chargement. Les composants React se montent eux-mêmes.Paramètresdestroy
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ètresStyle
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 à <Payments>. Définissez-la globalement avec WhopElements({ appearance }).
