Skip to main content
Deze pagina documenteert @whop/elements@1.10.0 en @whop/elements-react@1.10.0.
Sinds v1.0.0.
Wordt gemount binnen Payments. Geef props en callbacks mee via de create-opties of als React-props. Bewaar de aangemaakte handle, of de React-ref, om validate() en getValues() aan te roepen.
Eén per mode. Mount één <AddressElement /> voor elke mode-waarde onder één Payments-handle. Een tweede mount met dezelfde mode wordt geweigerd. De mode van een element wordt ingesteld wanneer je het aanmaakt; om die te wijzigen, verwijder je het element en maak je een nieuw aan.
Wordt gemount binnen een WhopPayments-scope. Verzamelt het factuuradres in het eigen formaat van het geselecteerde land, en de controller leest het voor het aanmaken van het token, of je het nu bindt of niet.
Mount binnen <Payments>, dat de afschrijving en het bevestigingstoken beheert. <Payments> zelf wordt gemount binnen <WhopElements>. Het geeft het factuuradres weer in het landformaat van de koper en publiceert het naar de provider, zodat createConfirmationToken het oppikt zonder dat je iets hoeft mee te geven.

Voorbeeldgegevens. Open de Playground.

Props

"billing" | "shipping"
Welk adres dit verzamelt: billing (standaard) of shipping. Stelt ook het autocomplete-doel van de browser in. Je kunt van elk één mounten onder één handle. Factuurgegevens komen van het factuurelement, of van het verzendelement wanneer er geen factuurelement is gemount. Standaard "billing".
"split" | "none" | "combined"
De naamrij: één veld voor de volledige naam (standaard), gesplitste velden voor voor- en achternaam, of geen. Standaard "combined".
"never" | "toggle" | "always"
Adresregel 2: altijd zichtbaar (standaard), getoond via een tekstknop (toggle), of nooit verzameld. Standaard "always".
object
Startwaarden die eenmaal vóór de eerste weergave worden toegepast (address.country is een ISO 3166-1 alpha-2-landcode). Heeft voorrang op landdetectie via IP.
"full" | "compact" | "wrap"
full (standaard) stapelt velden met labels. compact groepeert velden met placeholderlabels binnen één rand. wrap behoudt de afzonderlijke velden van full en zet daarnaast plaats, staat en postcode naast elkaar. Die en de paren die full al naast elkaar zet (voor- en achternaam, organisatie) passen zoveel per rij als de breedte toelaat en lopen door naar een volgende rij naarmate die smaller wordt. Standaard "full".
"above" | "floating"
above (standaard) houdt elk label buiten het veld: erboven in de full-lay-out, als placeholder in compact. floating gebruikt elk label als placeholder van het veld, in beide lay-outs, en toont daarna een klein label boven de getypte tekst zodra het veld een waarde heeft. Standaard "above". Sinds v1.5.0.
"minimal" | "full"
full (standaard) volgt het volledige adresformaat van het geselecteerde land. minimal verzamelt alleen land en postcode. name voegt onafhankelijk daarvan vereiste naamvelden toe. Stel name in op none om ze weg te laten. Dit element voegt geen velden toe die een betaalmethode vereist. Kaartbevestiging vereist een naam, land en postcode, dus houd name ingeschakeld of geef billingDetails.name mee. Standaard "full".
"none" | "name" | "name_with_type"
Organisatievelden: geen (standaard), alleen naam, of naam met een kiezer voor bedrijf/particulier. Standaard "none".
boolean
Bepaal het standaardland op basis van het IP-adres van de koper (vastgesteld vóór de eerste weergave). Valt terug op countryHint van de controller, daarna op US. Standaard true.
string[]
Toegestane ISO 3166-1 alpha-2-landcodes. Met één code blijft de kiezer zichtbaar, maar biedt alleen dat land aan.
boolean
Schakelt Google Places-suggesties in voor het straatadres. Als er geen overeenkomst verschijnt of Places is geblokkeerd, meldt de lijst dat er geen overeenkomsten zijn en kunnen kopers het adres handmatig invoeren. Op een telefoon openen de suggesties schermvullend via een zoekknop in het straatveld in plaats van eronder, waar het toetsenbord ze zou bedekken. Stel in op false voor een gewone invoer. Standaard true.
boolean
Toont elk adresveld vanaf het begin. Standaard (false) opent het formulier met het straatadres en toont het de rest zodra de koper een suggestie kiest, een adres typt of ervoor kiest het handmatig in te voeren. Standaard false. Sinds v1.6.0.
object[]
Extra velden die met het adresformulier worden weergegeven. Waarden worden gevalideerd en uitgezonden in de afzonderlijke custom-map.
string
Fallbackland na defaultValues en IP-detectie. Gebruik een ISO 3166-1 alpha-2-code. Een lege waarde valt terug op US. Standaard "".

