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 select().Eksklusiv.
PaymentElement er et alternativ til CardElement eller CardFields i dette Payments-handle. Montér ét ad gangen. Ødelæg det, før du monterer et andet.Venter på
BrandingElement. Dette element forbliver i sin indlæsningstilstand, indtil BrandingElement er monteret i det samme Payments-handle.Eksempeldata. Åbn Playground.
Props
Styrer visningsrækkefølgen i begge layouts. Angivne typer vises først i rækkefølge. Ikke-angivne typer bevarer deres indbyrdes rækkefølge. Påvirker ikke tilgængeligheden. Standard er
[].Styrer, hvilke wallets elementet tilbyder. Hver nøgle har standardværdien
'auto', som tilbyder wallet’en overalt, hvor kontoen, køberens enhed og opkrævningen understøtter den. 'never' fjerner den pågældende wallet fra metodelisten. Brug det, når din side tegner sine egne Apple Pay-, Google Pay- eller PayPal-knapper med paymentRequest, så køberne kun ser hver wallet én gang. payPal: 'never' fjerner PayPal-metoden. Gemte betalingsmetoder påvirkes ikke. Standard er {}. Siden v1.8.0.Styrer indsamlingen af faktureringsoplysninger.
billingDetails: 'minimal' (standard) følger hver metodes matrix. Metoder indsamler som standard navn og landets fulde format. En tilsidesættelse kan indsamle kun det erklærede minimum eller ingenting. For kort er minimum navn på kortet, land og postnummer. 'full' kræver navn og landets fulde format for hver ny metode. 'never' skjuler blokken. address: 'minimal' indsamler kun hver metodes erklærede minimum plus et land, hvor dette minimum mangler et (og også postnummeret, når billingDetails: 'full' angiver, at checkouten er momspligtig), undtagen for wallets, krypto, bankdebiteringer, bankoverførsler, card-present og in-app-køb, som slet ikke indsamler nogen adresse, og undtagen for en metode, hvis udbyder kræver den fulde faktureringsadresse (requires_full_billing_address), hvis flise følger de samme regler som en checkout uden markering; ellers har den forrang over billingDetails: 'full'; brug den, når sælgeren ikke indsamler en fuld faktureringsadresse. phone: 'never' skjuler kun inputtet til faktureringstelefon, når din formular allerede indsamler det; angiv billingDetails.phone til createConfirmationToken for metoder, der kræver det. Angiv i stedet adressen til createConfirmationToken. Landevælgeren omfatter kun lande, der understøttes af metoden og betalingsvalutaen. Når en afbetalingsplan er valgt, indsnævres den til de lande, planen betjener — faktureringslandet er det transaktionsland, opkrævningen behandles under. Den låses, når kun ét er tilgængeligt. Standard er {"billingDetails":"minimal"}.Forudfylder faktureringsoplysningerne, når hver metodes faktureringsblok renderes første gang. Køberen kan redigere hvert forudfyldt felt.
address.country er en ISO 3166-1 alpha-2-kode og gælder kun, når den valgte metode accepterer den. phone udfylder inputtet til faktureringstelefon for metoder, der indsamler et, i E.164-format såsom +14155552671; et nummer uden for metodens understøttede telefonlande ignoreres. Kun felter, som blokken renderer, forudfyldes og sendes. Angiv alt andet til createConfirmationToken i billingDetails. Siden v1.1.0.Vælgerens layout.
accordion (standard) stabler metoderne og udvider detaljerne inline. horizontal viser fliser med ens bredde uden rulning med detaljerne for den valgte nedenunder. Efter fire metoder åbner en More-flise en indbygget vælger. Den metode, der vælges dér, optager den sidste flise indtil næste valg. Valg og bekræftelse fungerer på samme måde. Standard er "accordion".Kun
accordion. Tilføjer afstand og separat kortstyling mellem metoderne. Ignoreres, når layout er horizontal. Standard er false.Om den første tilbudte metode skal vælges efter opløsning. Standardværdien
true respekterer order og udsender selected og change som ved en køberinteraktion. Den kører én gang før køberinteraktion og gør intet, når ingen metode tilbydes. Sæt false for at montere uden valg. Uafhængigt heraf falder valget tilbage til den første tilbudte metode, hvis en opdatering fjerner den valgte metode. Et element uden valg forbliver uden valg. Standard er true.Events
Angiv callbacks i create-indstillingerne eller som React-props.onChange
Udløses, når valget ændres. complete: true betyder, at køberen har valgt en metode og udfyldt dens kortfelter eller påkrævede input. Brug det til at aktivere bekræftelse. paymentMethod er den valgte betalingsmetode, gemt eller ny, eller null, mens intet er valgt: displayName og icons betegner valget, som elementet viser det (med balance.imageUrl, billedet af en saldos ejer), card indeholder et korts netværk, sidste fire cifre og finansieringstype, requiresBillingPhone angiver, om metoden kræver et telefonnummer i faktureringsoplysningerne, og countries angiver, hvorfra metoden kan betale i opkrævningens valuta. type, requiresBillingPhone og method på øverste niveau er forældede: læs dem fra paymentMethod. supportsBuyerFee på øverste niveau er også forældet, uden erstatning: Whop prissætter selv sit servicegebyr for købere.onAddressChange
Udløses ca. 300 ms efter, at den interne faktureringsadresse ændres. Brug det til moms, forsendelse eller andre adresseafhængige opdateringer. country er en ISO 3166-1 alpha-2-kode. Payloaden udelader andre adressenøgler, når de er tomme eller ikke bruges i det pågældende land. complete: true betyder, at faktureringsblokken er gyldig og komplet. Denne event udløses kun, mens betalingselementet ejer adresseindsamlingen. Med fields.billingDetails: 'never' skal du bruge din egen adressekilde. Med et monteret AddressElement skal du bruge dets change-event.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.select
Vælg en metode via samme vej som en køberinteraktion. For eksempel udvider select('cashapp') flisen og udsender selected og change. Kort forbliver complete: false, indtil deres felter er udfyldt. Ukendte, utilgængelige eller beløbsbegrænsede metoder afvises med koden METHOD_NOT_OFFERED. select(null) rydder valget og udsender change med complete: false. Brug sammen med autoSelect={false} for fuld ekstern kontrol.ParametreReturnerer Promise<void>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 }).
