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.
Monteres inde i et WhopPayments-scope. Indsamler køberens e-mail, som alle bekræftelsestokens kræver, og controlleren læser den, når tokenet oprettes, 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 indsamler køberens e-mail og publicerer den til provideren, så createConfirmationToken sender den, uden at noget skal angives.

Eksempeldata. Åbn Playground.

Props

boolean
Viser den lokaliserede etiket. Sæt til false, når du leverer din egen. Inputtet beholder en lokaliseret aria-label. Standard er true.
string
Pladsholdertekst til e-mail-inputtet. Tom (standard) renderer you@example.com. Med flydende etiketter er etiketteksten i stedet pladsholderen. Standard er "".
"above" | "floating"
above (standard) viser etiketten over inputtet. floating bruger etiketteksten som pladsholder og viser derefter en lille etiket over den indtastede tekst, når inputtet har en værdi. Ignoreres, når label er false. Standard er "above". Siden v1.5.0.
string
Startværdi, der anvendes én gang ved montering. Standard er "".

Events

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

onChange

Udløses, når e-mailen ændres. complete er true, når den er plausibel. Indlogning udløser den med den indloggede e-mail, som også føres videre til createConfirmationToken().
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.

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<EmailElementProps>
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<String>?
Læser værdien ud igen. Controlleren indsamler den under alle omstændigheder.
Bool
Sæt til false, når du leverer din egen etiket; inputtet beholder sin tilgængelighedsetiket. Standard er true.
String?
Tom renderer you@example.com.

Tilstande

Renderes med det samme. En usandsynlig adresse viser sin fejl, når feltet mister fokus, og derefter live.

Godt at vide

  • Uden det skal du selv angive billingDetails.email til createConfirmationToken. Oprettelsen afviser et token uden e-mail.
  • En eksplicit billingDetails.email ved oprettelsen har forrang for det, dette element indsamlede.
  • En plausibel adresse slås op i kontokataloget, med debounce og igen ved blur. En genkendt adresse tilbyder en indlogning, og elementet viser selv arket til den sekscifrede kode.
  • En verificeret indlogning låser op for køberens gemte betalingsmetoder i WhopPaymentElement. Læs payments.buyer for at se, hvem de er, og brug payments.signOut() for at glemme dem.
  • Det afgrænsede token varer en time og fornyes ikke. Når det udløber, kommer sporet med gemte metoder tilbage tomt, og køberen betaler med en ny metode — samme vej som en gæst.

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

string
Startværdi, der anvendes én gang ved montering.
boolean
Viser den lokaliserede etiket. Standard er true.
string
Tom renderer you@example.com.
(payload: EmailChangePayload) => void
Udløses ved hver redigering.
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.

EmailChangePayload

Det, onChange returnerer:
  • email: string: den aktuelle værdi
  • complete: boolean: adressen kan fortolkes

Tilstande

Renderes med det samme. onChange rapporterer complete, så snart adressen kan fortolkes, og elementet viser sin egen valideringsmeddelelse ved blur.

Godt at vide

  • Den publicerede e-mail er det, bekræftelsestokenet bærer som billing_details.email. Hvis du angiver billingDetails.email til createConfirmationToken, tilsidesættes den.
  • Sæt label={false}, når din formular leverer sin egen etiket. Inputtet beholder under alle omstændigheder sin tilgængelighedsetiket.
Pak din app ind i <WhopElements getToken={…}> én gang, og montér derefter <Payments> omkring elementerne. Se Kom godt i gang og Appearance.