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 Payments. Transmettez les props et les callbacks via les options de création ou les props React.
Se monte à l’intérieur d’un scope WhopPayments. Collecte l’e-mail de l’acheteur, que chaque jeton de confirmation exige, et le contrôleur le lit pour générer le jeton, que vous le liiez ou non.
Montez-le à l’intérieur de <Payments>, qui gère le débit et le jeton de confirmation. <Payments> se monte lui-même à l’intérieur de <WhopElements>. Il collecte l’e-mail de l’acheteur et le publie auprès du provider, de sorte que createConfirmationToken l’envoie sans qu’on ait à lui transmettre quoi que ce soit.

Données d’exemple. Ouvrir le Playground.

Props

boolean
Affiche le libellé localisé. Définissez false si vous fournissez le vôtre. Le champ conserve un aria-label localisé. Par défaut : true.
string
Texte du placeholder du champ e-mail. Vide (par défaut), il affiche you@example.com. Avec les libellés flottants, c’est le texte du libellé qui sert de placeholder. Par défaut : "".
"above" | "floating"
above (par défaut) affiche le libellé au-dessus du champ. floating utilise le texte du libellé comme placeholder, puis affiche un petit libellé au-dessus du texte saisi dès que le champ a une valeur. Ignoré lorsque label vaut false. Par défaut : "above". Depuis v1.5.0.
string
Valeur initiale appliquée une fois au montage. Par défaut : "".

Événements

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

onChange

Se déclenche lorsque l’e-mail change. complete vaut true lorsque l’adresse est plausible. La connexion le déclenche avec l’e-mail connecté, qui alimente aussi createConfirmationToken().
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.

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

Paramètres

Binding<String>?
Relit la valeur. Le contrôleur la collecte dans tous les cas.
Bool
Définissez false si vous fournissez votre propre libellé ; le champ conserve son libellé d’accessibilité. Par défaut : true.
String?
Vide, il affiche you@example.com.

États

S’affiche immédiatement. Une adresse non plausible affiche son erreur dès que le champ perd le focus, puis en direct.

Bon à savoir

  • Sans lui, transmettez vous-même billingDetails.email à createConfirmationToken. La génération refuse un jeton sans e-mail.
  • Un billingDetails.email explicite au moment de la génération prévaut sur ce que cet élément a collecté.
  • Une adresse plausible est vérifiée auprès de l’annuaire des comptes, avec un debounce puis à nouveau à la perte du focus. Une adresse reconnue propose une connexion, et l’élément présente lui-même la feuille de saisie du code à six chiffres.
  • Une connexion vérifiée débloque les moyens de paiement enregistrés de l’acheteur dans WhopPaymentElement. Lisez payments.buyer pour savoir de qui il s’agit, et utilisez payments.signOut() pour l’oublier.
  • Le jeton à portée limitée dure une heure et ne se renouvelle pas. Lorsqu’il expire, la liste des moyens enregistrés revient vide et l’acheteur paie avec un nouveau moyen, le même parcours qu’un invité.

Installation

Montez-le à l’intérieur d’un scope WhopPayments(accountID:charge:), qui crée le contrôleur et le transmet à son contenu. payments.buyer est l’acheteur connecté dès qu’une connexion par e-mail en a authentifié un. WhopBrandingElement doit aussi être à l’écran, car Whop est le marchand officiel (merchant of record) de ces ventes et createConfirmationToken refuse sans lui. Stylisez avec .whopElementsAppearance(_:). Le module est Elements, et non WhopElements du SDK wallet. Consultez Premiers pas et Apparence.

Props

string
Valeur initiale appliquée une fois au montage.
boolean
Affiche le libellé localisé. Par défaut : true.
string
Vide, il affiche you@example.com.
(payload: EmailChangePayload) => void
Se déclenche à chaque modification.
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 interactif. <Payments> les regroupe, 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.

EmailChangePayload

Ce que renvoie onChange :
  • email: string : la valeur actuelle
  • complete: boolean : l’adresse est analysable

États

S’affiche immédiatement. onChange signale complete dès que l’adresse est analysable, et l’élément affiche son propre message de validation à la perte du focus.

Bon à savoir

  • L’e-mail publié est celui que le jeton de confirmation porte comme billing_details.email. Transmettre billingDetails.email à createConfirmationToken le remplace.
  • Définissez label={false} lorsque votre formulaire fournit son propre libellé. Le champ conserve son libellé d’accessibilité dans tous les cas.
Enveloppez votre application dans <WhopElements getToken={…}> une seule fois, puis montez <Payments> autour des éléments. Consultez Premiers pas et Apparence.