Skip to main content
Esta página documenta @whop/elements@1.10.0 y @whop/elements-react@1.10.0.
Desde v1.0.0. Se monta dentro de Reporting, en Ads. Pasa las props y los callbacks a través de las opciones de creación o de las props de React.

Datos de ejemplo. Abre el Playground.

Props

string
Lo que representa el gráfico: spend, impressions, clicks o una conversión. El selector lo cambia; establécelo para que se abra en otra cosa. Para conversions, conversion_value y cost_per_conversion, indica la conversión en metricEvent. Por defecto es "spend".Uno de "funnel", "spend", "impressions", "clicks", "cost_per_1k_impressions", "cost_per_click", "conversions", "conversion_value" o "cost_per_conversion".
string
La conversión a la que se refiere metric cuando es una métrica por conversión: payment.completed, pixel.lead o un evento personalizado al que la propia cuenta pone nombre. Las demás métricas lo ignoran. Por defecto es "".

Eventos

Pasa los callbacks en las opciones de creación o como props de React.

onMetricChanged

El visitante eligió un resultado diferente para representar. metric es lo que se representa; event nombra la conversión a la que se refiere y solo está presente para conversions, conversion_value y cost_per_conversion: la cuenta decide cómo se llaman, así que es una cadena en lugar de un miembro de una enumeración. Refléjalo en tu propia URL y devuélvelo como metric/metricEvent si quieres que la elección sobreviva a una recarga; en cualquier caso, el elemento la conserva mientras está montado.
object

onTimezoneChanged

El visitante cambió la zona horaria en la que se muestran las cifras: la opción que eligió Y la zona IANA a la que se resuelve. La opción es la parte que sobrevive a una recarga: guárdala y devuélvela como timezone, que es lo que hace el panel de Whop con su propia copia; en cualquier caso, el elemento la conserva mientras está montado. resolved se incluye para que un host pueda etiquetar sus propias cifras sin repetir la consulta de la preferencia de la cuenta, y es la propia zona del visitante cuando la cuenta no ha establecido ninguna.
object

onPeriodChanged

El visitante cambió el periodo del informe: el periodo que eligió Y el intervalo al que se resuelve, como instantes ISO 8601. Las fechas llegan resueltas porque solo con el nombre del periodo tendrías que rehacer los cálculos de límites de día y de zona horaria de la cuenta para actuar sobre él; el periodo también se incluye porque solo él sobrevive a una recarga como periodo MÓVIL: unas fechas guardadas lo fijarían. Todas las superficies del mismo handle ya han seguido el cambio.
object

onLoaderStart

Se ejecuta después de que el esqueleto de carga se pinta por primera vez y antes de onReady.

onReady

Se ejecuta después del primer pintado completo del elemento.

onError

Se ejecuta cuando el elemento no se carga o falla. El contenido de respaldo permanece visible. Usa code para el manejo programático. sourceKey identifica una fuente de estado del host que falló.
object

Métodos

Llámalos en el handle que devuelve create, o a través de una ref de React.

mount

Monta el elemento en target y comienza a cargarlo. Los componentes de React se montan solos. Parámetros
string | HTMLElement
requerido

destroy

Elimina el elemento y libera su frame y sus suscripciones. Puedes llamarlo más de una vez. React elimina el elemento automáticamente.

update

Combina nuevas props en el elemento montado. En React, cambia las props del componente en su lugar. Parámetros
Partial<ChartElementProps>
requerido

Estilos

Este elemento no expone nombres de clase para estilos. Usa appearance (tema, color de acento, variables) para cambiar su estilo.