> ## 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.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# BalanceElement

> Le solde d'un compte et un graphique de son évolution. Le total et sa variation se trouvent en haut, le graphique en dessous et les boutons de période en bas. Le visiteur peut lire des points individuels du graphique et changer lui-même de période.

> [!NOTE]
>
> Cette page documente `@whop/elements@1.10.0` et `@whop/elements-react@1.10.0`.

*Depuis `v1.0.0`.*

Se monte à l'intérieur de [`Balances`](https://docs.whop.com/fr/elements/latest/wallet/balances), dans [`Wallet`](https://docs.whop.com/fr/elements/latest/wallet/overview). `accountId` et `currency` proviennent de `Wallet`. Transmettez les props et les callbacks via les options de création ou les props React.

Se monte n'importe où dans votre hiérarchie de vues. Prend un `accountId` et charge ses propres données ; `range` choisit la période sur laquelle il s'ouvre. La racine est une `VStack` : elle s'adapte à son contenu et remplit la largeur que vous lui donnez.

```tsx React theme={null}
import { WhopElements, Wallet, Balances, BalanceElement } from "@whop/elements-react";
import { loadWhop } from "@whop/elements";

function Example() {
  return (
    <WhopElements elements={loadWhop()}>
      <Wallet /* options */>
        <Balances>
          <BalanceElement onRangeChanged={(e) => console.log(e)} onRangeBrushed={(e) => console.log(e)} />
        </Balances>
      </Wallet>
    </WhopElements>
  );
}
```

```html JavaScript theme={null}
<script src="https://cdn.whop.com/elements/amber/elements.js" data-whop-elements></script>
<script type="module">
  const wallet = window.WhopElements().wallet.create({ /* options */ });
  const balances = wallet.create('balances', { /* options */ });
  balances.create('balance', {
    onRangeChanged: (e) => console.log(e),
    onRangeBrushed: (e) => console.log(e)
  }).mount('#wallet-balances-balance');
</script>
```

```swift Swift theme={null}
import SwiftUI
import WhopElements

// WhopSDK.configure(tokenProvider:) runs once at app launch. See Getting started.
struct WalletScreen: View {
    var body: some View {
        BalanceElement(
            accountId: "biz_xxxx",
            range: .oneMonth
        )
    }
}
```

Données d'exemple. [Ouvrir le Playground](https://docs.whop.com/fr/elements/latest/wallet/overview#playground).

