PaymentsTableElement

This page documents @whop/elements@1.9.0 and @whop/elements-react@1.9.0.

Since v1.0.0. Mounts inside Dashboard. accountId and accessToken come from there. Pass props and callbacks through the create options or React props. Keep the created handle, or React ref, to call refresh().

import { WhopElements, Dashboard, PaymentsTableElement } from "@whop/elements-react";
import { loadWhop } from "@whop/elements";

function Example() {
  return (
    <WhopElements elements={loadWhop()}>
      <Dashboard /* options */>
        <PaymentsTableElement onPaymentSelected={(e) => console.log(e)} onInvoiceRequested={(e) => console.log(e)} onUserSelected={(e) => console.log(e)} onRefundRequested={(e) => console.log(e)} onSettingsRequested={(e) => console.log(e)} />
      </Dashboard>
    </WhopElements>
  );
}

<script src="https://cdn.whop.com/elements/amber/elements.js" data-whop-elements></script>
<script type="module">
  const dashboard = window.WhopElements().dashboard.create({ /* options */ });
  dashboard.create('paymentsTable', {
    onPaymentSelected: (e) => console.log(e),
    onInvoiceRequested: (e) => console.log(e),
    onUserSelected: (e) => console.log(e),
    onRefundRequested: (e) => console.log(e),
    onSettingsRequested: (e) => console.log(e)
  }).mount('#dashboard-paymentsTable');
</script>

Example data. Open the Playground.

Props

boolean

Show the header action menu, Export button, and table settings button. Defaults to true.

boolean

Show the three-dot action menu on each payment row. Defaults to true.

boolean

Show the six payment status boxes above the filters. Defaults to true.

boolean

Show the tracking column and filter for physical-product accounts. Tracking data requires shipment:basic:read. Defaults to true.

Events

Pass callbacks in the create options or React props.

`onPaymentSelected`

Open payment details in your application.

object

Hide properties

string

required

`onInvoiceRequested`

Open the invoice in your application.

object

Hide properties

string

required

`onUserSelected`

Open the buyer in your application.

object

Hide properties

string

required

`onRefundRequested`

The viewer requested a refund. Your application must confirm and authorize it server-side. Refund controls are enabled only when this callback is provided.

object

Hide properties

string[]

required

`onSettingsRequested`

Open the account’s payment settings in your application.

`onLoaderStart`

Runs after the loading skeleton first paints and before onReady.

`onReady`

Runs after the element’s first complete paint.

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

object

Hide properties

string

required

string

Methods

Call these on the handle returned by create, or through a React ref.

`refresh`

Reload payments after a refund or another change. Returns Promise<void>

`mount`

Mounts the element in target and starts loading. React components mount themselves. Parameters

string | HTMLElement

required

`destroy`

Removes the element and releases its frame and subscriptions. You can call it more than once. React removes the element automatically.

`update`

Merges new props into the mounted element. In React, change the component props instead. Parameters

Partial<PaymentsTableElementProps>

required

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-PaymentsTable`	The complete payments table

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

dashboard.update({
  appearance: { classes: { 'whop-PaymentsTable': { fontWeight: '700' } } }
});

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

​Props

​Events

​onPaymentSelected

​onInvoiceRequested

​onUserSelected

​onRefundRequested

​onSettingsRequested

​onLoaderStart

​onReady

​onError

​Methods

​refresh

​mount

​destroy

​update

​Styling

Props

Events

`onPaymentSelected`

`onInvoiceRequested`

`onUserSelected`

`onRefundRequested`

`onSettingsRequested`

`onLoaderStart`

`onReady`

`onError`

Methods

`refresh`

`mount`

`destroy`

`update`

Styling