This page documents
@whop/elements@1.0.0-beta.3 and @whop/elements-react@1.0.0-beta.3.Cards, 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().
Example data. Open the Playground.
Props
string
A scoped token for the privileged reads. Card rows need
payout:account:read; cardholder names also need company:authorized_user:read. Omitted, calls carry the viewer’s own session, which only answers same-origin.boolean
Off, the element does not fetch and renders its shell with no card rows. Defaults to
true.boolean
Hide the create virtual card button. Off by default. Defaults to
false.boolean
Show last month’s spend. Turn this off when the viewer may see cards but not account financials. Defaults to
true.Events
Pass callbacks in the create options or React props.onCardSelected
A row was clicked. Open the host-owned card details experience for this card.
Signature: ((payload: { cardId: string; }) => void)
onCreateCardRequested
The create virtual card button was clicked.
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
Re-fetch the cards and cardholders after the host creates, freezes, cancels, or renames a card.
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<CardsTableElementProps>) => 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 <Wallet>. Set it globally with WhopElements({ appearance }).