Events

Geef callbacks mee in de create-opties of als React-props.

onChange

Wordt geactiveerd wanneer het adres verandert. complete is true wanneer alle landspecifieke velden en vereiste aangepaste velden geldig zijn. address volgt de namen van billing_details van het bevestigingstoken, waaronder postal_code. country is een ISO 3166-1 alpha-2-code. Aangepaste waarden staan in custom.
object

onLoaderStart

Wordt uitgevoerd nadat het laadskelet voor het eerst is weergegeven en vóór onReady.

onReady

Wordt uitgevoerd na de eerste volledige weergave van het element.

onError

Wordt uitgevoerd wanneer het element niet kan laden of crasht. De fallback blijft zichtbaar. Gebruik code voor programmatische afhandeling. sourceKey identificeert een mislukte host-state-bron.
object

Methoden

Roep deze aan op de handle die create retourneert, of via een React-ref.

validate

Valideert het formulier, toont alle inline fouten en gooit nooit een fout. Retourneert complete, address en errors. errors is leeg precies wanneer complete true is. Sleutels gebruiken contractnamen zoals postal_code en line1, custom:<key> voor aangepaste velden en tijdelijk form tijdens het laden.Retourneert Promise<object>
boolean
vereist
object
vereist
Record<string, string>
vereist

getValues

Retourneert address en custom zonder validatie of het tonen van fouten.Retourneert Promise<object>
object
vereist
Record<string, string>
vereist

mount

Mount het element in target en begint met laden. React-componenten mounten zichzelf.Parameters
string | HTMLElement
vereist

destroy

Verwijdert het element en geeft het frame en de abonnementen vrij. Je kunt het meerdere keren aanroepen. React verwijdert het element automatisch.

update

Voegt nieuwe props samen in het gemounte element. Wijzig in React in plaats daarvan de componentprops.Parameters
Partial<AddressElementProps>
vereist

Styling

Style deze onderdelen via appearance.classes. Gebruik camelCase of kebab-case voor eigenschapsnamen en vermeld eenheden. Stylesheets van de pagina kunnen het frame van het element niet bereiken. Het framework valideert elke declaratie voordat die wordt geïnjecteerd.
Geef in React appearance mee aan <Payments>. Stel het globaal in met WhopElements({ appearance }).

Parameters

