Skip to main content
Cette page documente @whop/elements@1.10.0 et @whop/elements-react@1.10.0.
Depuis v1.0.0. Se monte à l’intérieur de Tracking. accountId et accessToken en proviennent. Transmettez les props et les callbacks via les options de création ou les props React.

Données d’exemple. Ouvrir le Playground.

Props

string
Limite aux personnes acquises par une source de trafic, sous forme de chemin de source — whop:adcamp_…:* pour l’une des campagnes du compte, ext:* pour les annonces diffusées ailleurs, referrer:*, direct. C’est la même valeur que celle utilisée par les liens des compteurs de clics du tableau des annonces : une page peut donc l’hydrater directement à partir de sa propre URL. Par défaut : "".
string
Limite aux personnes ayant effectué un événement, par son nom — payment.completed, pixel.lead, pixel.page. Par défaut : "".
string
Limite aux personnes ayant effectué un événement pixel personnalisé, par son nom personnalisé. S’utilise avec un eventName vide. Par défaut : "".
string
Filtre selon le utm_source porté par leur trafic. Séparez plusieurs valeurs par des virgules pour correspondre à l’une d’entre elles. Par défaut : "".
string
Filtre par code pays ISO 3166-1 alpha-2, comme US ou GB. Par défaut : "".
string
Filtre par catégorie d’appareil — desktop, mobile, tablet, bot. Par défaut : "".
string
Filtre par nom de navigateur. Par défaut : "".
string
Filtre par nom de système d’exploitation. Par défaut : "".
string
true pour les clients uniquement, false pour les personnes n’ayant jamais acheté, vide pour tout le monde. Par défaut : "".
string
Le filtre appliqué par le champ de recherche — un nom, un e-mail ou un identifiant. Par défaut : "".
string
Limite à une audience enregistrée (adaud_…) construite à partir de filtres de personnes. Le menu de filtre d’audience modifie cette valeur. Par défaut : "".
string
Fixe la période des événements pour les filtres source/eventName sur un instant ISO 8601 exact au lieu du period du handle. Définissez à la fois eventFrom et eventTo, ou aucun des deux. Par défaut : "".
string
La fin de la période d’événements fixée, sous forme d’instant ISO 8601. Par défaut : "".
string
La colonne triée : name, email, ltv, purchase_count, event_count, first_seen_at, last_seen_at. Par défaut : "last_seen_at".
"asc" | "desc"
Le sens du tri. Par défaut : "desc".

Événements

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

onPeriodChanged

L’utilisateur a modifié la période depuis le sélecteur de période. Chaque surface du même handle a déjà suivi ce changement ; conservez-la et renvoyez-la comme period/customRange sur le handle, sinon la période est réinitialisée au prochain montage.
object

onAttributionModelChanged

L’utilisateur a changé le point de contact qui reçoit l’attribution, depuis le menu Attribution de la ligne de filtres. Chaque surface du même handle a déjà recalculé l’attribution ; conservez la valeur et renvoyez-la comme attributionModel sur le handle, sinon elle est rétablie au prochain montage.
object

onFiltersChanged

L’utilisateur a modifié un filtre, le champ de recherche ou le sélecteur d’audience. Transporte l’état complet des filtres, quel que soit celui qui a changé — reflétez-le dans votre propre URL et renvoyez-le sous forme de props pour rendre la vue reproductible.
PeopleFilterBag

onSortChanged

L’utilisateur a trié une colonne. Conservez le tri et renvoyez-le comme sort/dir, sinon il est réinitialisé au prochain montage.
object

onPersonOpened

L’utilisateur a cliqué sur une ligne de personne et le handle n’a aucun links.person à suivre. Présentez l’élément person avec cette valeur, par ex. createOverlay("person", { identifier: payload.personId }) (personId est la clé stable propre à chaque personne ; identifier est la plus parlante dont dispose la surface), ou transmettez plutôt links.person sur le handle pour transformer les lignes en véritables liens.
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<PeopleElementProps>
requis

Style

Cet élément n’expose pas de noms de classes pour le style. Utilisez appearance (thème, couleur d’accent, variables) pour modifier son apparence.