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 Dashboard. accountId og accessToken kommer derfra. Angiv props og callbacks via create-indstillingerne eller som React-props. Behold det oprettede handle eller React-ref for at kalde refresh().

Eksempeldata. Åbn Playground.

Props

boolean
Vis Refund-knappen og handlingsmenuen øverst til højre. Ændrende handlinger kræver event-handlere. Standard er true.
string
Den betaling, der skal vises, med præfikset pay_. Påkrævet for at indlæse en betaling. Standard er "".
boolean
Vis betalingsbeløbet, gebyrerne og nettobeløbet. Standard er true.
boolean
Vis betalingens aktivitetstidslinje. Standard er true.
boolean
Vis kundens navn, brugernavn, e-mail, telefon og faktureringsadresse, når det er tilladt. Standard er true.
boolean
Vis produkt, plan, betalingsmetode, betalingsmetadata og betalings-id’er. Standard er true.
boolean
Vis kunderejsen. Læser det kontoafgrænsede Events API kun, mens den er synlig. Standard er true.

Events

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

onRefundRequested

Bekræft og godkend en refusion i din applikation. Kun aktiveret, når betalingen kan refunderes, og der er angivet en handler.
object

onRetryRequested

Bekræft og godkend endnu et opkrævningsforsøg i din applikation.
object

onVoidRequested

Bekræft og godkend annullering af denne betaling i din applikation.
object

onInvoiceRequested

Vis eller download fakturaen i din applikation.
object

onCustomerSelected

Åbn kunden i din applikation.
object

onMessageRequested

Åbn din brugerflade til beskeder med kunder.
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.

refresh

Genindlæs betalingen og dens gebyrer, når en host-handling er fuldført. Returnerer Promise<void>

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