SettlementElement - Whop Docs

This page documents @whop/elements@1.0.0-beta.3 and @whop/elements-react@1.0.0-beta.3.

Pre-release, not yet part of a stable release. Opens as a modal from Balances, in Wallet: wallet.create('balances').createOverlay('settlement'). Pass props and callbacks in the create options.

This element is modal-only. Open it with createOverlay; it has no inline mount.

import { WhopElements, Wallet, Balances, SettlementElement } from "@whop/elements-react";
import { loadWhop } from "@whop/elements";

function Example() {
  return (
    <WhopElements elements={loadWhop()}>
      <Wallet /* options */>
        <Balances>
          <SettlementElement />
        </Balances>
      </Wallet>
    </WhopElements>
  );
}

<script src="https://js.whop.cloud/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.createOverlay('settlement').open();
</script>

Example data. Open the Playground.

Props

boolean

Off, the Element performs no read and renders an empty details state. Defaults to true.

boolean

Show amounts in the selected holding. Turn this off to value the details in USD. Defaults to true.

Events

Pass callbacks in the create options or React props.

`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 by create, or through a React ref.

`refresh`

Re-fetch settlement and reserve details. 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<SettlementElementProps>) => void

Styling

Style these parts through appearance.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.

Class	Targets
`.whop-BalanceSettlementSurface`	The dashboard-style balance details modal body

const wallet = whop.wallet.create({
  appearance: {
    classes: {
      'whop-BalanceSettlementSurface': { borderRadius: '8px', fontWeight: '600' }
    }
  }
});

wallet.update({
  appearance: {
    classes: { 'whop-BalanceSettlementSurface': { fontWeight: '700' } }
  }
});

In React, pass appearance to <Wallet>. Set it globally with WhopElements({ appearance }).

​Props

​Events

​onLoaderStart

​onReady

​onError

​Methods

​refresh

​mount

​destroy

​update

​Styling

Props

Events

`onLoaderStart`

`onReady`

`onError`

Methods

`refresh`

`mount`

`destroy`

`update`

Styling