[BalanceElement exécuté sur un simulateur iPhone](https://app.revyl.ai/embed/bb0f1c0a-4242-486a-a5f5-03dd9711744c?controls=0)

## Props

**accessToken** `string`

Un jeton à portée limitée pour les lectures. Un compte nécessite `company:balance:read` pour le total et `stats:read` pour le graphique ; le propre solde d'un utilisateur nécessite `user:balance:read`. Générez-le sur votre serveur avec `POST /api/v1/access_tokens` et définissez-en un nouveau avant son expiration. Sans lui, les lectures utilisent la propre session du visiteur, qui ne fonctionne qu'en same-origin. Par défaut : `""`.

**range** `"1D" | "1W" | "1M" | "1Y" | "ALL"`

La période sur laquelle s'ouvrir. Les boutons la modifient ensuite, ou redéfinissez cette prop pour la contrôler vous-même. Par défaut : `"1M"`.

**openedAt** `string`

La date d'ouverture du compte, sous forme d'horodatage ISO 8601. `ALL` commence à cette date au lieu de sa valeur par défaut de cinq ans, de sorte qu'un compte plus ancien conserve tout son historique. Par défaut : `""`.

**accountName** `string`

Ajoute le nom du compte au libellé : `Total balance · Acme` normalement, et `Acme balance on Jul 9` lorsque le visiteur lit un point. Sans lui, le libellé est simplement `Total balance`. Par défaut : `""`.

**brush** `object | null`

La plage sélectionnée sur le graphique, sous forme d'horodatages ISO 8601. Définissez-la pour contrôler vous-même la sélection, ou `null` pour effacer celle du visiteur. Renvoyez ce que signale `rangeBrushed`, et l'effacement d'un filtre ailleurs sur votre page efface aussi la sélection ici. Par défaut : `null`.

**propriétés**

**from** `string` *required*

**to** `string` *required*

**markedAt** `string`

Un instant à marquer sur le graphique, sous forme d'horodatage ISO 8601 — le point que désigne un autre élément de votre page, comme la ligne sous le pointeur dans une liste d'activité. Cela équivaut à ce que le visiteur survole lui-même ce point, et c'est ignoré lorsque l'instant tombe en dehors de la fenêtre affichée ou lorsque le visiteur lit le graphique. Par défaut : `""`.

**includeOwnedAccounts** `boolean`

Pour un utilisateur, additionne son propre argent et celui de chaque compte qu'il possède, au lieu de son seul argent. Ignoré pour un compte, qui est déjà un compte unique. Par défaut : `false`.

**hideTotal** `boolean`

Masque le total et sa variation, en conservant le graphique et les boutons de période. Par défaut : `false`.

**hideChart** `boolean`

Masque le graphique, en conservant le total et les boutons de période. Par défaut : `false`.

**height** `number`

La hauteur du graphique, en pixels. Par défaut : `210`.

## Événements

Transmettez les callbacks dans les options de création ou dans les props React.

### `onRangeChanged`

La période visible a changé. Répercutez-la si un autre élément de votre page lit la même période.

**payload** `object`

**propriétés**

**range** `"1D" | "1W" | "1M" | "1Y" | "ALL"` *required*

### `onRangeBrushed`

Le visiteur a fait glisser le pointeur sur le graphique pour sélectionner une plage, ou a effacé la sélection (`null`). Fournit des horodatages ISO 8601 ainsi que la période dans laquelle ils ont été lus, afin que vous puissiez filtrer vos propres vues, comme une liste d'activité ou un tableau, sur la même période.

**payload** `object | null`

**propriétés**

**from** `string` *required*

**to** `string` *required*

**range** `"1D" | "1W" | "1M" | "1Y" | "ALL"` *required*

### `onLoaderStart`

S'exécute après le premier affichage du squelette de chargement et avant `onReady`.

### `onReady`

S'exécute après le premier affichage complet de l'élément.

### `onError`

S'exécute lorsque l'élément ne parvient pas à se charger ou plante. L'affichage de repli reste visible. Utilisez `code` pour une gestion programmatique. `sourceKey` identifie une source d'état hôte en échec.

**e** `object`

**propriétés**

**message** `string` *required*

**code** `string`

**sourceKey** `string`

## Méthodes

Appelez-les sur le handle renvoyé par `create`, ou via une `ref` React.

### `mount`

Monte l'élément dans `target` et démarre le chargement. Les composants React se montent eux-mêmes.

**Paramètres**

**target** `string | HTMLElement` *required*

### `destroy`

Supprime l'élément et libère son frame et ses abonnements. Vous pouvez l'appeler plusieurs fois. React supprime l'élément automatiquement.

### `update`

Fusionne de nouvelles props dans l'élément monté. Avec React, modifiez plutôt les props du composant.

**Paramètres**

**options** `Partial\<BalanceElementProps\>` *required*

## Style

Stylisez ces parties via `appearance.classes`. Utilisez le camel case ou le kebab case pour les noms de propriétés et incluez les unités. Les feuilles de style de la page ne peuvent pas atteindre le frame de l'élément. Le framework valide chaque déclaration avant de l'injecter.

| Classe | Cible |
| - | - |
| `.whop-Balance` | Le total, sa courbe et le sélecteur de période |
| `.whop-BalanceBrushSummary` | L'intervalle mesuré |
| `.whop-BalanceChart` | La courbe du solde |
| `.whop-BalanceRanges` | Le sélecteur de période |
| `.whop-BalanceTotal` | Le total et sa variation |

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

// 5 classes use this shape
wallet.update({
  appearance: { classes: { 'whop-Balance': { fontWeight: '700' } } }
});
```

Avec React, transmettez `appearance` à `<Wallet>`. Définissez-la globalement avec `WhopElements({ appearance })`.

## Paramètres

**accountId** `String` *required*

Le compte dont la vue lit l'argent. Utilisez un ID de compte préfixé par `biz_`. Un ID d'utilisateur préfixé par `user_` lit le propre solde du visiteur et nécessite une authentification du visiteur (`WhopSDK.configureWithOAuth`), et non un jeton de compte.

**currency** `String`

La devise dans laquelle le total et le graphique sont affichés. Par défaut : `"usd"`.

**range** `WalletBalanceRange`

La période sur laquelle le graphique s'ouvre : `.oneDay`, `.oneWeek`, `.oneMonth`, `.oneYear`, `.all`. Par défaut : `.oneMonth`, et le visiteur peut la modifier avec le sélecteur.

## États

Affiche un graphique provisoire pendant le chargement des données. Si la période de comparaison échoue, la variation est masquée plutôt que devinée : tout nombre à l'écran a donc réellement été mesuré. Un ID de compte qui ne peut pas être résolu affiche `Couldn't load this account.` au lieu d'un indicateur de chargement sans fin.

## Bon à savoir

* Appuyez et faites glisser sur le graphique pour le parcourir. Le chiffre principal suit le point sous votre doigt et revient au total lorsque vous relâchez.
* L'historique du solde n'est disponible que pour les ID de compte préfixés par `biz_` : un compte personnel préfixé par `user_` affiche donc le total sans graphique.
* Se combine avec [`ListElement`](https://docs.whop.com/fr/elements/latest/wallet/balances-list#swift), qui décompose le même total en avoirs individuels.

> [!NOTE]
>
> Appelez `WhopSDK.configure(tokenProvider:)` une seule fois au lancement. Les vues attendent le jeton. Consultez [Premiers pas](https://docs.whop.com/fr/elements/latest/getting-started.md). Appliquez un thème avec `.whopTheme(_:)`.


## Related topics

- [Balances](https://docs.whop.com/fr/elements/latest/wallet/balances.md)
- [ListElement](https://docs.whop.com/fr/elements/latest/wallet/balances-list.md)
- [Premiers pas avec Elements](https://docs.whop.com/fr/elements/latest/getting-started.md)
