Esta página documenta
@whop/elements@1.10.0 y @whop/elements-react@1.10.0.v1.0.0.
Se monta dentro de Dashboard. accountId y accessToken provienen de ahí. Pasa las props y los callbacks a través de las opciones de creación o de las props de React. Conserva el handle creado, o la ref de React, para llamar a refresh().
Datos de ejemplo. Abre el Playground.
Props
Muestra el botón Refund de la parte superior derecha y el menú de acciones. Las acciones que modifican datos requieren controladores de eventos. Por defecto es
true.Muestra el nombre, el nombre de usuario, el correo electrónico, el teléfono y la dirección de facturación del cliente cuando está permitido. Por defecto es
true.Muestra el producto, el plan, el método de pago, los metadatos del pago y los identificadores del pago. Por defecto es
true.Muestra el recorrido del cliente. Lee la API de Events con alcance de cuenta solo mientras está visible. Por defecto es
true.Eventos
Pasa los callbacks en las opciones de creación o como props de React.onRefundRequested
Confirma y autoriza un reembolso en tu aplicación. Solo se habilita cuando el pago es reembolsable y se proporciona un controlador.
onRetryRequested
Confirma y autoriza otro intento de cobro en tu aplicación.
onVoidRequested
Confirma y autoriza la anulación de este pago en tu aplicación.
onInvoiceRequested
Consulta o descarga la factura en tu aplicación.
onCustomerSelected
Abre el cliente en tu aplicación.
onMessageRequested
Abre tu interfaz de mensajería con clientes.
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.
refresh
Recarga el pago y sus comisiones después de que se complete una acción del host.
Devuelve Promise<void>
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 <Dashboard>. Establécelo globalmente con WhopElements({ appearance }).
