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 Checkout. Transmettez les props et les callbacks via les options de création ou les props React.
Exclusif. ExpressCheckoutElement est une alternative à CheckoutElement dans ce handle Checkout. Montez-en un seul à la fois. Détruisez-le avant d’en monter un autre.
Montez-le à l’intérieur de <Checkout>, qui ouvre la session de checkout à partir de votre plan, de vos items ou de votre checkoutConfiguration et garde son identifiant pour lui-même. <Checkout> se monte lui-même à l’intérieur de <WhopElements>. Un seul appui sur le bouton constitue tout l’achat : il n’y a aucun jeton de confirmation à transmettre à votre serveur.

Données d’exemple. Ouvrir le Playground.

Props

object | ("apple_pay" | "google_pay" | "paypal_express")[]
wallets sous forme de tableau est obsolète et sera supprimé dans la prochaine version majeure. Transmettez plutôt { applePay, googlePay, payPal } avec "auto" ou "never".
Les wallets autorisés à s’afficher. Définissez applePay, googlePay ou payPal sur 'never' pour exclure ce bouton ; chaque clé vaut 'auto' par défaut, un filtre sur ce que l’appareil de l’acheteur et le vendeur proposent réellement. L’élément n’affiche jamais un wallet que l’appareil, la matrice fournie ou la configuration des moyens de paiement du checkout ne peut pas prendre en charge, et l’ordre d’affichage reste « meilleur natif en premier », avec PayPal en dernier. Une liste de types de wallets (['apple_pay', 'google_pay']) est encore acceptée comme liste d’autorisation, mais elle est obsolète et sera supprimée dans la prochaine version majeure ; une liste vide n’affiche rien (avec un avertissement dans les builds de développement). Chaque wallet nécessite qu’Apple Pay soit prêt sur le domaine de la page via l’API Domains — les pages first-party whop.com sont pré-approuvées ; sur tout autre site, ajoutez Apple Pay au domaine, sinon les boutons restent masqués. Proposer Google Pay sur votre propre site est soumis aux conditions d’utilisation de l’API Google Pay. Par défaut : {}.
"auto" | "horizontal" | "vertical"
La façon dont les boutons s’empilent. auto suit le conteneur propre à l’élément — empilés dans les conteneurs étroits, côte à côte dans les conteneurs larges ; horizontal et vertical imposent une disposition. Par défaut : "auto".

Événements

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

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.

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<ExpressCheckoutElementProps>
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 à <Checkout>. Définissez-la globalement avec WhopElements({ appearance }).

Props

('apple_pay' | 'google_pay')[]
Les wallets autorisés à s’afficher, sous forme de filtre sur ce que l’appareil propose. L’élément n’affiche jamais un wallet que l’appareil, le compte ou la configuration des moyens de paiement du checkout ne peut pas prendre en charge. Une liste vide n’affiche rien. Par défaut : les deux.
StyleProp<ViewStyle>
Appliqué à la View externe de l’élément. Pour la personnalisation du thème, préférez appearance.parts sur le provider, qui couvre tous les éléments de cette interface. Notez que les noms de parties React Native forment aujourd’hui leur propre ensemble, distinct des noms de classes whop-* du web : un objet appearance web ne peut donc pas être repris tel quel.
ReactNode
Affiché à la place du squelette intégré pendant le chargement de l’élément.
() => void
Se déclenche une fois que l’élément est stabilisé : le bouton est affiché, ou l’élément sait qu’il n’affiche rien. <Checkout> l’attend, donc c’est généralement son propre onLoadingChange qu’il vous faut.
(error: { message: string; code?: string }) => void
Un échec de chargement ou de configuration pour cet élément. L’élément affiche sa propre vue d’erreur dans tous les cas.

États

Une pastille de squelette pendant l’ouverture de la session et pendant que l’appareil indique s’il peut payer, puis le bouton Apple Pay ou Google Pay propre à la plateforme au-dessus de la mention Powered by Whop. Un appareil sans wallet, un wallet désactivé par la configuration des moyens de paiement du checkout, ou un plan épuisé ou archivé n’affiche rien. Un checkout qu’une feuille de paiement ne peut pas honnêtement finaliser (une configuration, une inscription à une liste d’attente, un transfert, une question de formulaire que seule une page peut poser) affiche une vue explicative et signale EXPRESS_CHECKOUT_UNAVAILABLE via onError. Après l’achat, l’élément affiche son résultat : terminé, en cours de traitement, ou un bouton Finish payment ou Try again lorsque le paiement a encore besoin de l’acheteur.

Bon à savoir

  • Un appareil propose un seul wallet : Apple Pay sur iOS, Google Pay sur Android. C’est pourquoi il n’y a pas de prop layout ici : il n’y a jamais de second bouton à disposer.
  • La feuille de paiement collecte ce dont la session a encore besoin : l’e-mail lorsque la session n’en a pas, un numéro de téléphone lorsque le vendeur en collecte un, et une adresse de livraison pour les biens physiques. Un vendeur qui vérifie les numéros de téléphone obtient une étape de code dans une modale native après la fermeture de la feuille.
  • Sur iOS, la feuille recalcule le prix lorsque l’acheteur change de carte, de sorte que les taxes suivent l’adresse de facturation, et propose un champ de code promo lorsque le vendeur autorise les codes. La feuille Android de Google affiche le total du checkout et n’a pas de champ de code.
  • Votre application n’est jamais redirigée. onComplete sur <Checkout> se déclenche une fois lorsque l’achat est confirmé, avec sessionId et receiptId : c’est là que vous faites avancer l’acheteur. Exécutez les commandes à partir des webhooks, pas de ce callback.
  • 3D Secure et les autres étapes externes ouvrent ASWebAuthenticationSession sur iOS et Custom Tabs sur Android, et l’élément interroge le paiement jusqu’à son état final. returnUrl sur <Checkout> doit être une URL https que vous hébergez.
  • Chaque option de <Checkout> est définie à la création. En modifier une après le montage signale CHECKOUT_OPTIONS_FROZEN et conserve la commande d’origine ; donnez une nouvelle key à <Checkout> pour vendre autre chose.
Enveloppez votre application dans <WhopElements getToken={…}> une seule fois, puis montez <Checkout> autour de l’élément. <Checkout> accepte plan, items, checkoutConfiguration, quantity, promoCode, affiliateCode, attribution, metadata et returnUrl, ainsi que onComplete, onError, onLoadingChange et fallback. Consultez Premiers pas et Apparence.