This page documents
@whop/elements@1.0.0-beta.3 and @whop/elements-react@1.0.0-beta.3.Balances, in Wallet. accountId and accessToken come from Wallet. Pass props and callbacks through the create options or React props. Keep the created handle, or React ref, to call refresh().
Example data. Open the Playground.
Props
boolean
Off, the element performs no reads and renders a zero balance. Defaults to
true.boolean
Show amounts in the selected holding. Turn this off to value the same balance breakdown in USD. Defaults to
true.boolean
Show the currency title and total above the rows. Turn this off when the surface around it already shows them. Defaults to
true.boolean
Draw the surrounding page padding. Turn this off when the surface around it already provides it. Defaults to
true.Events
Pass callbacks in the create options or React props.onBreakdownSelected
A balance row or its matching bar segment was clicked. The host can open details for available, pending, reserve, or debt.
Signature: ((payload: { category: "pending" | "available" | "debt" | "reserve"; }) => void)
onLoaderStart
Runs after the loading skeleton first paints and before onReady.
Signature: (() => void)
onReady
Runs after the element’s first complete paint.
Signature: (() => void)
onError
Runs when the element fails to load or crashes. The fallback remains visible. Use code for programmatic handling. sourceKey identifies a failed host-state source.
Signature: ((e: { message: string; code?: string | undefined; sourceKey?: string | undefined; }) => void)
Methods
Call these on the handle returned bycreate, or through a React ref.
refresh
Re-fetch the balance after the host moves money.
Signature: () => Promise<void>
mount
Mounts the element in target and starts loading. React components mount themselves.
Signature: (target: string | HTMLElement) => void
destroy
Removes the element and releases its frame and subscriptions. You can call it more than once. React removes the element automatically.
Signature: () => void
update
Merges new props into the mounted element. In React, change the component props instead.
Signature: (options: Partial<BreakdownElementProps>) => void
Styling
Style these parts throughappearance.classes. Use camel case or kebab case for property names and include units. Page stylesheets can’t reach the element’s frame. The framework validates each declaration before injecting it.
appearance to <Wallet>. Set it globally with WhopElements({ appearance }).