This page documents
@whop/elements@1.9.0 and @whop/elements-react@1.9.0.v1.9.0.
Mounts inside Ads. accountId and accessToken come from there. Pass props and callbacks through the create options or React props.
You can mount this element inline (
create) or open it as a modal overlay (createOverlay).Example data. Open the Playground.
Props
This element takes no consumer props.Events
Pass callbacks in the create options or React props.onSigned
The agreement was signed and recorded. agreementVersion is the version that was signed; acceptedAt is when, as an ISO 8601 timestamp. A modal closes on this event.
object
onLoaderStart
Runs after the loading skeleton first paints and before onReady.
onReady
Runs after the element’s first complete paint.
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.
object
Methods
Call these on the handle returned bycreate, or through a React ref.
mount
Mounts the element in target and starts loading. React components mount themselves.
Parameters
string | HTMLElement
required
destroy
Removes the element and releases its frame and subscriptions. You can call it more than once. React removes the element automatically.
update
Merges new props into the mounted element. In React, change the component props instead.
Parameters
Partial<AdsAgreementElementProps>
required
Styling
This element doesn’t expose class names for styling. Useappearance (theme, accent color, variables) to restyle it.