EmailElement - Whop Docs

This page documents @whop/elements@1.0.0-beta.0 and @whop/elements-react@1.0.0-beta.0.

Pre-release, not yet part of a stable release. Mounts inside Payments. Pass props and callbacks through the create options or React props.

import { WhopElements, Payments, EmailElement } from "@whop/elements-react";
import { loadWhop } from "@whop/elements";

function Example() {
  return (
    <WhopElements elements={loadWhop()}>
      <Payments /* options */>
        <EmailElement onChange={(e) => console.log(e)} />
      </Payments>
    </WhopElements>
  );
}

<script src="https://js.whop.cloud/elements/amber/elements.js" data-whop-elements></script>
<script type="module">
  const payments = window.WhopElements().payments.create({ /* options */ });
  payments.create('email', { onChange: (e) => console.log(e) }).mount('#payments-email');
</script>

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.

Class	Targets
`.whop-Email`	Email element root
`.whop-EmailError`	Invalid email message
`.whop-EmailInput`	The email input
`.whop-EmailInputInvalid`	Email input with an implausible value
`.whop-EmailLabel`	Email field label
`.whop-EmailSignedIn`	Signed-in buyer row
`.whop-EmailSignIn`	Welcome back sign-in control
`.whop-EmailSignInError`	Sign-in error message
`.whop-EmailSignOut`	Choose a different email control

const payments = whop.payments.create({
  appearance: {
    classes: {
      'whop-Email': { borderRadius: '8px', fontWeight: '600' },
      'whop-EmailError': { borderRadius: '8px', fontWeight: '600' },
      'whop-EmailInput': { borderRadius: '8px', fontWeight: '600' }
    }
  }
});

// 9 classes use this shape
payments.update({
  appearance: { classes: { 'whop-Email': { fontWeight: '700' } } }
});

In React, pass appearance to <Payments>. Set it globally with WhopElements({ appearance }).

​Props

​Events

​onChange

​onLoaderStart

​onReady

​onError

​Methods

​mount

​destroy

​update

​Styling

Props

Events

`onChange`

`onLoaderStart`

`onReady`

`onError`

Methods

`mount`

`destroy`

`update`

Styling