Skip to main content
This page documents @whop/elements@1.0.0-beta.3 and @whop/elements-react@1.0.0-beta.3.
Pre-release, not yet part of a stable release. Mounts inside Verifications. Pass props and callbacks through the create options or React props.

Example data. Open the Playground.

Props

boolean
Hide the rows that are already with a reviewer, leaving only what the viewer can act on. Defaults to false.

Events

Pass callbacks in the create options or React props.

onSubmitted

One group of requirements was answered. Fires per group, not once per field. Signature: ((payload: { source: "identity" | "payout" | "audit" | "card_issuing" | "bank" | "ads" | "application"; itemIds: string[]; }) => void)

onCompleted

Nothing is outstanding any more. Fires when the element first observes an empty list, including on mount. Signature: ((payload: { accountId: string; }) => void)

onLoadFailed

The outstanding requests could not be read, or answering one failed. Signature: ((payload: { reason: "access_denied" | "unavailable"; }) => 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 by create, or through a React ref.

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<RfiElementProps>) => void

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.
In React, pass appearance to <Verifications>. Set it globally with WhopElements({ appearance }).