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. Opret den for at få et handle, og montér derefter dens elementer på det handle. Kald destroy() for at fjerne sub-controlleren og frigøre dens plads. Opret den igen for at få et nyt handle.
Eksklusiv. CardFields er et alternativ til PaymentElement eller CardElement i dette Payments-handle. Montér ét ad gangen. Ødelæg det, før du monterer et andet.

Forhåndsvisning

En live, interaktiv demo af denne sub-controllers standardopsætning med eksempeldata:
Monteres inde i et WhopPayments-scope. De samme tre hostede inputs som WhopCardElement, placeret enkeltvis inde i dens content builder, så dit eget layout bestemmer, hvor hvert enkelt placeres.
Provideren til enkeltvis placerede kortfelter. Pak den del af din formular ind, der indeholder dem, og placér derefter CardNumberElement, CardExpiryElement og CardCvcElement, hvor dit layout ønsker dem.

Forhåndsvisning

Kørende i React Native-eksempelappen:

Indstillinger

Angiv disse til payments.create('cardFields', { … }) eller som props på <CardFields> i React. Props, der injiceres af forælderen, vises aldrig her.
CardNetworkArt[]
Sælgerens accepterede kortnetværk i visningsrækkefølge — matrixens kortposts networks-objekter, hvis ikoner leveret af API’et styrer nummerfeltets kortmærkegrafik. Udelad den for at hente dem sammen med nøglen.
"compact" | "stacked"
stacked (standard) former sammensatte felter som en nummerrække over udløbsdato og sikkerhedskode. compact former én række. Separat monterede felter ignorerer dette layout og renderes med fulde kanter og afrundede hjørner. Standard er "stacked".
string
Avanceret Basis Theory publishable key. Udelad den for at hente nøglen automatisk.

Events

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

onChange

Udløses, når fuldstændigheden ændres. complete bliver true, når køberen har udfyldt alle tre felter. Brug det til at aktivere bekræftelse. brand er det registrerede kortnetværk, som feltet rapporterer det; network er den samme registrering i API’ets netværksordforråd (matcher matrixens kortposts networks, null så længe det er ukendt). last4 er nummerets sidste fire cifre, null indtil nummeret er tastet langt nok. funding er den registrerede finansieringstype (credit, debit eller prepaid), null indtil nummeret identificerer en. issuingCountry er den to-bogstavs landekode med små bogstaver for det land, kortet er udstedt i, null indtil nummeret identificerer et.
object

Metoder

Kald disse på sub-handlet fra payments.create('cardFields', { … }).

tokenize

Avanceret metode, der tokeniserer de tre felter uden at oprette et bekræftelsestoken. Den udsender tokenized til payments-controlleren. Valideringsfejl vises på det fejlende felt, og metoden kaster en fejl. Brug payments.createConfirmationToken() til at bekræfte en betaling.Parametre
object
påkrævet
Returnerer Promise<object>
string
påkrævet

collect

payments.createConfirmationToken() kalder denne handling for cardFields. Kald den ikke direkte. Den tokeniserer felterne og returnerer de data, der bruges til at oprette bekræftelsestokenet.Parametre
object
påkrævet
Returnerer Promise<object>
object
påkrævet
object
påkrævet

update

Fletter nye props og callbacks ind i sub-controlleren.Parametre
Partial<CardFieldsSubOptions>
påkrævet

destroy

Ødelægger sub-controlleren og dens elementer og frigør derefter dens eksklusive plads. Et senere create("cardFields") starter forfra.

Parametre

String?
En avanceret publishable key. Udelad den, så hentes kontoens egen.
WhopCardElement.Layout
Læses kun, når en sammensættende enhed selv arrangerer felterne. Separat monterede felter ignorerer den.
Binding<WhopCardState>?
Læser fuldstændigheden og det registrerede kortmærke ud igen.
() -> Content
påkrævet
Hvor de tre feltvisninger placeres. Alt andet herinde renderes normalt.

WhopCardState

Det, et valg returnerer:
  • isComplete: Bool: alle tre felter er gyldige
  • brand: String?: det registrerede netværk

Tilstande

Hvert felt renderes med det samme og validerer, mens køberen skriver. state.isComplete bliver true, når alle tre er gyldige, uanset hvor du placerer dem.

Godt at vide

  • De tre feltvisninger virker kun inde i en WhopCardFields-builder: de læser den enhed, den opretter. Monteret andre steder renderer de intet.
  • Montér alle tre. En enhed, der mangler ét, bliver aldrig fuldstændig, så bekræftelsesknappen bliver aldrig aktiveret.

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

ReactNode
påkrævet
Dit layout med de tre feltelementer et sted inde i det.
string
En avanceret publishable key til tokenizeren. Udelad den, så henter SDK’et selv kontoens nøgle.
'stacked' | 'compact'
Former felter, der er sammensat. Separat monterede felter ignorerer den og renderes med fulde kanter. Standard er stacked.
(payload: CardFieldsChangePayload) => void
Udløses ved hver redigering med den samlede tilstand for de monterede felter.

CardFieldsChangePayload

Det, onChange returnerer:
  • complete: boolean: alle monterede felter er udfyldt og gyldige
  • errors: Record<string, string>: meddelelser pr. felt med nøglerne cardNumber, cardExpiry, cardCvc

Tilstande

Dens children renderes, så snart den publishable key er resolveret. onChange rapporterer den samlede tilstand for alle monterede felter, så én handler dækker hele kortet.

Godt at vide

  • Kortnumre passerer aldrig gennem din kode. Felterne er PCI-isolerede native inputs, og SDK’et giver Whop et token, så din app holdes uden for PCI-scope.
  • Alle felter skal være inde i den samme CardFields. De deler én tokenisering, så et felt monteret uden for den indsamler intet.
  • CardFields registrerer indsamlingsfladen, så createConfirmationToken tokeniserer kortet uden ekstra opsætning.
  • Den publishable key hentes automatisk. Angiv kun publicKey, hvis du allerede har en.
Pak din app ind i <WhopElements getToken={…}> én gang, og montér derefter <Payments> omkring elementerne. Se Kom godt i gang og Appearance.

Elementer

De elementer, som denne sub-controller monterer. Hvert har sin egen side:

CardNumberElement

PCI-isoleret hostet felt til kortnummer. Kortnumre når aldrig værtssiden.

CardExpiryElement

PCI-isoleret hostet felt til kortets udløbsdato.

CardCvcElement

PCI-isoleret hostet felt til kortets sikkerhedskode.