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 Reporting, dans Ads. 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
Ce que trace le graphique — spend, impressions, clicks ou une conversion. Le sélecteur modifie cette valeur ; définissez-la pour ouvrir sur autre chose. Pour conversions, conversion_value et cost_per_conversion, nommez la conversion dans metricEvent. Par défaut : "spend".L’une des valeurs "funnel", "spend", "impressions", "clicks", "cost_per_1k_impressions", "cost_per_click", "conversions", "conversion_value" ou "cost_per_conversion".
string
La conversion à laquelle metric fait référence lorsqu’il s’agit d’une métrique par conversion — payment.completed, pixel.lead ou un événement personnalisé nommé par le compte. Ignoré par toutes les autres métriques. Par défaut : "".

Événements

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

onMetricChanged

Le visiteur a choisi un autre résultat à tracer. metric est ce qui est tracé ; event nomme la conversion concernée, et n’est présent que pour conversions, conversion_value et cost_per_conversion — c’est le compte qui décide de leur nom, il s’agit donc d’une chaîne plutôt que d’une valeur d’enum. Reproduisez-le dans votre propre URL et renvoyez-le comme metric/metricEvent si vous voulez que le choix survive à un rechargement ; l’élément le conserve de toute façon pendant toute la durée du montage.
object

onTimezoneChanged

Le visiteur a changé le fuseau horaire dans lequel les chiffres sont rapportés : le choix qu’il a fait ET le fuseau IANA correspondant. Le choix est la moitié qui survit à un rechargement — conservez-le et renvoyez-le comme timezone, ce que fait le tableau de bord Whop avec sa propre copie ; l’élément le conserve de toute façon pendant toute la durée du montage. resolved est fourni pour qu’un hôte puisse étiqueter ses propres chiffres sans refaire la recherche de la préférence du compte, et correspond au fuseau du visiteur lorsque le compte n’en a défini aucun.
object

onPeriodChanged

Le visiteur a modifié la période de reporting : la période choisie ET la plage correspondante, sous forme d’instants ISO 8601. Les dates sont fournies résolues, car un nom de période seul vous obligerait à refaire les calculs de limites de jour et de fuseau horaire du compte pour l’exploiter ; la période est également fournie, car elle seule survit à un rechargement en tant que période GLISSANTE — des dates stockées la figeraient. Chaque surface du même handle a déjà suivi ce changement.
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<ChartElementProps>
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.