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. En vælger til registreringstype ved siden af værdifeltet, forudvalgt ud fra køberens land.
Montér inde i <Payments>, som ejer opkrævningen og bekræftelsestokenet. <Payments> monteres selv inde i <WhopElements>. En vælger til registreringstype ved siden af et værdiinput, så en køber, der indtaster et moms- eller CUIT-nummer, først vælger den rigtige type.

Eksempeldata. Åbn Playground.

Props

boolean
Deaktiverer begge felter, mens hosten gemmer den senest bekræftede registrering. Standard er false.
string
Køberens land som ISO 3166-1 alpha-2, der bruges til at forudvælge typen. AR vælger ar_cuit, LI vælger li_uid. EU samt ikke-tilknyttede eller tomme værdier vælger eu_vat. Andre tilknyttede lande vælger deres egen første type. Et manuelt valg bevares på tværs af landeskift. Standard er "".
object
Startværdier for type og value fra en genoptaget session. En ikke-understøttet type falder tilbage til landets standard.
string
API-valideringsfejl, der vises under værdiinputtet. Tom (standard) viser intet. Standard er "".

Events

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

onChange

Udløses ved blur eller Enter, når værdien ikke er tom, eller når typen ændres, mens der er en værdi. Identiske på hinanden følgende værdier udløses én gang. Rydning af værdien udløser ikke. Hosten skal selv rydde gemte registreringer.
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<TaxIdElementProps>
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<WhopTaxID?>?
Modtager hver bekræftet registrering.
String?
Køberens land som ISO 3166-1 alpha-2, der bruges til at forudvælge typen.
WhopTaxID?
Et startpar fra en genoptaget session. En ikke-understøttet type falder tilbage.
Bool
Deaktiverer begge felter, mens du gemmer den senest bekræftede registrering. Standard er false.
String?
En API-valideringsfejl, der vises under værdiinputtet.

WhopTaxID

Det, et valg returnerer:
  • type: WhopTaxIDType: registreringstypen, eu_vat, ar_cuit, …
  • value: String: selve registreringen

Tilstande

Renderes med det samme. En værdi, der ikke matcher den valgte types format, viser sin fejl. error renderer en API-valideringsfejl under værdifeltet.

Godt at vide

  • AR forudvælger ar_cuit; EU-medlemmer og alt, der ikke er tilknyttet, forudvælger eu_vat. Et manuelt valg bevares på tværs af landeskift.
  • Angiv landet fra adresseelementet, så de to holdes i takt.
  • Bindingen udløses ved hver bekræftet registrering, ikke ved hvert tastetryk.

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
Køberens land som ISO 3166-1 alpha-2, der bruges til at forudvælge typen. AR vælger ar_cuit; EU og ikke-tilknyttede værdier vælger eu_vat.
{ type: string; value: string }
Startpar fra en genoptaget session. En ikke-understøttet type falder tilbage.
boolean
Deaktiverer begge felter, mens du gemmer den senest bekræftede registrering.
string
En valideringsbesked fra dit API, der vises under værdiinputtet.
(payload: TaxIdChangePayload) => void
Udløses ved hver ændring af type eller værdi.
StyleProp<ViewStyle>
Anvendes på elementets ydre View. Til tematisering bør du foretrække appearance.parts på provideren, som dækker alle elementer på denne flade. Bemærk, at React Native-delenes navne i dag er deres eget sæt og 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 normalt den, du har brug for.
(error: { message: string; code?: string }) => void
En indlæsnings- eller konfigurationsfejl for dette element. Elementet renderer under alle omstændigheder sin egen fejlvisning.

TaxIdChangePayload

Det, onChange returnerer:
  • taxId: { type: TaxIdType; value: string }: den valgte registreringstype og det, køberen har indtastet

Tilstande

Renderes med det samme. Typen forudvælges ud fra country, og værdiinputtet valideres mod den types format. onChange udløses med det aktuelle par.

Godt at vide

  • country forudvælger kun. En køber, der vælger en type manuelt, beholder den på tværs af landeskift.
  • Angiv error for at vise en besked fra din egen API-validering under værdiinputtet.
  • Elementet rapporterer parret. Det er op til dig at sende det: knyt det til din egen ordre eller kundepost.
Pak din app ind i <WhopElements getToken={…}> én gang, og montér derefter <Payments> omkring elementerne. Se Kom godt i gang og Appearance.