Skip to main content
Cette page documente @whop/elements@1.10.0 et @whop/elements-react@1.10.0.
Depuis v1.0.0. S’ouvre sous forme de fenêtre modale depuis Ads : ads.createOverlay('campaign-creator'). Transmettez les props et les callbacks dans les options de création.
Cet élément est uniquement modal. Ouvrez-le avec createOverlay ; il n’a pas de montage inline.

Données d’exemple. Ouvrir le Playground.

Props

string
La campagne (adcamp_…) à ouvrir. Une valeur vide crée une nouvelle campagne. Un brouillon s’ouvre là où il a été laissé ; une campagne lancée s’ouvre en mode édition. Par défaut : "".
string
Le groupe d’annonces (adgrp_…) à mettre en avant à l’ouverture, au sein de campaignId. Ignoré lorsque la campagne ne contient pas ce groupe, et lorsque campaignId est vide. Par défaut : "".
string
L’annonce (ad_…) à mettre en avant à l’ouverture, au sein de adGroupId. Ignoré lorsque ce groupe ne contient pas cette annonce, et lorsque adGroupId est vide. Par défaut : "".
"ads" | "ad-groups" | "campaign-settings"
L’étape sur laquelle ouvrir : campaign-settings, ad-groups ou ads. Le tableau de bord la renseigne à partir de sa propre URL ; transmettez-la pour amener directement le propriétaire du compte sur la partie qu’il souhaite modifier. Lue une seule fois au montage — la modifier ensuite ne le fera pas changer d’étape. Par défaut : "campaign-settings".
string[]
ID de fichiers (file_…) téléversés par votre app via POST /api/v1/files, proposés dans la bibliothèque de créations du builder. Ils apparaissent en premier dans la liste de la bibliothèque, dans cet ordre, et tant qu’il y en a, les sélecteurs de médias s’ouvrent sur la bibliothèque plutôt que sur la zone de dépôt. Créez les fichiers avec la même clé API que celle qui émet l’accessToken du handle ads — le builder les relit en un seul lot (GET /api/v1/files), et la lecture de fichiers ne répond qu’à l’identifiant qui les a créés. Transmettez au maximum 250 ID, la limite de la lecture par lot. Un fichier apparaît une fois le traitement de son téléversement terminé ; un ID dont le traitement n’aboutit jamais, ou qui désigne autre chose qu’une image ou une vidéo, est ignoré. Transmettez de nouveaux ID avec update({ externalMediaIds }) pour ajouter des médias à un builder déjà ouvert. Par défaut : [].

Événements

Transmettez les callbacks dans les options de création ou dans les props React.

onExited

Le propriétaire du compte a quitté le builder sans lancer de campagne. Rien n’a été supprimé — un brouillon de campagne, s’il a été commencé, est déjà enregistré. Un overlay s’est déjà fermé lorsque cet événement se déclenche ; réagissez-y si votre page en a besoin.

onLaunched

Une campagne a été mise en ligne. firstLaunch signale la toute première campagne lancée par le compte, ce que le tableau de bord utilise pour afficher son état de bienvenue. Un overlay s’est déjà fermé ; c’est ici que vous redirigez vers la suite.
object

onLoaderStart

S’exécute après le premier affichage du squelette de chargement et avant onReady.

onReady

S’exécute après le premier affichage complet de l’élément.

onError

S’exécute lorsque l’élément ne parvient pas à se charger ou plante. L’affichage de repli reste visible. Utilisez code pour une gestion programmatique. sourceKey identifie une source d’état hôte en échec.
object

Méthodes

Appelez-les sur le handle renvoyé par create, ou via une ref React.

mount

Monte l’élément dans target et démarre le chargement. Les composants React se montent eux-mêmes. Paramètres
string | HTMLElement
requis

destroy

Supprime l’élément et libère son frame et ses abonnements. Vous pouvez l’appeler plusieurs fois. React supprime l’élément automatiquement.

update

Fusionne de nouvelles props dans l’élément monté. Avec React, modifiez plutôt les props du composant. Paramètres
Partial<CampaignCreatorElementProps>
requis

Style

Stylisez ces parties via appearance.classes. Utilisez le camel case ou le kebab case pour les noms de propriétés et incluez les unités. Les feuilles de style de la page ne peuvent pas atteindre le frame de l’élément. Le framework valide chaque déclaration avant de l’injecter.
Avec React, transmettez appearance à <Ads>. Définissez-la globalement avec WhopElements({ appearance }).