Cette page documente
@whop/elements@1.10.0 et @whop/elements-react@1.10.0.v1.0.0.
Playground
Assemblez les éléments avec des données d’exemple. Manipulez les contrôles, ajoutez et organisez des éléments, et observez les événements se déclencher en direct :Options
Transmettez-les àwhop.tracking.create({ … }), ou sous forme de props sur <Tracking> avec React.
ID du compte, préfixé par
biz_, dont les personnes et les événements sont lus. Obligatoire. Par défaut : "".Un jeton à portée limitée avec lequel lisent les deux surfaces. Générez un seul jeton pour tout le handle sur votre serveur avec
POST /api/v1/access_tokens, et définissez-en un nouveau avec update({ accessToken }) avant son expiration. La lecture des listes nécessite member:basic:read ou company:basic:read ; les compteurs d’options des menus de filtres utilisent en plus stats:read, et le filtre d’audience enregistrée du tableau People utilise audience:basic:read — sans eux, les menus affichent simplement moins d’options. S’il est omis, les appels utilisent la propre session de l’utilisateur, qui ne répond qu’en same-origin.L’endroit où mènent les liens de personne sur votre site.
person est un modèle d’URL absolue avec deux placeholders, chacun remplacé (encodé pour URL) à chaque ligne : {personId} est l’ID stable prsn_…, identique pour une même personne sur chaque surface — indexez donc votre page sur lui et montez-y l’élément person ; {identifier} est l’identifiant le plus parlant dont dispose la surface (un ID d’utilisateur ou un e-mail s’il est connu), il peut donc différer d’une surface à l’autre. Il doit être absolu (https://…) ; une URL relative serait résolue par rapport au frame de l’élément, elle est donc considérée comme non définie. S’il n’est pas défini, un clic sur une personne déclenche plutôt personOpened sur son élément, ce qui est le signal pour présenter person par-dessus votre page. Les URL de base people et events sont acceptées par symétrie avec le handle des annonces, mais rien sous ce handle ne les affiche. Par défaut : {}.La période couverte par les deux surfaces :
today, yesterday, last_7_days, last_14_days, last_30_days, last_90_days, all_time ou custom (à associer à customRange). Les éléments portent le sélecteur et modifient cette valeur ; relisez-la via periodChanged. Par défaut : "last_14_days".L’une des valeurs "today", "yesterday", "last_7_days", "last_14_days", "last_30_days", "last_90_days", "all_time" ou "custom".La période explicite, sous forme d’instants ISO 8601, utilisée lorsque
period vaut custom. Ignorée sinon. Par défaut : null.Le fuseau horaire, parmi deux, dans lequel la période est résolue :
account, le fuseau de planification propre au compte, ou local, le fuseau du navigateur de l’utilisateur. account se rabat sur le fuseau de l’utilisateur lorsque le compte n’en a défini aucun. Par défaut : "account".Le point de contact du parcours d’une personne qui reçoit l’attribution lors d’un filtrage par source :
last_touch, la valeur par défaut, ou first_touch. Les éléments portent le sélecteur et modifient cette valeur : un hôte peut donc la piloter et la relire via attributionModelChanged. Par défaut : "last_touch".Personnalisation visuelle des éléments de ce groupe. Remplace le
WhopElements({ appearance }) global. Modifiez-la en direct avec update({ appearance }).Langue du texte de l’interface des éléments de ce groupe. Définissez-la sur l’une des langues intégrées à l’application pour remplacer la configuration globale. Toute autre valeur revient à la langue par défaut.
Événements
Transmettez les callbacks dans les options de création ou dans les props React.onLoadingChange
S’exécute lorsque l’état de chargement groupé change. La valeur est true tant qu’un élément monté est encore en cours de chargement.
Méthodes
Appelez-les sur le handle Tracking obtenu viawhop.tracking.create({ … }) ou useTracking().
update
Fusionne de nouvelles options de handle dans chaque élément monté. Avec React, modifiez plutôt les props du namespace.
Paramètres
destroy
Détruit chaque élément et sous-contrôleur créé par ce handle, supprime le frame du contrôleur et libère ses abonnements. Vous pouvez l’appeler plusieurs fois, mais un handle détruit refuse tout autre appel — créez un nouveau handle pour recommencer. React supprime le groupe automatiquement lorsque le provider est démonté.
Éléments
Les éléments montés par ce groupe. Chacun a sa propre page :PeopleElement
Toutes les personnes vues par le compte — visiteurs et clients identifiés à partir de l’activité du pixel, avec leur source, leurs dépenses et leurs compteurs d’activité. Recherchez, filtrez par source, événement, zone géographique ou appareil, triez n’importe quelle colonne et parcourez les pages. Un clic sur une ligne suit
links.person lorsque le handle le configure, et vous est sinon renvoyé sous forme de personOpened.EventsElement
Chaque événement mesuré par le compte — pages vues, leads, achats et événements pixel personnalisés — sous forme de flux brut et filtrable. Les lignes derrière chaque métrique : filtrez par événement, source, zone géographique ou appareil sur la période du handle, ou recherchez l’identifiant d’une personne pour lire tout son parcours. Une cellule de personne suit
links.person lorsque le handle le configure, et vous est sinon renvoyée sous forme de personOpened.PersonElement
Tout ce que le compte sait d’une personne : qui elle est, d’où elle vient, ce qu’elle a dépensé et chaque événement qu’elle a effectué, dans l’ordre. La vue vers laquelle mène un clic sur une personne : montez-la sur la page vers laquelle pointe
links.person, ou présentez-la par-dessus votre propre page lorsque people ou events déclenchent personOpened. identifier accepte n’importe quel identifiant sous lequel une personne a été vue, de sorte qu’un payload personOpened est résolu ici tel quel.
