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 validate() et getValues().Un par
mode. Montez un <AddressElement /> pour chaque valeur de mode sous un même handle Payments. Un second montage avec le même mode est refusé. Le mode d’un élément est défini à sa création ; pour le modifier, détruisez l’élément et créez-en un nouveau.Données d’exemple. Ouvrir le Playground.
Props
L’adresse collectée :
billing (par défaut) ou shipping. Définit aussi la finalité de l’autocomplétion du navigateur. Vous pouvez en monter un de chaque sous un même handle. Les informations de facturation proviennent de l’élément de facturation, ou de l’élément de livraison lorsqu’aucun élément de facturation n’est monté. Par défaut : "billing".La ligne du nom : un seul champ de nom complet (par défaut), des champs prénom/nom séparés, ou aucun. Par défaut :
"combined".Ligne d’adresse 2 : toujours visible (par défaut), révélée par un bouton texte (
toggle), ou jamais collectée. Par défaut : "always".Valeurs initiales appliquées une fois avant le premier affichage (
address.country est un code pays ISO 3166-1 alpha-2). Prévalent sur la détection du pays par IP.full (par défaut) empile des champs avec libellé. compact regroupe des champs dont le libellé sert de placeholder dans une seule bordure. wrap conserve les champs séparés de full et place aussi la ville, l’État et le code postal côte à côte. Ceux-ci, ainsi que les paires que full place déjà côte à côte (prénom et nom, organisation), tiennent autant que possible sur une ligne selon la largeur et passent à la ligne lorsqu’elle se réduit. Par défaut : "full".above (par défaut) garde chaque libellé en dehors de son champ : au-dessus dans la disposition full, comme placeholder dans compact. floating utilise chaque libellé comme placeholder de son champ, dans les deux dispositions, puis affiche un petit libellé au-dessus du texte saisi dès que le champ a une valeur. Par défaut : "above". Depuis v1.5.0.full (par défaut) suit le format d’adresse complet du pays sélectionné. minimal ne collecte que le pays et le code postal. name ajoute indépendamment les champs de nom requis. Définissez name sur none pour les omettre. Cet élément n’ajoute pas les champs requis par un moyen de paiement. La confirmation par carte nécessite un nom, un pays et un code postal, donc gardez name activé ou transmettez billingDetails.name. Par défaut : "full".Champs d’organisation : aucun (par défaut), nom uniquement, ou nom avec un sélecteur entreprise/particulier. Par défaut :
"none".Définit le pays par défaut à partir de l’IP de l’acheteur (résolue avant le premier affichage). Se rabat sur le
countryHint du contrôleur, puis sur US. Par défaut : true.Codes pays ISO 3166-1 alpha-2 autorisés. Avec un seul code, le sélecteur reste visible mais ne propose que ce pays.
Active les suggestions Google Places pour l’adresse postale. Si aucune correspondance n’apparaît ou si Places est bloqué, la liste indique l’absence de correspondance et permet aux acheteurs de saisir l’adresse manuellement. Sur téléphone, les suggestions s’ouvrent en plein écran depuis un bouton de recherche dans le champ de rue plutôt qu’en dessous, où le clavier les masquerait. Définissez
false pour un champ de saisie simple. Par défaut : true.Affiche tous les champs d’adresse dès le départ. Par défaut (
false), le formulaire s’ouvre avec l’adresse postale et révèle le reste une fois que l’acheteur choisit une suggestion, saisit une adresse ou choisit de la saisir manuellement. Par défaut : false. Depuis v1.6.0.Champs supplémentaires affichés avec le formulaire d’adresse. Les valeurs sont validées et émises dans la map
custom distincte.Pays de repli après
defaultValues et la détection par IP. Utilisez un code ISO 3166-1 alpha-2. Une valeur vide se rabat sur US. 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’adresse change. complete vaut true lorsque tous les champs propres au pays et les champs personnalisés requis sont valides. address suit les noms de billing_details du jeton de confirmation, y compris postal_code. country est un code ISO 3166-1 alpha-2. Les valeurs personnalisées se trouvent dans custom.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.validate
Valide le formulaire, révèle toutes les erreurs inline et ne lève jamais d’exception. Renvoie complete, address et errors. errors est vide exactement lorsque complete vaut true. Les clés utilisent les noms du contrat comme postal_code et line1, custom:<key> pour les champs personnalisés, et form de manière transitoire pendant le chargement.Renvoie Promise<object>getValues
Renvoie address et custom sans validation ni affichage des erreurs.Renvoie Promise<object>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 }).
