Denne side dokumenterer
@whop/elements@1.10.0 og @whop/elements-react@1.10.0.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.Eksempeldata. Åbn Playground.
Props
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".Navnerækken: ét felt til fulde navn (standard), opdelte felter til fornavn/efternavn eller ingen. Standard er
"combined".Adresselinje 2: altid synlig (standard), vist via en tekstknap (
toggle) eller aldrig indsamlet. Standard er "always".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 (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 (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.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".Organisationsfelter: ingen (standard), kun navn eller navn med en vælger for virksomhed/privatperson. Standard er
"none".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.Tilladte ISO 3166-1 alpha-2-landekoder. Med én kode forbliver vælgeren synlig, men tilbyder kun det land.
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.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.Ekstra felter, der renderes sammen med adresseformularen. Værdierne valideres og udsendes i det separate
custom-map.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.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.Metoder
Kald disse på det handle, somcreate 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>getValues
Returnerer address og custom uden validering og uden at vise fejl.Returnerer Promise<object>mount
Monterer elementet i target og begynder indlæsningen. React-komponenter monterer sig selv.Parametredestroy
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.ParametreStyling
Style disse dele viaappearance.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.appearance til <Payments>. Sæt den globalt med WhopElements({ appearance }).