Binding<PostalAddress>?
Leest het verzamelde adres terug. De controller verzamelt het in beide gevallen.
Binding<Bool>?
True zodra elk veld dat het land vereist, is ingevuld en geldig is.
WhopAddressElement.Mode
.billing of .shipping. Shipping vraagt het toetsenbord om verzendvelden. Standaard .billing.
WhopAddressElement.Layout
.full geeft elk veld een label en stapelt ze; .compact verplaatst de labels naar placeholders. Standaard .full.
WhopAddressElement.Scope
.full verzamelt het volledige formaat van het land; .minimal verzamelt alleen land en postcode. Standaard .full.
WhopAddressElement.NameFields
.combined voor één veld voor de volledige naam, .split voor voor- en achternaam, .none om de naam weg te laten. Standaard .combined.
WhopAddressElement.OrganizationFields
.none, .name voor een organisatienaam, of .nameWithType om ook te vragen of het een bedrijf of een particulier is. Standaard .none.
WhopAddressElement.Line2Field
.always toont de tweede regel, .toggle toont die via een knop, .never laat die weg. Standaard .toggle.
PostalAddress?
Waarden om mee te beginnen. De country ervan is een ISO 3166-1 alpha-2-code en heeft voorrang op detectie.
Bool
Begint bij het eigen land van de koper wanneer true. Valt terug op countryHint, daarna op het land van de afschrijvingsvaluta, daarna op US. Standaard true.
[String]?
Beperkt de kiezer tot deze ISO 3166-1 alpha-2-codes, gecombineerd met de eigen beperking van de geselecteerde methode.
String?
ISO 3166-1 alpha-2-fallback voor de landketen.
Bool
Straatsuggesties terwijl de koper typt. Als het uit staat, valt er niets te kiezen, dus wordt elk veld vanaf het begin getoond. Standaard true.

PostalAddress

Wat een selectie teruggeeft:
  • country: String: ISO 3166-1 alpha-2, in hoofdletters
  • line1 / line2 / city / state / postalCode: String?, in het eigen formaat van het land
  • name / firstName / lastName: String?, volgens de name-modus
  • organization / organizationType: String?, volgens de organization-modus

Statussen

Het formulier wordt direct weergegeven. Met autocomplete aan bij .full-scope verschijnen de plaatsvelden na een suggestie of handmatige invoer; zet het uit en elk veld wordt meteen getoond. Fouten worden getoond bij de eerste bevestigingspoging, daarna live.

Goed om te weten

  • MapKit levert de straatsuggesties op het apparaat. Whop ziet de zoekopdracht van de koper nooit terwijl die typt.
  • defaultValues.country gaat vóór detectie. Detectie valt terug op countryHint, daarna op het land van de afschrijvingsvaluta, daarna op US.
  • allowedCountries wordt gecombineerd met de eigen beperking voor het factuurland van de geselecteerde methode, dus een methode die maar één land accepteert, beperkt de kiezer vanzelf.
  • PostalAddress gebruikt de billing_details-sleutels van het bevestigingstoken, zodat dezelfde JSON op alle platforms werkt.

Installatie

Mount het binnen een WhopPayments(accountID:charge:)-scope, die de controller aanmaakt en aan de inhoud doorgeeft. payments.buyer is de ingelogde koper zodra een inlog via e-mail er een heeft bevestigd. WhopBrandingElement moet ook op het scherm staan, omdat Whop merchant of record is bij deze verkopen en createConfirmationToken zonder dit element weigert. Style met .whopElementsAppearance(_:). De module is Elements, niet WhopElements van de wallet-SDK. Zie Aan de slag en Appearance.

Props

