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 Websites. accountId and windowDays come from there. Pass props and callbacks through the create options or React props.

Example data. Open the Playground.

Props

This element takes no consumer props.

Events

Pass callbacks in the create options or React props.

onWebsiteToggled

A domain row was expanded or collapsed to show or hide its pages. Signature: ((payload: { domain: string; expanded: boolean; }) => void)

onWebsitesLoaded

The table settled on a list of domains. Fires on every load, not only when the list changes, so a poll that comes back the same still reports — use it to drop any pendingWebsites that are now live. Signature: ((payload: { domains: string[]; }) => void)

onVerifyRequested

The pixel-check button was pressed. Open url and watch for pixel events on your side, then push the outcome back through the handle’s verifyStatus so the button reflects it. Signature: ((payload: { target: string; url: string; }) => void)

onSettingsRequested

The settings button on a whop.site row was pressed. The element only reports the click — open your own editing surface for the app. Signature: ((payload: { appId: string; route: string; domain: string; }) => void)

onEditRequested

The edit button on a whop.site row was pressed. The element only reports the click — open your own editing surface for the app. Signature: ((payload: { appId: string; route: string; domain: string; }) => 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<WebsitesElementProps>) => 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 <Websites>. Set it globally with WhopElements({ appearance }).