BalanceReportElement

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

Pre-release, not yet part of a stable release. Mounts inside Reports, in Wallet. accountId and accessToken come from Wallet. Pass props and callbacks through the create options or React props. Keep the created handle, or React ref, to call refresh().

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

function Example() {
  return (
    <WhopElements elements={loadWhop()}>
      <Wallet /* options */>
        <Reports>
          <BalanceReportElement onActivityRequested={(e) => console.log(e)} onPaymentsRequested={(e) => console.log(e)} onExportReady={(e) => console.log(e)} />
        </Reports>
      </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 reports = wallet.create('reports', { /* options */ });
  reports.create('balanceReport', {
    onActivityRequested: (e) => console.log(e),
    onPaymentsRequested: (e) => console.log(e),
    onExportReady: (e) => console.log(e)
  }).mount('#wallet-reports-balanceReport');
</script>

Example data. Open the Playground.

Props

This element takes no consumer props.

Events

Pass callbacks in the create options or React props.

`onActivityRequested`

Emitted when activity opens inline, with its exact filters. Your host can also use this callback to navigate to its own activity page. Signature: ((payload: ReportActivityFilters) => void)

`onPaymentsRequested`

Providing this callback enables payment-method links. Open your payments page for the supplied method and time window. Signature: ((payload: ReportPaymentsRequest) => void)

`onExportReady`

A CSV is ready. The element also shows an explicit download link. Signature: ((payload: ReportExportReady) => void)

`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`

Refresh the report data after activity changes. 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<BalanceReportElementProps>) => 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-Report`	The complete balance report.
`.whop-ReportActivity`	The report activity table and filters.

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

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

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

​Props

​Events

​onActivityRequested

​onPaymentsRequested

​onExportReady

​onLoaderStart

​onReady

​onError

​Methods

​refresh

​mount

​destroy

​update

​Styling

Props

Events

`onActivityRequested`

`onPaymentsRequested`

`onExportReady`

`onLoaderStart`

`onReady`

`onError`

Methods

`refresh`

`mount`

`destroy`

`update`

Styling