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 <ActivityElement /> inside it (React), or call wallet.create('activity', { … }) 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
company:balance: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, card-transaction rows render as inert (no click, no hover) instead of firing
activitySelected — for a host that knows the viewer lacks permission to see those details. Defaults to true.Events
Pass a callback in the create options (or React prop) to receive these.onActivitySelected
A row was clicked. Open your own details view or route for it — the element never navigates.
Signature: ((payload: { activity: LedgerActivity; }) => void)
onDateRangeChanged
The viewer changed the date filter directly through the filter row — not via setDateRange. Clear any host-side range selection (like a chart brush) that no longer matches.
Signature: ((payload: { dateRange: { start: string; end: string; } | null; }) => 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 activity from the first page. Call it after a mutation made elsewhere (a deposit, a send) so the list reflects it without waiting for the cache to expire.
Signature: () => Promise<void>
setDateRange
Set the date-range filter from outside the element — e.g. wire a chart brush selection into the list. Pass null to clear it back to no date filter.
Signature: (input: ActivityDateRangeOverride | null) => 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<ActivityElementProps>) => 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 }).