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 Checkout. Angiv props og callbacks via create-indstillingerne eller som React-props.
Eksklusiv. ExpressCheckoutElement er et alternativ til CheckoutElement i dette Checkout-handle. Montér ét ad gangen. Ødelæg det, før du monterer et andet.
Montér inde i <Checkout>, som åbner checkout-sessionen ud fra din plan, items eller checkoutConfiguration og beholder legitimationsoplysningerne for sig selv. <Checkout> monteres selv inde i <WhopElements>. Ét tryk på knappen er hele købet: der er intet bekræftelsestoken at give videre til din server.

Eksempeldata. Åbn Playground.

Props

object | ("apple_pay" | "google_pay" | "paypal_express")[]
wallets som et array er forældet og fjernes i den næste major-version. Angiv i stedet { applePay, googlePay, payPal } med "auto" eller "never".
Hvilke wallets der må renderes. Sæt applePay, googlePay eller payPal til 'never' for at udelade den knap; hver nøgle har standardværdien 'auto', et filter over det, køberens enhed og sælgeren faktisk tilbyder. Elementet viser aldrig en wallet, som enheden, den leverede matrix eller checkoutens betalingsmetodekonfiguration ikke kan understøtte, og renderingsrækkefølgen forbliver bedste native først med PayPal sidst. En liste over wallet-typer (['apple_pay', 'google_pay']) accepteres stadig som en tilladelsesliste, men er forældet og fjernes i den næste major-version; en tom liste renderer intet (med en advarsel i dev-builds). Alle wallets kræver, at Apple Pay er klar på sidens domæne via Domains API — førstepartssider på whop.com er forhåndsgodkendt; på ethvert andet website skal du tilføje Apple Pay til domænet, ellers forbliver knapperne skjult. At tilbyde Google Pay på dit eget website er underlagt Google Pay API’s servicevilkår. Standard er {}.
"auto" | "horizontal" | "vertical"
Hvordan knapperne stables. auto følger elementets egen container — stablet i smalle containere, side om side i brede; horizontal og vertical gennemtvinger ét arrangement. Standard er "auto".

Events

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

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<ExpressCheckoutElementProps>
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 <Checkout>. Sæt den globalt med WhopElements({ appearance }).

Props

('apple_pay' | 'google_pay')[]
Hvilke wallets der må renderes, som et filter over det, enheden tilbyder. Elementet viser aldrig en wallet, som enheden, kontoen eller checkoutens betalingsmetodekonfiguration ikke kan understøtte. En tom liste renderer intet. Standard er begge.
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 faldet til ro: knappen vises, eller elementet ved, at det ikke renderer noget. <Checkout> venter på den, 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.

Tilstande

Én skeletpille, mens sessionen åbnes, og enheden spørges, om den kan betale, derefter platformens egen Apple Pay- eller Google Pay-knap over meddelelsen Powered by Whop. En enhed uden wallet, en wallet, som checkoutens betalingsmetodekonfiguration deaktiverer, eller en plan, der er udsolgt eller arkiveret, renderer intet. En checkout, som et sheet ikke ærligt kan gennemføre (en setup, tilmelding til en venteliste, en overførsel, et formularspørgsmål, som kun en side kan stille), renderer en forklarende visning og rapporterer EXPRESS_CHECKOUT_UNAVAILABLE via onError. Efter købet viser elementet sit udfald: gennemført, under behandling eller et tryk på Finish payment eller Try again, når betalingen stadig kræver køberen.

Godt at vide

  • En enhed tilbyder én wallet: Apple Pay på iOS, Google Pay på Android. Derfor er der ingen layout-prop her: der er aldrig en anden knap at arrangere.
  • Sheetet indsamler det, sessionen stadig mangler: e-mailen, når sessionen ikke har en, et telefonnummer, når sælgeren indsamler et, og en leveringsadresse til fysiske varer. En sælger, der verificerer telefonnumre, får et kodetrin i en native modal, når sheetet lukkes.
  • På iOS genberegner sheetet prisen, når køberen skifter kort, så momsen følger faktureringsadressen, og det tilbyder et felt til rabatkode, når sælgeren tillader koder. Googles Android-sheet viser checkoutens total og har intet kodefelt.
  • Der navigeres aldrig i din app. onComplete på <Checkout> udløses én gang, når købet står fast, med sessionId og receiptId, og det er her, du sender køberen videre. Lever ud fra webhooks, ikke ud fra denne callback.
  • 3D Secure og andre eksterne trin åbner ASWebAuthenticationSession på iOS og Custom Tabs på Android, og elementet poller betalingen, indtil den er afgjort. returnUrl på <Checkout> skal være en https-URL, som du hoster.
  • Alle <Checkout>-indstillinger angives ved oprettelse. Ændres en af dem efter montering, rapporteres CHECKOUT_OPTIONS_FROZEN, og den oprindelige ordre bevares; giv <Checkout> en ny key for at sælge noget andet.
Pak din app ind i <WhopElements getToken={…}> én gang, og montér derefter <Checkout> omkring elementet. <Checkout> tager plan, items, checkoutConfiguration, quantity, promoCode, affiliateCode, attribution, metadata og returnUrl plus onComplete, onError, onLoadingChange og fallback. Se Kom godt i gang og Appearance.