Skip to main content
Denne side dokumenterer @whop/elements@1.10.0 og @whop/elements-react@1.10.0.
Siden v1.0.0. Monteres inde i Websites. Send props og callbacks via create-indstillingerne eller React-props.
Du kan montere dette element inline (create) eller åbne det som et modal-overlay (createOverlay).

Eksempeldata. Åbn Playground.

Props

string
Konto-ID med præfikset biz_, som pixlen tilhører. Påkrævet; snippet’en, scanningerne og invitationerne kører alle mod den. Standard er "".
string
Et afgrænset token til scanningerne og udvikler-invitationen. Scanningerne kræver company:basic:read; “Invite a developer” kræver desuden authorized_user:create, og hændelsesforudindstillingerne læser kontoen med company:balance:read (uden det virker guiden stadig, med en generisk liste over forudindstillinger). Når der ikke angives nogen destinationUrl, foreslår det tomme URL-felt også sider fra kontoens annoncer og pixeltrafik – de læsninger kræver ad_campaign:basic:read og stats:read, og uden dem er feltet blot tomt. Udsted det på din server med POST /api/v1/access_tokens, og sæt et nyt, før det udløber. Et andet element, der åbner denne guide i sig selv – det gør annonce-elementet campaign-creator – kører disse kald med sit eget token, så tilføj disse scopes til det ene token i stedet for at udstede et nyt: dette element har ingen mulighed for at læse legitimationsoplysninger, du har sat andetsteds. Udelades det, bærer kaldene seerens egen session, som kun svarer på samme oprindelse (same-origin).
string
Siden, der skal tjekkes, og som scannes ved montering. Lad den være tom, så beder guiden om en. Det er også den, der styrer “Verify live” på hændelsestrinnet – den knap fører kontoejeren gennem sin egen funnel for at fange hændelser, som en server-side-scanning ikke kan se, så den vises først, når en destination er kendt, enten herfra eller angivet i guiden. Læses én gang ved opstart, så update() skifter ikke mål midt i forløbet – lav en ny montering til en anden side. Standard er "".
string
Valgfri. En hændelse, der skal affyres på den side (lead, schedule, view_content, …); hændelsestrinnet blokerer, indtil den registreres. Hvis den ikke er sat, tilbydes alle hændelser, og ingen er påkrævet. Hændelser, som Whop registrerer server-side (purchase, subscribe, prøveperioder, checkout-trin), ignoreres. Læses én gang ved opstart. Standard er "".
string
En URL, som destinationen omdirigerer til, når hændelsen i stedet affyres dér. Kontoejeren kan også angive en i guiden – lyt efter redirectUrlChanged, og send den tilbage næste gang. Standard er "".
"events" | "install"
Hvor guiden åbner: på installationstrinnet eller direkte på events, når pixlen allerede er der, og kun konverteringshændelsen mangler. Standard er "install".
boolean
Åbn på introskærmen “why a pixel”. Slå den fra, hvor kontoejeren allerede ved, hvorfor de er her – et kampagneforløb, der sender dem ind midt i en lancering – så åbner guiden direkte på installationstrinnet. Standard er true.
boolean
Tilbyd muligheden “Invite a developer to install it”. Skjul den, hvor de personer, der bruger din indlejring, ikke bør invitere medlemmer til Whop-teamet bag den. Standard er true.
boolean
Vis skærmen “your pixel is live”, når en side består tjekket, som tilbyder konverteringshændelser som næste skridt. Slå den fra, hvor kontoejeren er kommet for selve hændelserne – et bestået tjek går så direkte til dem i stedet for at stoppe ved en skærm, de alligevel ville klikke sig forbi. Standard er true.
boolean
Start med sidetjekket i stedet for installationsvejledningen: URL-feltet (og dets forslag) står øverst, installationsmulighederne foldes ind under en “Pixel not installed yet?”-knap, og overskriften lyder “Verify your pixel”. Til en kontoejer, der allerede har en pixel og er her for at finde ud af, hvorfor intet bliver attribueret. Kombinér det med showIntro: false. Standard er false.

Hændelser

Send callbacks i create-indstillingerne eller React-props.

onRedirectUrlChanged

Kontoejeren har angivet eller ryddet en omdirigerings-URL i guiden. Gem den, og send den tilbage som redirectUrl næste gang.
object

onScanned

En pixelscanning er afsluttet. Udløses for hver URL, guiden tjekker, så dit eget installationsmærke kan følge med. primary markerer den side, der sættes op: funnel-tjekkeren scanner alt det andet, kontoejeren angiver, inklusive andre hostnavne, så tjek den, før du behandler et resultat som værende om deres site. Du behøver ikke dette for at holde en websites-tabel retvisende – monteret under det handle får et site, der er bevist live, allerede sin ventende række.
object

onFinished

Done blev trykket. Tjek selv siden igen – dette fortæller, at guiden er færdig, ikke at dine krav er opfyldt.

onUrlSubmitted

Kontoejeren har angivet den side, der skal tjekkes, inde fra guiden – indtastet manuelt eller valgt blandt de foreslåede sider. Kan kun nås, når der ikke blev angivet nogen destination ved montering.
object

onVerifyLaunched

“Verify live” blev trykket. popupBlocked betyder, at browseren afviste funnel-vinduet, så gennemgangen aldrig startede.
object

onVerifyConnected

Funnel-siden har sendt et ping tilbage til guiden – pixlen er indlæst dér, og gennemgangen er i gang.
object

onVerdict

Verify live-gennemgangen er afsluttet. ok betyder ingen sporingshuller; ellers indeholder gaps de hulkoder, gennemgangen fandt.
object

onEventVerified

Kontoejeren har gennemgået sin funnel med “Verify live”, og denne hændelse blev affyret – bevis på, at den er koblet til dér, hvor en server-side-scanning ikke kan nå.
object

onLoaderStart

Kører, efter at indlæsningsskelettet tegnes første gang, og før onReady.

onReady

Kører efter elementets første komplette optegning.

onError

Kører, når elementet ikke kan indlæses eller går ned. Fallback-visningen forbliver synlig. Brug code til programmatisk håndtering. sourceKey identificerer en host-state-kilde, der fejlede.
object

Metoder

Kald disse på det handle, der returneres af create, eller via en React-ref.

mount

Monterer elementet i target og starter indlæsningen. React-komponenter monterer sig selv. Parametre
string | HTMLElement
påkrævet

destroy

Fjerner elementet og frigiver dets frame og abonnementer. Du kan kalde det mere end én gang. React fjerner elementet automatisk.

update

Fletter nye props ind i det monterede element. I React skal du i stedet ændre komponentens props. Parametre
Partial<PixelSetupElementProps>
påkrævet

Styling

Style disse dele via appearance.classes. Brug camel case eller kebab case til egenskabsnavne, og medtag enheder. Sidens stylesheets kan ikke nå elementets frame. Frameworket validerer hver deklaration, før den indsættes.
I React angiver du appearance til <Websites>. Sæt den globalt med WhopElements({ appearance }).