This page documents
@whop/elements@1.0.0-beta.5 and @whop/elements-react@1.0.0-beta.5.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().
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.
Signature: ((payload: { paymentId: string; }) => void)
onInvoiceRequested
Open the invoice in your application.
Signature: ((payload: { paymentId: string; }) => void)
onUserSelected
Open the buyer in your application.
Signature: ((payload: { userId: string; }) => void)
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.
Signature: ((payload: { paymentIds: string[]; }) => void)
onSettingsRequested
Open the account’s payment settings in your application.
Signature: ((payload: Record<string, never>) => 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 bycreate, or through a React ref.
refresh
Reload payments after a refund or another change.
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<PaymentsTableElementProps>) => void
Styling
Style these parts throughappearance.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.
appearance to <Dashboard>. Set it globally with WhopElements({ appearance }).