Skip to main content
Denne side dokumenterer @whop/elements@1.10.0 og @whop/elements-react@1.10.0.
Siden v1.0.0.
Monteres inde i Payments. Angiv props og callbacks via create-indstillingerne eller som React-props. Behold det oprettede handle eller React-ref for at kalde validate() og getValues().
Én pr. mode. Montér ét <AddressElement /> for hver mode-værdi under ét Payments-handle. En anden montering med samme mode afvises. Et elements mode angives, når du opretter det; for at ændre den skal du ødelægge elementet og oprette et nyt.
Monteres inde i et WhopPayments-scope. Indsamler faktureringsadressen i det valgte lands eget format, og controlleren læser den til udstedelsen, uanset om du binder den eller ej.
Montér inde i <Payments>, som ejer opkrævningen og bekræftelsestokenet. <Payments> monteres selv inde i <WhopElements>. Det renderer faktureringsadressen i køberens eget landeformat og publicerer den til provideren, så createConfirmationToken henter den uden at få noget angivet.

Eksempeldata. Åbn Playground.

Props

"billing" | "shipping"
Hvilken adresse dette indsamler: billing (standard) eller shipping. Angiver også formålet med browserens autocomplete. Du kan montere én af hver under ét handle. Faktureringsoplysninger kommer fra faktureringselementet eller fra leveringselementet, når der ikke er monteret et faktureringselement. Standard er "billing".
"split" | "none" | "combined"
Navnerækken: ét felt til fulde navn (standard), opdelte felter til fornavn/efternavn eller ingen. Standard er "combined".
"never" | "toggle" | "always"
Adresselinje 2: altid synlig (standard), vist via en tekstknap (toggle) eller aldrig indsamlet. Standard er "always".
object
Startværdier, der anvendes én gang før første rendering (address.country er en ISO 3166-1 alpha-2-landekode). Har forrang for registrering af land via IP.
"full" | "compact" | "wrap"
full (standard) stabler felter med etiketter. compact grupperer felter med pladsholderetiketter inden for én ramme. wrap beholder fulls separate felter og placerer desuden by, stat og postnummer side om side. Disse og de par, som full allerede placerer side om side (fornavn og efternavn, organisation), fylder så mange pr. række, som bredden tillader, og ombrydes, når den bliver smallere. Standard er "full".
"above" | "floating"
above (standard) holder hver etiket uden for sit felt: over det i full-layoutet, som pladsholder i compact. floating bruger hver etiket som pladsholder for sit felt i begge layouts og viser derefter en lille etiket over den indtastede tekst, når feltet har en værdi. Standard er "above". Siden v1.5.0.
"minimal" | "full"
full (standard) følger det valgte lands fulde adresseformat. minimal indsamler kun land og postnummer. name tilføjer uafhængigt påkrævede navnefelter. Sæt name til none for at udelade dem. Dette element tilføjer ikke felter, som en betalingsmetode kræver. Kortbekræftelse kræver et navn, et land og et postnummer, så behold name aktiveret, eller angiv billingDetails.name. Standard er "full".
"none" | "name" | "name_with_type"
Organisationsfelter: ingen (standard), kun navn eller navn med en vælger for virksomhed/privatperson. Standard er "none".
boolean
Sæt landet som standard ud fra køberens IP (afgjort før første rendering). Falder tilbage til controllerens countryHint og derefter US. Standard er true.
string[]
Tilladte ISO 3166-1 alpha-2-landekoder. Med én kode forbliver vælgeren synlig, men tilbyder kun det land.
boolean
Aktiverer Google Places-forslag til gadeadressen. Hvis der ikke vises noget match, eller Places er blokeret, rapporterer listen ingen match og lader køberne indtaste adressen manuelt. På en telefon åbner forslagene i fuld skærm fra en søgeknap i gadefeltet i stedet for under det, hvor tastaturet ville dække dem. Sæt false for et almindeligt input. Standard er true.
boolean
Viser alle adressefelter fra starten. Som standard (false) åbner formularen med gadeadressen og viser resten, når køberen vælger et forslag, indtaster en adresse eller vælger at indtaste den manuelt. Standard er false. Siden v1.6.0.
object[]
Ekstra felter, der renderes sammen med adresseformularen. Værdierne valideres og udsendes i det separate custom-map.
string
Fallback-land efter defaultValues og registrering via IP. Brug en ISO 3166-1 alpha-2-kode. En tom værdi falder tilbage til US. Standard er "".

Events

Angiv callbacks i create-indstillingerne eller som React-props.

onChange

Udløses, når adressen ændres. complete er true, når alle landespecifikke felter og påkrævede brugerdefinerede felter er gyldige. address følger navnene i bekræftelsestokenets billing_details, inklusive postal_code. country er en ISO 3166-1 alpha-2-kode. Brugerdefinerede værdier ligger i custom.
object

