Skip to main content
Deze pagina documenteert @whop/elements@1.10.0 en @whop/elements-react@1.10.0.
Sinds v1.0.0.
Wordt gemount binnen Balances, in Wallet. accountId en currency komen van Wallet. Geef props en callbacks mee via de create-opties of als React-props.
Kan overal in je view-hiërarchie worden gemount. Neemt een accountId en laadt zijn eigen gegevens; range kiest het tijdsbereik waarmee het opent. De root is een VStack, dus de grootte past zich aan de inhoud aan en vult de breedte die je het geeft.

Voorbeeldgegevens. Open de Playground.

Props

string
Een scoped token voor het lezen. Een account heeft company:balance:read nodig voor het totaal en stats:read voor de grafiek; het eigen saldo van een gebruiker heeft user:balance:read nodig. Maak het aan op je server met POST /api/v1/access_tokens en stel een nieuw token in voordat het verloopt. Zonder token gebruiken de leesacties de eigen sessie van de kijker, wat alleen same-origin werkt. Standaard "".
"1D" | "1W" | "1M" | "1Y" | "ALL"
Het tijdsbereik waarmee wordt geopend. De knoppen wijzigen het vanaf daar, of stel deze prop opnieuw in om het zelf te beheren. Standaard "1M".
string
Wanneer het account is geopend, als ISO 8601-tijdstempel. ALL begint hier in plaats van bij de standaard van vijf jaar, zodat een ouder account zijn volledige geschiedenis behoudt. Standaard "".
string
Voegt de accountnaam toe aan het label: normaal Total balance · Acme, en Acme balance on Jul 9 terwijl de kijker een punt afleest. Zonder deze prop is het label gewoon Total balance. Standaard "".
object | null
Het geselecteerde bereik in de grafiek, als ISO 8601-tijdstempels. Stel het in om de selectie zelf te beheren, of op null om de selectie van de kijker te wissen. Geef terug wat rangeBrushed meldt, dan wist het wissen van een filter elders op je pagina ook de selectie hier. Standaard null.
string
Een moment om in de grafiek te markeren, als ISO 8601-tijdstempel — het punt waarnaar iets anders op je pagina verwijst, zoals de rij onder de aanwijzer in een activiteitenlijst. Het werkt alsof de kijker zelf over dat punt hovert, en wordt genegeerd wanneer het buiten het zichtbare venster valt of wanneer de kijker de grafiek afleest. Standaard "".
boolean
Telt voor een gebruiker het eigen geld plus elk account dat de gebruiker bezit op, in plaats van alleen het eigen geld. Wordt genegeerd voor een account, dat al één account is. Standaard false.
boolean
Verberg het totaal en de verandering, zodat de grafiek en de bereikknoppen overblijven. Standaard false.
boolean
Verberg de grafiek, zodat het totaal en de bereikknoppen overblijven. Standaard false.
number
Hoe hoog de grafiek wordt getekend, in pixels. Standaard 210.

Events

Geef callbacks mee in de create-opties of als React-props.

onRangeChanged

Het zichtbare tijdsbereik is gewijzigd. Neem het over als iets anders op je pagina dezelfde periode leest.
object

onRangeBrushed

De kijker heeft over de grafiek gesleept om een bereik te selecteren, of heeft de selectie gewist (null). Geeft ISO 8601-tijdstempels plus het bereik waarin ze zijn afgelezen, zodat je je eigen views, zoals een activiteitenlijst of een tabel, op dezelfde periode kunt filteren.
object | null

onLoaderStart

Wordt uitgevoerd nadat het laadskelet voor het eerst is weergegeven en vóór onReady.

onReady

Wordt uitgevoerd na de eerste volledige weergave van het element.

onError

Wordt uitgevoerd wanneer het element niet kan laden of crasht. De fallback blijft zichtbaar. Gebruik code voor programmatische afhandeling. sourceKey identificeert een mislukte host-state-bron.
object

Methoden

Roep deze aan op de handle die create retourneert, of via een React-ref.

mount

Mount het element in target en begint met laden. React-componenten mounten zichzelf.Parameters
string | HTMLElement
vereist

destroy

Verwijdert het element en geeft het frame en de abonnementen vrij. Je kunt het meerdere keren aanroepen. React verwijdert het element automatisch.

update

Voegt nieuwe props samen in het gemounte element. Wijzig in React in plaats daarvan de componentprops.Parameters
Partial<BalanceElementProps>
vereist

Styling

Style deze onderdelen via appearance.classes. Gebruik camelCase of kebab-case voor eigenschapsnamen en vermeld eenheden. Stylesheets van de pagina kunnen het frame van het element niet bereiken. Het framework valideert elke declaratie voordat die wordt geïnjecteerd.
Geef in React appearance door aan <Wallet>. Stel het globaal in met WhopElements({ appearance }).

Parameters

String
vereist
Het account waarvan de view het geld leest. Gebruik een account-ID met het voorvoegsel biz_. Een gebruikers-ID met het voorvoegsel user_ leest het eigen saldo van de kijker en vereist kijkerauthenticatie (WhopSDK.configureWithOAuth), geen accounttoken.
String
De valuta waarin het totaal en de grafiek worden weergegeven. Standaard "usd".
WalletBalanceRange
Het tijdsbereik waarmee de grafiek opent: .oneDay, .oneWeek, .oneMonth, .oneYear, .all. Standaard .oneMonth, en de kijker kan het wijzigen met de kiezer.

Statussen

Toont een placeholdergrafiek terwijl de gegevens laden. Als de vergelijkingsperiode mislukt, wordt de verandering verborgen in plaats van geschat, zodat elk getal op het scherm daadwerkelijk is gemeten. Een account-ID dat niet kan worden opgelost, toont Couldn't load this account. in plaats van te blijven laden.

Goed om te weten

  • Druk en sleep over de grafiek om erdoorheen te scrollen. De kop volgt het punt onder je vinger en keert terug naar het totaal wanneer je loslaat.
  • Saldogeschiedenis is alleen beschikbaar voor account-ID’s met het voorvoegsel biz_, dus een persoonlijk account met het voorvoegsel user_ toont het totaal zonder grafiek.
  • Werkt samen met ListElement, dat hetzelfde totaal opsplitst in afzonderlijke tegoeden.
Roep WhopSDK.configure(tokenProvider:) eenmaal aan bij het opstarten. Views wachten op het token. Zie Aan de slag. Pas een thema toe met .whopTheme(_:).