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 abre como un modal desde Balances, en Wallet: wallet.create('balances').createOverlay('settlement'). Pasa las props y los callbacks en las opciones de creación.
Este elemento es solo modal. Ábrelo con createOverlay; no tiene montaje en línea.

Datos de ejemplo. Abre el Playground.

Props

boolean
Si está desactivado, el elemento no realiza ninguna lectura y renderiza un estado de detalles vacío. Por defecto es true.
boolean
Muestra los importes en el activo seleccionado. Desactívalo para valorar los detalles en USD. Por defecto es true.

Eventos

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

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

Vuelve a obtener los detalles de la liquidación y de la reserva. 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<SettlementElementProps>
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 <Wallet>. Establécelo globalmente con WhopElements({ appearance }).