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 Balances, i Wallet. accountId og currency kommer fra Wallet. Send props og callbacks via create-indstillingerne eller React-props.
Monteres hvor som helst i dit view-hierarki. Tager et accountId og indlæser sine egne data; range vælger det tidsinterval, den åbner på. Roden er en VStack, så den tilpasser sin størrelse til indholdet og fylder den bredde, du giver den.

Eksempeldata. Åbn Playground.

Props

string
Et afgrænset token til læsningerne. En konto skal have company:balance:read for totalen og stats:read for diagrammet; en brugers egen saldo kræver user:balance:read. Udsted det på din server med POST /api/v1/access_tokens, og sæt et nyt, før det udløber. Uden det bruger læsningerne seerens egen session, hvilket kun virker på samme origin. Standard er "".
"1D" | "1W" | "1M" | "1Y" | "ALL"
Det tidsinterval, der åbnes på. Knapperne ændrer det derfra, eller sæt denne prop igen for selv at styre det. Standard er "1M".
string
Hvornår kontoen blev oprettet, som et ISO 8601-tidsstempel. ALL starter her i stedet for ved sin standard på fem år, så en konto, der er ældre end det, beholder hele sin historik. Standard er "".
string
Tilføjer kontonavnet til etiketten: normalt Total balance · Acme og Acme balance on Jul 9, mens seeren aflæser et punkt. Uden det er etiketten blot Total balance. Standard er "".
object | null
Det markerede interval på diagrammet som ISO 8601-tidsstempler. Sæt det for selv at styre markeringen, eller null for at rydde den, seeren har lavet. Send det tilbage, som rangeBrushed rapporterer, så rydder en nulstilling af et filter et andet sted på din side også markeringen her. Standard er null.
string
Et tidspunkt, der skal markeres på diagrammet, som et ISO 8601-tidsstempel – det punkt, noget andet på din side peger på, f.eks. rækken under markøren i en aktivitetsliste. Det opfører sig, som om seeren selv holdt markøren over punktet, og ignoreres, når det falder uden for det viste vindue, eller når seeren aflæser diagrammet. Standard er "".
boolean
For en bruger: summér vedkommendes egne penge plus alle konti, vedkommende ejer, i stedet for kun egne penge. Ignoreres for en konto, som allerede er en enkelt konto. Standard er false.
boolean
Skjul totalen og dens ændring, så diagrammet og intervalknapperne står tilbage. Standard er false.
boolean
Skjul diagrammet, så totalen og intervalknapperne står tilbage. Standard er false.
number
Hvor højt diagrammet tegnes, i pixels. Standard er 210.

Hændelser

Send callbacks i create-indstillingerne eller React-props.

onRangeChanged

Det synlige tidsinterval ændrede sig. Spejl det, hvis noget andet på din side læser den samme periode.
object

onRangeBrushed

Seeren trak hen over diagrammet for at markere et interval eller ryddede markeringen (null). Giver ISO 8601-tidsstempler plus det interval, de blev aflæst i, så du kan filtrere dine egne visninger, f.eks. en aktivitetsliste eller en tabel, til den samme periode.
object | null

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.

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<BalanceElementProps>
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 }).

Parametre

String
påkrævet
Den konto, hvis penge visningen læser. Brug et konto-ID med præfikset biz_. Et bruger-ID med præfikset user_ læser seerens egen saldo og kræver seergodkendelse (WhopSDK.configureWithOAuth), ikke et kontotoken.
String
Den valuta, totalen og diagrammet vises i. Standard er "usd".
WalletBalanceRange
Det tidsinterval, diagrammet åbner på: .oneDay, .oneWeek, .oneMonth, .oneYear, .all. Standard er .oneMonth, og seeren kan ændre det med vælgeren.

Tilstande

Viser et pladsholderdiagram, mens dataene indlæses. Hvis sammenligningsperioden fejler, skjules ændringen i stedet for at blive gættet, så ethvert tal på skærmen er et, der faktisk er målt. Et konto-ID, der ikke kan opløses, viser Couldn't load this account. i stedet for at blive ved med at indlæse.

Godt at vide

  • Tryk og træk hen over diagrammet for at scrubbe det. Overskriften følger punktet under din finger og vender tilbage til totalen, når du slipper.
  • Saldohistorik er kun tilgængelig for konto-ID’er med præfikset biz_, så en personlig konto med præfikset user_ viser totalen uden et diagram.
  • Passer sammen med ListElement, som opdeler den samme total i individuelle beholdninger.
Kald WhopSDK.configure(tokenProvider:) én gang ved opstart. Visninger venter på tokenet. Se Kom godt i gang. Anvend et tema med .whopTheme(_:).