Upcoming — generated from the latest merged element source; documents unreleased development. Use the channel picker at the top of the sidebar for the docs of a published release.
Wallet group. Render <CardsElement /> inside it (React), or call wallet.create('cards', { … }) on the handle (vanilla) — consumer props and on<Event> callbacks both go in the create options / JSX props.
Preview
A live, interactive demo of this element with sample data:Usage
Props
string
A scoped token for the privileged read — needs
payout:account:read. Mint it on your server with POST /v1/access_tokens. Omitted, the read carries the viewer’s own session, which only answers same-origin.boolean
Off, the element fetches nothing and keeps the title and ”+” button visible with an empty body — for a host that only wants to fetch once some precondition (card issuing being active for this account, say) is true. Defaults to
true.number | null
Cap the rows shown, most recently issued first.
null shows every active card. Defaults to null.boolean
Render the title as plain, unclickable text instead of a click target. Off by default, in which case clicking the title emits
viewAllSelected for you to route to the full cards list — the element never navigates. Defaults to false.boolean
Hide the ”+” button. Off by default, in which case clicking it emits
addCardRequested. Defaults to false.Events
Pass a callback in the create options (or React prop) to receive these.onCardSelected
A card row was clicked. Open your own card details for it — the element never navigates.
Signature: ((payload: { cardId: string; }) => void)
onViewAllSelected
The title was clicked. Only fires when disableRedirect is false.
Signature: ((payload: Record<string, never>) => void)
onAddCardRequested
The ”+” button was clicked. Only fires when hideAddButton is false.
Signature: ((payload: Record<string, never>) => void)
onLoaderStart
Fired the moment the element’s own loading skeleton has painted inside its frame — the earliest point a consumer-managed loading state can hand off without ever exposing a blank. Always precedes onReady; most consumers only need onReady.
Signature: (() => void)
onReady
Fired once the element has booted and painted its first complete frame.
Signature: (() => void)
onError
Fired when the element fails to load or crashes; the element shows its own error fallback. message is human-readable; framework refusals also carry code (e.g. HOST_SOURCE_FAILED, with sourceKey naming the failed hostState key) so hosts can switch on codes, never message text.
Signature: ((e: { message: string; code?: string | undefined; sourceKey?: string | undefined; }) => void)
Methods
Call these on the element handle — the return ofcreate (vanilla) or the component ref (React).
refresh
Re-fetch the account’s cards. Call it after a mutation made elsewhere (rename, freeze, cancel, a new card) so the list reflects it without waiting for the cache to expire.
Signature: () => Promise<void>
mount
Place the element on the page: appends its container to target (a CSS selector or an element) and starts loading. Nothing renders until this is called. React consumers never call it — the component mounts itself.
Signature: (target: string | HTMLElement) => void
destroy
Remove the element from the page and release its frame and subscriptions. Safe to call more than once. React consumers never call it — unmounting the component does it.
Signature: () => void
update
Change this element’s consumer props after mount — it re-renders with the merged props. React consumers never call it — updating the JSX props does the same.
Signature: (options: Partial<CardsElementProps>) => void
Styling
Each part below is a stable class name — safe to depend on. Restyle a part by mapping its class to a style declaration object underappearance.classes (properties camelCase or kebab-case, values as strings with units — the same shape as React’s style prop). The element renders in its own frame, so page stylesheets can’t reach it: these declarations are sanitized against a safe-property allowlist and injected inside the frame for you.
appearance prop on <Wallet>; appearance also applies globally at WhopElements({ appearance }).