'billing' | 'shipping'
Autocomplete-doel. Standaard billing.
'full' | 'compact'
full geeft elk veld een label en stapelt ze. compact verplaatst de labels naar placeholders. Standaard full.
'full' | 'minimal'
full volgt het volledige formaat van het land. minimal verzamelt alleen land en postcode. Standaard full.
'combined' | 'split' | 'none'
Eén veld voor de volledige naam, voor- en achternaam, of geen naamveld. Standaard combined.
'none' | 'name' | 'name_with_type'
Of er een organisatie wordt verzameld, en of er ook wordt gevraagd of het een bedrijf of een particulier is. Standaard none.
'toggle' | 'always' | 'never'
Hoe de tweede adresregel verschijnt. Standaard toggle, dat een knop “Add address line 2” toont.
string[]
Beperk de landkiezer tot deze ISO 3166-1 alpha-2-codes. De eigen landenlijst van een geselecteerde betaalmethode beperkt dit verder, maar verruimt het nooit.
boolean
Bepaal het standaardland op basis van het IP-adres van de koper.
string
Fallbackland na defaultValues en IP-detectie. ISO 3166-1 alpha-2.
{ name?: string; address?: Partial<EmittedAddress> }
Startwaarden die eenmaal bij het mounten worden toegepast, voor een hervatte sessie.
CustomFieldSpec[]
Extra velden die op een gedeclareerde positie worden weergegeven (after_name, after_organization, before_country, after_address). Een vereist veld bepaalt complete.
(payload: AddressChangePayload) => void
Wordt bij elke bewerking geactiveerd met de huidige momentopname.
StyleProp<ViewStyle>
Toegepast op de buitenste View van het element. Gebruik voor thema’s bij voorkeur appearance.parts op de provider, dat elk element op dit oppervlak dekt. Let op: de namen van React Native-onderdelen vormen momenteel een eigen set, niet de whop-*-klassenamen van het web, dus een appearance-object voor het web is niet ongewijzigd over te zetten.
ReactNode
Wordt weergegeven in plaats van het ingebouwde skelet terwijl het element laadt.
() => void
Wordt eenmaal geactiveerd zodra het element interactief is. <Payments> groepeert deze, dus de eigen onLoadingChange daarvan is meestal wat je nodig hebt.
(error: { message: string; code?: string }) => void
Een laad- of configuratiefout voor dit element. Het element geeft in beide gevallen zijn eigen foutscherm weer.

AddressChangePayload

Wat onChange teruggeeft:
  • complete: boolean: elk veld dat het land vereist, is ingevuld en geldig
  • address: EmittedAddress: wat de koper tot nu toe heeft ingevoerd
  • custom: Record<string, string>: waarden voor alle customFields die je hebt gedeclareerd

Statussen

Een skelet met drie velden terwijl de landencatalogus laadt, daarna het formulier. Het wijzigen van het land herschikt de velden, omdat het formaat van het land afhangt en geen vaste set is. onChange meldt complete wanneer elk veld dat het land vereist, is ingevuld en geldig is.

Goed om te weten

  • Het land wordt standaard bepaald op basis van het IP-adres van de koper wanneer detectCountry aan staat, daarna countryHint, daarna US. defaultValues.address.country overschrijft alle drie.
  • autocomplete staat standaard aan, net als op het web, maar wordt geleverd door de geocoder van het platform in plaats van Google Places, dus er is geen API-sleutel, geen account en geen extra afhankelijkheid nodig. iOS gebruikt MKLocalSearchCompleter, een echte API die tijdens het typen een fragment beantwoordt met meerdere kandidaten. Android gebruikt android.location.Geocoder, die een volledig adres omzet in plaats van te voorspellen op basis van een gedeeltelijk adres: verwacht ongeveer één resultaat, en een grover resultaat bij een half getypte straat. Android biedt geen typeahead zonder sleutel, en het alternatief — de Places SDK — zou meerdere megabytes toevoegen en locatierechten afdwingen voor elke app die deze SDK insluit.
  • Als een van beide platforms tekortschiet, gebeurt dat bewust geruisloos: een geocoder zonder backend, netwerk of overeenkomsten toont niets en de koper typt het adres met de hand, waar die ook mee begon. Autocomplete blokkeert nooit een checkout.
  • Het uitgezonden adres gebruikt dezelfde sleutels als het webelement en billing_details van het bevestigingstoken, zodat één payloadvorm op alle platforms werkt.
  • Een gemount adreselement is de factuurbron van de provider. Ontkoppel het en createConfirmationToken valt terug op wat je er rechtstreeks aan meegeeft.
Wikkel je app eenmaal in <WhopElements getToken={…}> en mount daarna <Payments> rond de elementen. Zie Aan de slag en Appearance.