> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

# BalancesElement

> Lists what an account holds, valued in dollars, richest first — the dollar-settled holdings (USD, USDT) as one row. Needs the handle's `accessToken`. Rows are click targets that emit `balanceSelected`.

<Info>**Upcoming** — generated from the latest merged element source; documents unreleased development. Use the channel picker at the top of the sidebar for the docs of a published release.</Info>

*In development — not yet part of a stable release.*

Belongs to the [`Wallet`](/elements/upcoming/wallet/overview) group. Render `<BalancesElement />` inside it (React), or call `wallet.create('balances', { … })` on the handle (vanilla) — consumer props and `on<Event>` callbacks both go in the create options / JSX props.

## Preview

A live, interactive demo of this element with sample data:

<div data-whop-demo-shell style={{ position: "relative", minHeight: "320px", transition: "min-height 200ms ease" }}>
  <div data-whop-demo-skeleton style={{ position: "absolute", inset: "0", borderRadius: "12px", background: "rgba(140, 140, 140, 0.12)", pointerEvents: "none", transition: "opacity 200ms ease" }} />

  <div data-whop-demo-native="element:wallet/balances" data-whop-elements-version="" style={{ position: "relative" }} />
</div>

## Usage

<div data-whop-usage="wallet/balances">
  <CodeGroup>
    ```tsx React theme={null}
    import { WhopElements, Wallet, BalancesElement } from "@whop/elements-react";
    import { loadWhop } from "@whop/elements";

    function Example() {
      return (
        <WhopElements elements={loadWhop()}>
          <Wallet /* options */>
            <BalancesElement onBalanceSelected={(payload) => console.log("balanceSelected", payload)} />
          </Wallet>
        </WhopElements>
      );
    }
    ```

    ```html Vanilla theme={null}
    <script src="https://js.whop.cloud/elements/amber/elements.js" data-whop-elements></script>
    <script type="module">
      const wallet = window.WhopElements().wallet.create({ /* options */ });
      wallet.create('balances', {
        onBalanceSelected: (payload) => console.log("balanceSelected", payload)
      }).mount('#wallet-balances');
    </script>
    ```
  </CodeGroup>
</div>

## Props

<ResponseField name="showSourceCurrency" type="boolean">
  Lead each row with the currency it is held in (€4.20, 0.00000009 cbBTC) and put the dollar value underneath. Off by default, so every row reads against one unit. Defaults to `false`.
</ResponseField>

<ResponseField name="showUsdEquivalent" type="boolean">
  Keep the dollar value under a holding shown in its own currency. Only bites alongside `showSourceCurrency`. Defaults to `true`.
</ResponseField>

## Events

Pass a callback in the create options (or React prop) to receive these.

### `onBalanceSelected`

A row was clicked. `key` is `usd` for the aggregated dollar row, otherwise the holding symbol (`cbBTC`, `EUR`); `kind` says which of the three it is, so a host routes without classifying symbols itself. The element never navigates.

**Signature:** `((payload: { key: string; kind: "usd" | "cash" | "asset"; }) => void)`

### `onLoaderStart`

Fired the moment the element's own loading skeleton has painted inside its frame — the earliest point a consumer-managed loading state can hand off without ever exposing a blank. Always precedes `onReady`; most consumers only need `onReady`.

**Signature:** `(() => void)`

### `onReady`

Fired once the element has booted and painted its first complete frame.

**Signature:** `(() => void)`

### `onError`

Fired when the element fails to load or crashes; the element shows its own error fallback. `message` is human-readable; framework refusals also carry `code` (e.g. `HOST_SOURCE_FAILED`, with `sourceKey` naming the failed hostState key) so hosts can switch on codes, never message text.

**Signature:** `((e: { message: string; code?: string | undefined; sourceKey?: string | undefined; }) => void)`

## Methods

Call these on the element handle — the return of `create` (vanilla) or the component `ref` (React).

### `mount`

Place the element on the page: appends its container to `target` (a CSS selector or an element) and starts loading. Nothing renders until this is called. React consumers never call it — the component mounts itself.

**Signature:** `(target: string | HTMLElement) => void`

### `destroy`

Remove the element from the page and release its frame and subscriptions. Safe to call more than once. React consumers never call it — unmounting the component does it.

**Signature:** `() => void`

### `update`

Change this element's consumer props after mount — it re-renders with the merged props. React consumers never call it — updating the JSX props does the same.

**Signature:** `(options: Partial<BalancesElementProps>) => void`

## Styling

Each part below is a stable class name — safe to depend on. Restyle a part by mapping its class to a **style declaration object** under `appearance.classes` (properties camelCase or kebab-case, values as strings with units — the same shape as React's `style` prop). The element renders in its own frame, so page stylesheets can't reach it: these declarations are sanitized against a safe-property allowlist and injected inside the frame for you.

| Class                   | Targets                                             |
| ----------------------- | --------------------------------------------------- |
| `.whop-BalanceRow`      | One holding row — its icon, name, value and chevron |
| `.whop-BalancesSurface` | The balances list — one row per holding             |

```ts theme={null}
const wallet = whop.wallet.create({
  appearance: {
    classes: {
      'whop-BalanceRow': { borderRadius: '8px', fontWeight: '600' },
      'whop-BalancesSurface': { borderRadius: '8px', fontWeight: '600' }
    }
  }
});

// restyle live at any point — the same shape through update()
wallet.update({
  appearance: { classes: { 'whop-BalanceRow': { fontWeight: '700' } } }
});
```

In React, pass the same object as the `appearance` prop on `<Wallet>`; `appearance` also applies globally at `WhopElements({ appearance })`.
