Esta página documenta
@whop/elements@1.10.0 y @whop/elements-react@1.10.0.v1.0.0.
Se monta dentro de Websites. Pasa las props y los callbacks a través de las opciones de creación o de las props de React.
Puedes montar este elemento en línea (
create) o abrirlo como overlay modal (createOverlay).Datos de ejemplo. Abre el Playground.
Props
ID de la cuenta, con el prefijo
biz_, a la que pertenece este pixel. Obligatorio; el fragmento, los escaneos y las invitaciones se ejecutan sobre ella. Por defecto es "".Un token con alcance limitado para los escaneos y la invitación de desarrollador. Los escaneos necesitan
company:basic:read; “Invitar a un desarrollador” necesita además authorized_user:create, y los preajustes de eventos leen la cuenta con company:balance:read (sin él, el asistente sigue funcionando con una lista de preajustes genérica). Cuando no se pasa destinationUrl, el campo de URL vacío también sugiere páginas a partir de los anuncios y el tráfico del pixel de la cuenta; esas lecturas necesitan ad_campaign:basic:read y stats:read, y sin ellos el campo simplemente queda vacío. Genéralo en tu servidor con POST /api/v1/access_tokens y establece uno nuevo antes de que caduque. Otro elemento que abre este asistente dentro de sí mismo (como hace el campaign-creator de anuncios) ejecuta estas llamadas con su propio token, así que añade estos alcances a ese mismo token en lugar de generar un segundo: este elemento no tiene forma de leer una credencial que establezcas en otro lugar. Si se omite, las llamadas usan la propia sesión del usuario, que solo responde en el mismo origen.La página que se comprueba, escaneada al montar. Déjala en blanco y el asistente pedirá una. También es lo que habilita “Verificar en vivo” en el paso de eventos: ese botón guía al propietario de la cuenta por su propio embudo para detectar eventos que un escaneo del lado del servidor no puede ver, por lo que solo aparece cuando se conoce un destino, ya sea desde aquí o indicado en el asistente. Se lee una vez al iniciar, así que
update() no cambiará el destino a mitad del flujo: crea un montaje nuevo para otra página. Por defecto es "".Opcional. Un evento que debe dispararse en esa página (
lead, schedule, view_content, …); el paso de eventos se bloquea hasta que se detecta. Si no se establece, se ofrecen todos los eventos y ninguno es obligatorio. Los eventos que Whop registra en el servidor (purchase, subscribe, pruebas, pasos del checkout) se ignoran. Se lee una vez al iniciar. Por defecto es "".Una URL a la que redirige el destino, cuando el evento se dispara allí en su lugar. El propietario de la cuenta también puede establecer una en el asistente: escucha
redirectUrlChanged y devuélvela la próxima vez. Por defecto es "".Dónde se abre el asistente: en el paso de instalación, o directamente en
events cuando el pixel ya está instalado y solo falta el evento de conversión. Por defecto es "install".Abre en la pantalla de presentación “por qué un pixel”. Desactívalo cuando el propietario de la cuenta ya sepa por qué está aquí (por ejemplo, un flujo de campaña que lo envía a mitad del lanzamiento) y el asistente se abrirá directamente en el paso de instalación. Por defecto es
true.Ofrece la opción “Invitar a un desarrollador para instalarlo”. Ocúltala cuando las personas que usan tu integración no deban invitar a miembros al equipo de Whop que hay detrás. Por defecto es
true.Muestra la pantalla “tu pixel está activo” después de que una página supere la comprobación, que ofrece los eventos de conversión como siguiente paso. Desactívala cuando el propietario de la cuenta haya venido precisamente por los eventos: una comprobación correcta irá directamente a ellos en lugar de detenerse en una pantalla que tendría que saltarse. Por defecto es
true.Empieza por la comprobación de la página en lugar de las instrucciones de instalación: el campo de URL (y sus sugerencias) se sitúa arriba, las opciones de instalación se pliegan bajo un interruptor “¿Aún no has instalado el pixel?” y el encabezado dice “Verifica tu pixel”. Pensado para un propietario de cuenta que ya tiene un pixel y quiere averiguar por qué no se atribuye nada. Combínalo con
showIntro: false. Por defecto es false.Eventos
Pasa los callbacks en las opciones de creación o como props de React.onRedirectUrlChanged
El propietario de la cuenta estableció o borró una URL de redirección en el asistente. Guárdala y devuélvela como redirectUrl la próxima vez.
onScanned
Finalizó un escaneo del pixel. Se dispara para cada URL que comprueba el asistente, para que tu propia insignia de instalación pueda seguirlo. primary marca la página que se está configurando: el comprobador de embudos escanea cualquier otra cosa que indique el propietario de la cuenta, incluidos otros nombres de host, así que compruébalo antes de tratar un resultado como relativo a su sitio. No lo necesitas para mantener actualizada una tabla websites: montado bajo ese handle, un sitio que se ha demostrado activo ya obtiene su fila en espera.
onFinished
Se pulsó Listo. Vuelve a comprobar la página tú mismo: esto indica que el asistente terminó, no que se cumplan tus requisitos.
onUrlSubmitted
El propietario de la cuenta indicó la página que se debe comprobar desde dentro del asistente, escribiéndola a mano o eligiéndola entre las páginas sugeridas. Solo es posible cuando no se proporcionó un destino al montar.
onVerifyLaunched
Se pulsó “Verificar en vivo”. popupBlocked significa que el navegador rechazó la ventana del embudo, por lo que el recorrido nunca empezó.
onVerifyConnected
La página del embudo respondió al asistente: el pixel está cargado allí y el recorrido está en curso.
onVerdict
Terminó el recorrido de verificación en vivo. ok significa que no hay carencias de seguimiento; de lo contrario, gaps contiene los códigos de las carencias que encontró el recorrido.
onEventVerified
El propietario de la cuenta recorrió su embudo con “Verificar en vivo” y este evento se disparó: prueba de que está conectado donde un escaneo del lado del servidor no puede llegar.
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ó.
Métodos
Llámalos en el handle que devuelvecreate, 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
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
Estilos
Aplica estilo a estas partes medianteappearance.classes. Usa camel case o kebab case para los nombres de las propiedades e incluye las unidades. Las hojas de estilo de la página no pueden llegar al frame del elemento. El framework valida cada declaración antes de inyectarla.
appearance a <Websites>. Establécelo globalmente con WhopElements({ appearance }).
