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 Payments. Pass props and callbacks through the create options or React props.
Mount inside <Payments>, which owns the charge and the confirmation token. <Payments> itself mounts inside <WhopElements>. It collects the buyer’s email and publishes it to the provider, so createConfirmationToken sends it without being passed anything.

Example data. Open the Playground.

Props

boolean
Shows the localized label. Set false when supplying your own. The input retains a localized aria-label. Defaults to true.
string
Seed value applied once at mount. Defaults to "".
string
Placeholder text for the email input. Empty (default) renders you@example.com. Defaults to "".

Events

Pass callbacks in the create options or React props.

onChange

Fires when the email changes. complete is true when plausible. Sign-in fires it with the signed-in email, which also feeds createConfirmationToken().Signature: ((payload: { email: string; complete: boolean; }) => 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<EmailElementProps>) => 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 <Payments>. Set it globally with WhopElements({ appearance }).

Props

string
Seed value applied once at mount.
boolean
Shows the localized label. Defaults to true.
string
Empty renders you@example.com.
(payload: EmailChangePayload) => void
Fires on every edit.
StyleProp<ViewStyle>
Applied to the element’s outer View. For theming, prefer appearance.parts on the provider, which covers every element on this surface. Note the React Native part names are their own set today, not the web’s whop-* class names, so a web appearance object does not port across unchanged.
ReactNode
Rendered instead of the built-in skeleton while the element loads.
() => void
Fires once the element is interactive. <Payments> groups these, so its own onLoadingChange is usually the one you want.
(error: { message: string; code?: string }) => void
A load or configuration failure for this element. The element renders its own error face either way.

EmailChangePayload

What onChange hands back:
  • email: string: the current value
  • complete: boolean: the address parses

States

Renders immediately. onChange reports complete once the address parses, and the element shows its own validation message on blur.

Good to know

  • The published email is what the confirmation token carries as billing_details.email. Passing billingDetails.email to createConfirmationToken overrides it.
  • Set label={false} when your form supplies its own label. The input keeps its accessibility label either way.
Wrap your app in <WhopElements getToken={…}> once, then mount <Payments> around the elements. See Getting started and Appearance.