Skip to main content
Denne side dokumenterer @whop/elements@1.10.0 og @whop/elements-react@1.10.0.
Siden v1.0.0. Åbnes som en modal fra Balances, i Wallet: wallet.create('balances').createOverlay('settlement'). Send props og callbacks i create-indstillingerne.
Dette element er kun modal. Åbn det med createOverlay; det har ingen inline-montering.

Eksempeldata. Åbn Playground.

Props

boolean
Når den er slået fra, foretager elementet ingen læsning og viser en tom detaljetilstand. Standard er true.
boolean
Vis beløb i den valgte beholdning. Slå dette fra for at værdiansætte detaljerne i USD. Standard er true.

Hændelser

Send callbacks i create-indstillingerne eller React-props.

onLoaderStart

Kører, efter at indlæsningsskelettet tegnes første gang, og før onReady.

onReady

Kører efter elementets første komplette optegning.

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

Hent afregnings- og reservedetaljer igen. 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<SettlementElementProps>
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 sender du appearance til <Wallet>. Sæt det globalt med WhopElements({ appearance }).