Skip to main content
Deze pagina documenteert @whop/elements@1.10.0 en @whop/elements-react@1.10.0.
Sinds v1.0.0. Opent als modal vanuit Ads: ads.createOverlay('campaign-creator'). Geef props en callbacks door in de create-opties.
Dit element is alleen als modal beschikbaar. Open het met createOverlay; het kan niet inline worden gemount.

Voorbeeldgegevens. Open de Playground.

Props

string
De campagne (adcamp_…) die moet worden geopend. Leeg bouwt een nieuwe. Een concept opent waar het was gebleven; een gelanceerde campagne opent in de bewerkmodus. Standaard: "".
string
De advertentiegroep (adgrp_…) die binnen campaignId in focus moet worden geopend. Wordt genegeerd als de campagne zo’n groep niet heeft, en als campaignId leeg is. Standaard: "".
string
De advertentie (ad_…) die binnen adGroupId in focus moet worden geopend. Wordt genegeerd als die groep zo’n advertentie niet heeft, en als adGroupId leeg is. Standaard: "".
"ads" | "ad-groups" | "campaign-settings"
Bij welke stap het element opent: campaign-settings, ad-groups of ads. Het dashboard deep-linkt dit vanuit de eigen URL; geef het door om een accounteigenaar direct naar het onderdeel te brengen dat hij wilde wijzigen. Wordt één keer gelezen bij het mounten — het later wijzigen verplaatst de gebruiker niet tussen stappen. Standaard: "campaign-settings".
string[]
Bestands-ID’s (file_…) die je app via POST /api/v1/files heeft geüpload, aangeboden in de creativebibliotheek van de builder. Ze verschijnen bovenaan de bibliotheeklijst, in deze volgorde, en zolang er ID’s zijn ingesteld, openen de mediakiezers op de bibliotheek in plaats van op de uploadzone. Maak de bestanden aan met dezelfde API-sleutel die het accessToken van de handle ads aanmaakt — de builder leest ze in één batch terug (GET /api/v1/files), en bestanden kunnen alleen worden gelezen met de inloggegevens waarmee ze zijn aangemaakt. Geef maximaal 250 ID’s door, de limiet van de batchlezing. Een bestand verschijnt zodra de upload volledig is verwerkt; een ID dat nooit klaar is, of dat naar iets anders dan een afbeelding of video verwijst, wordt weggelaten. Geef nieuwe ID’s door met update({ externalMediaIds }) om media te streamen naar een builder die al open is. Standaard: [].

Events

Geef callbacks door in de create-opties of als React-props.

onExited

De accounteigenaar heeft de builder verlaten zonder te lanceren. Er is niets weggegooid — een conceptcampagne, als die was gestart, is al opgeslagen. Een overlay heeft zichzelf al gesloten wanneer dit wordt geactiveerd; reageer erop als je pagina dat nodig heeft.

onLaunched

Een campagne is live gegaan. firstLaunch markeert de allereerste gelanceerde campagne van het account; het dashboard gebruikt dit om de welkomststatus te tonen. Een overlay heeft zichzelf al gesloten; hier stuur je de gebruiker verder.
object

onLoaderStart

Wordt uitgevoerd nadat het laadskelet voor het eerst is getekend en vóór onReady.

onReady

Wordt uitgevoerd na de eerste volledige weergave van het element.

onError

Wordt uitgevoerd wanneer het element niet laadt of crasht. De fallback blijft zichtbaar. Gebruik code voor programmatische afhandeling. sourceKey identificeert een mislukte host-state-bron.
object

Methoden

Roep deze aan op de handle die create retourneert, of via een React-ref.

mount

Mount het element in target en begint met laden. React-componenten mounten zichzelf. Parameters
string | HTMLElement
vereist

destroy

Verwijdert het element en geeft het frame en de abonnementen ervan vrij. Je kunt dit meer dan eens aanroepen. React verwijdert het element automatisch.

update

Voegt nieuwe props samen in het gemounte element. Wijzig in React in plaats daarvan de props van de component. Parameters
Partial<CampaignCreatorElementProps>
vereist

Styling

Style deze onderdelen via appearance.classes. Gebruik camelCase of kebab-case voor eigenschapsnamen en vermeld eenheden. Stylesheets van de pagina kunnen het frame van het element niet bereiken. Het framework valideert elke declaratie voordat die wordt geïnjecteerd.
Geef in React appearance door aan <Ads>. Stel het globaal in met WhopElements({ appearance }).