TotalBalanceBreakdownElement

Overview

A UI element that displays a detailed breakdown of the user’s total available balance. This element shows how the total balance is composed, including:

Available balance (funds ready for withdrawal)
Pending transactions
Expected deposits
Any holds or adjustments

Usage

Basic usage

// Create the element
const element = session.createElement("total-balance-breakdown-element", {
  onClose: () => {
    console.log("Breakdown closed");
  },
});

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

// Show the breakdown in a modal overlay
const modal = session.showTotalBalanceBreakdownModal({
  onClose: (ev) => {
    ev.preventDefault();
    modal.close();
  },
});

Listening to events

const element = session.createElement("total-balance-breakdown-element", {});

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

element.on("close", (ev) => {
  console.log("User closed the breakdown");
});

element.mount("#container");

const element = session.createElement("total-balance-breakdown-element", {
  onReady: (element) => {
    console.log("Breakdown is ready");
  },
  onClose: (ev) => {
    console.log("User closed the breakdown");
  },
});

Events

Events emitted by the TotalBalanceBreakdownElement. 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: TotalBalanceBreakdownElement) => void

`optionsUpdated`

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

`close`

Emitted when the user closes the breakdown view. Call ev.preventDefault() to prevent the element from automatically unmounting. Callback signature: (ev: CustomEvent<any>) => void

`snapshot`

Emitted when the element’s internal state changes. Callback signature: (snapshot: TotalBalanceBreakdownElementSnapshot) => 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`<`TotalBalanceBreakdownElementOptions`>	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: TotalBalanceBreakdownElementSnapshot

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

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

Types