BalancesElement

Overview

A UI element that displays a multi-currency balance overview with expandable currency rows showing available, pending, and reserve breakdowns per currency. This element provides a comprehensive multi-currency balance view, including:

Aggregated total balance across all currencies
Expandable rows for each currency with available, pending, and reserve breakdowns
Primary currency pinned at the top of the list
Treasury (crypto portfolio) section when enabled

Usage

Basic usage

// Create the element
const element = session.createElement("balances-element", {
  primaryCurrency: "usd",
  onReady: (element) => {
    console.log("Balances loaded");
  },
});

// Mount it to a container
element.mount("#balances-container");

Listening to events

const element = session.createElement("balances-element", {});

element.on("ready", () => {
  console.log("Element loaded");
});

element.on("snapshot", (snapshot) => {
  console.log("Currencies:", snapshot.currencies);
  console.log("Treasury enabled:", snapshot.treasuryEnabled);
});

element.mount("#container");

const element = session.createElement("balances-element", {
  primaryCurrency: "usd",
  onReady: (element) => {
    console.log("Balances element is ready");
  },
});

Events

Events emitted by the BalancesElement. Listen to these events using the on() method or by passing callback functions in the options.

`error`

Emitted when an error occurs during element initialization or operation. Callback signature: (error: unknown) => void

`ready`

Emitted when the element has finished loading and is ready for user interaction. Callback signature: (element: BalancesElement) => void

`optionsUpdated`

Emitted when the element’s options are updated via updateOptions(). Callback signature: (options: BalancesElementOptions) => void

`snapshot`

Emitted when the element’s internal state changes. Callback signature: (snapshot: BalancesElementSnapshot) => void

Methods

`mount(container)`

Mount the element to a DOM container. The container must be an empty element. The element will be appended as a child. If the element is already mounted, this method will log a warning and return.

Parameter	Type	Description
`container`	`HTMLElement` \| `#$\{`string`\}`	The container element or a CSS selector starting with ’#‘

// Using a selector
element.mount("#my-container");

// Using an element reference
const container = document.getElementById("my-container");
element.mount(container);

`unmount()`

Remove the element from the DOM and clean up all event listeners. After unmounting, the element instance should not be reused. Create a new element instance if you need to mount again.

// Unmount when done
element.unmount();

// Commonly used in event handlers
element.on("complete", () => {
  element.unmount();
});

`updateOptions(options)`

Update the element’s configuration options after creation. Only the provided options will be updated; other options remain unchanged. The element will re-render with the new options.

Parameter	Type	Description
`options`	`Partial`<`BalancesElementOptions`>	Partial options object with the values to update

// Update a single option
element.updateOptions({
  onComplete: (ev) => {
    console.log("New handler!");
  },
});

`getSnapshot()`

Get the current state snapshot of the element. The snapshot contains the element’s current internal state, such as loading status, form values, or other element-specific data. Returns: BalancesElementSnapshot

const snapshot = element.getSnapshot();
console.log("Current state:", snapshot.state);

// Or listen for changes
element.on("snapshot", (snapshot) => {
  console.log("State changed:", snapshot);
});

Types