onLoaderStart

Kører, efter at indlæsningsskelettet først er tegnet, og før onReady.

onReady

Kører efter elementets første fuldstændige rendering.

onError

Kører, når elementet ikke kan indlæses eller går ned. Fallback-visningen forbliver synlig. Brug code til programmatisk håndtering. sourceKey identificerer en host-state-kilde, der fejlede.
object

Metoder

Kald disse på det handle, som create returnerer, eller via en React-ref.

validate

Validerer formularen, viser alle inline-fejl og kaster aldrig. Returnerer complete, address og errors. errors er tom, præcis når complete er true. Nøglerne bruger kontraktnavne som postal_code og line1, custom:<key> for brugerdefinerede felter og den midlertidige form under indlæsning.Returnerer Promise<object>
boolean
påkrævet
object
påkrævet
Record<string, string>
påkrævet

getValues

Returnerer address og custom uden validering og uden at vise fejl.Returnerer Promise<object>
object
påkrævet
Record<string, string>
påkrævet

mount

Monterer elementet i target og begynder indlæsningen. React-komponenter monterer sig selv.Parametre
string | HTMLElement
påkrævet

destroy

Fjerner elementet og frigiver dets frame og abonnementer. Du kan kalde den mere end én gang. React fjerner elementet automatisk.

update

Fletter nye props ind i det monterede element. I React ændrer du i stedet komponentens props.Parametre
Partial<AddressElementProps>
påkrævet

Styling

Style disse dele via appearance.classes. Brug camel case eller kebab case til egenskabsnavne, og medtag enheder. Sidens stylesheets kan ikke nå elementets frame. Frameworket validerer hver deklaration, før den indsættes.
I React angiver du appearance til <Payments>. Sæt den globalt med WhopElements({ appearance }).

Parametre

Binding<PostalAddress>?
Læser den indsamlede adresse ud igen. Controlleren indsamler den under alle omstændigheder.
Binding<Bool>?
True, når alle felter, som landet kræver, er udfyldt og gyldige.
WhopAddressElement.Mode
.billing eller .shipping. Shipping beder tastaturet om leveringsfelter. Standard er .billing.
WhopAddressElement.Layout
.full giver hvert felt en etiket og stabler dem; .compact flytter etiketterne ind i pladsholdere. Standard er .full.
WhopAddressElement.Scope
.full indsamler landets fulde format; .minimal indsamler kun land og postnummer. Standard er .full.
WhopAddressElement.NameFields
.combined for ét felt til fulde navn, .split for fornavn og efternavn, .none for at udelade navnet. Standard er .combined.
WhopAddressElement.OrganizationFields
.none, .name for et organisationsnavn eller .nameWithType for også at spørge, om det er en virksomhed eller en privatperson. Standard er .none.
WhopAddressElement.Line2Field
.always viser den anden linje, .toggle viser den via en knap, .never udelader den. Standard er .toggle.
PostalAddress?
Værdier at starte fra. Dens country er en ISO 3166-1 alpha-2-kode og har forrang for registrering.
Bool
Starter på køberens eget land, når true. Falder tilbage til countryHint, derefter opkrævningsvalutaens land og derefter US. Standard er true.
[String]?
Begrænser vælgeren til disse ISO 3166-1 alpha-2-koder, krydset med den valgte metodes egen begrænsning.
String?
ISO 3166-1 alpha-2-fallback for landekæden.
Bool
Gadeforslag, mens køberen skriver. Når det er slået fra, er der intet at vælge, så alle felter vises fra starten. Standard er true.

PostalAddress

Det, et valg returnerer:
  • country: String: ISO 3166-1 alpha-2, med store bogstaver
  • line1 / line2 / city / state / postalCode: String?, i landets eget format
  • name / firstName / lastName: String?, afhængigt af name-tilstanden
  • organization / organizationType: String?, afhængigt af organization-tilstanden

Tilstande

Formularen renderes med det samme. Med autocomplete slået til ved .full-scope vises lokalitetsfelterne efter et forslag eller en manuel indtastning; slå det fra, så vises alle felter på én gang. Fejl vises ved det første bekræftelsesforsøg og derefter live.

Godt at vide

  • MapKit leverer gadeforslagene på enheden. Whop ser aldrig køberens forespørgsel, mens de skriver.
  • defaultValues.country slår registrering. Registrering falder tilbage til countryHint, derefter opkrævningsvalutaens land og derefter US.
  • allowedCountries krydses med den valgte metodes egen begrænsning af faktureringsland, så en metode, der kun tager ét land, selv indsnævrer vælgeren.
  • PostalAddress bruger bekræftelsestokenets billing_details-nøgler, så den samme JSON fungerer på tværs af platforme.

Installation

