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 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

boolean
Muestra el menú de acciones del encabezado, el botón Export y el botón de configuración de la tabla. Por defecto es true.
boolean
Muestra el menú de acciones de tres puntos en cada fila de pago. Por defecto es true.
boolean
Muestra los seis recuadros de estado de pago encima de los filtros. Por defecto es true.
boolean
Muestra la columna y el filtro de seguimiento para cuentas de productos físicos. Los datos de seguimiento requieren shipment:basic:read. Por defecto es true.

Eventos

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

onPaymentSelected

Abre los detalles del pago en tu aplicación.
object

onInvoiceRequested

Abre la factura en tu aplicación.
object

onUserSelected

Abre el comprador en tu aplicación.
object

onRefundRequested

El visitante solicitó un reembolso. Tu aplicación debe confirmarlo y autorizarlo del lado del servidor. Los controles de reembolso solo se habilitan cuando se proporciona este callback.
object

onSettingsRequested

Abre la configuración de pagos de la cuenta en tu aplicación.

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.

refresh

Recarga los pagos después de un reembolso u otro cambio. Devuelve Promise<void>

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<PaymentsTableElementProps>
requerido

Estilos

Aplica estilo a estas partes mediante appearance.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.
En React, pasa appearance a <Dashboard>. Establécelo globalmente con WhopElements({ appearance }).