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 header-handlingsmenuen, Export-knappen og knappen til tabelindstillinger. Standard er true.
boolean
Vis handlingsmenuen med tre prikker på hver betalingsrække. Standard er true.
boolean
Vis de seks betalingsstatusbokse over filtrene. Standard er true.
boolean
Vis sporingskolonnen og -filteret for konti med fysiske produkter. Sporingsdata kræver shipment:basic:read. Standard er true.

Events

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

onPaymentSelected

Åbn betalingsdetaljer i din applikation.
object

onInvoiceRequested

Åbn fakturaen i din applikation.
object

onUserSelected

Åbn køberen i din applikation.
object

onRefundRequested

Seeren har anmodet om en refusion. Din applikation skal bekræfte og godkende den på serversiden. Refusionskontroller er kun aktiveret, når denne callback er angivet.
object

onSettingsRequested

Åbn kontoens betalingsindstillinger i din applikation.

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 betalinger efter en refusion eller en anden ændring. 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<PaymentsTableElementProps>
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 }).