Montér det inde i et WhopPayments(accountID:charge:)-scope, som opretter controlleren og giver den videre til sit indhold. payments.buyer er den indloggede køber, når en e-mail-login har bekræftet en. WhopBrandingElement skal også være på skærmen, fordi Whop er merchant of record på disse salg, og createConfirmationToken afviser uden det. Style med .whopElementsAppearance(_:). Modulet er Elements, ikke wallet-SDK’ets WhopElements. Se Kom godt i gang og Appearance.

Props

'billing' | 'shipping'
Formål med autocomplete. Standard er billing.
'full' | 'compact'
full giver hvert felt en etiket og stabler dem. compact flytter etiketterne ind i pladsholdere. Standard er full.
'full' | 'minimal'
full følger landets fulde format. minimal indsamler kun land og postnummer. Standard er full.
'combined' | 'split' | 'none'
Ét felt til fulde navn, fornavn og efternavn eller intet navnefelt. Standard er combined.
'none' | 'name' | 'name_with_type'
Om der skal indsamles en organisation, og om der også skal spørges, om det er en virksomhed eller en privatperson. Standard er none.
'toggle' | 'always' | 'never'
Hvordan den anden adresselinje vises. Standard er toggle, som viser en “Add address line 2”-knap.
string[]
Begræns landevælgeren til disse ISO 3166-1 alpha-2-koder. En valgt betalingsmetodes egen landeliste indsnævrer dette yderligere, men udvider det aldrig.
boolean
Sæt landet som standard ud fra køberens IP.
string
Fallback-land efter defaultValues og registrering via IP. ISO 3166-1 alpha-2.
{ name?: string; address?: Partial<EmittedAddress> }
Startværdier, der anvendes én gang ved montering, for en genoptaget session.
CustomFieldSpec[]
Ekstra felter, der renderes på en angivet position (after_name, after_organization, before_country, after_address). Et påkrævet felt er en betingelse for complete.
(payload: AddressChangePayload) => void
Udløses ved hver redigering med det aktuelle øjebliksbillede.
StyleProp<ViewStyle>
Anvendes på elementets ydre View. Til temaer bør du foretrække appearance.parts på provideren, som dækker alle elementer på denne flade. Bemærk, at React Native-delnavnene i dag er deres eget sæt, ikke webbens whop-*-klassenavne, så et web-appearance-objekt kan ikke overføres uændret.
ReactNode
Renderes i stedet for det indbyggede skelet, mens elementet indlæses.
() => void
Udløses, når elementet er interaktivt. <Payments> grupperer disse, så dens egen onLoadingChange er som regel den, du vil bruge.
(error: { message: string; code?: string }) => void
En indlæsnings- eller konfigurationsfejl for dette element. Elementet renderer under alle omstændigheder sin egen fejlvisning.

AddressChangePayload

Det, onChange returnerer:
  • complete: boolean: alle felter, som landet kræver, er udfyldt og gyldige
  • address: EmittedAddress: det, køberen har indtastet indtil videre
  • custom: Record<string, string>: værdier for de customFields, du har angivet

Tilstande

Et skelet med tre felter, mens landekataloget indlæses, og derefter formularen. Når landet ændres, planlægges felterne igen, fordi formatet er landets og ikke et fast sæt. onChange rapporterer complete, når alle felter, som landet kræver, er udfyldt og gyldige.

Godt at vide

  • Landet sættes som standard ud fra køberens IP, når detectCountry er slået til, derefter countryHint og derefter US. defaultValues.address.country tilsidesætter alle tre.
  • autocomplete er slået til som standard, ligesom på web, men det leveres af platformens geocoder i stedet for Google Places, så det kræver ingen API-nøgle, ingen konto og ingen ekstra afhængighed. iOS bruger MKLocalSearchCompleter, et ægte API til forslag under indtastning, der besvarer et fragment med flere kandidater. Android bruger android.location.Geocoder, som afgør en fuldstændig adresse i stedet for at forudsige ud fra en delvis: forvent cirka ét resultat og et mere upræcist et ved en halvt indtastet gade. Android leveres uden typeahead uden nøgle, og alternativet — Places SDK — ville tilføje flere megabyte og tvinge placeringstilladelser på alle apps, der indlejrer dette SDK.
  • Hvis en af platformene kommer til kort, sker det lydløst med vilje: en geocoder uden backend, uden netværk eller uden match viser intet, og køberen indtaster adressen manuelt, hvilket er der, de startede. Autocomplete blokerer aldrig en checkout.
  • Den udsendte adresse bruger de samme nøgler som webelementet og bekræftelsestokenets billing_details, så én payload-struktur fungerer på tværs af platforme.
  • Et monteret adresseelement er providerens faktureringskilde. Afmontér det, og createConfirmationToken falder tilbage til det, du angiver direkte.
Pak din app ind i <WhopElements getToken={…}> én gang, og montér derefter <Payments> omkring elementerne. Se Kom godt i gang og Appearance.