Skip to main content
Esta página documenta @whop/elements@1.10.0 y @whop/elements-react@1.10.0.
Desde v1.0.0.

Playground

Combina los elementos con datos de ejemplo. Usa los controles, añade y organiza elementos, y observa cómo se disparan los eventos en vivo:

Opciones

Pásalas a whop.dashboard.create({ … }), o como props de <Dashboard> en React.
string
Un token con alcance limitado con el que leen todas las superficies de este handle. Genera un token para todo el handle en tu servidor con POST /api/v1/access_tokens y establece uno nuevo con update({ accessToken }) antes de que caduque. Leer pagos necesita payment:basic:read; además, los correos electrónicos de los compradores necesitan member:email:read, el recorrido del cliente member:basic:read, la columna de seguimiento shipment:basic:read, y los nombres del producto y del plan de un pago access_pass:basic:read y plan:basic:read. Los banners necesitan payout:account:read, e iniciar la verificación desde la barra de acciones identity:write. Si se omite, las lecturas usan la propia sesión del visitante, que solo responde en el mismo origen.
string
requerido
ID de la cuenta o del usuario cuyos registros leen estas superficies. Los IDs de cuenta tienen el prefijo biz_; los IDs de usuario tienen el prefijo user_, solo pueden leer las acciones pendientes del propio visitante y no tienen pagos.
Appearance
Personalización visual para los elementos de este grupo. Anula el WhopElements({ appearance }) global. Cámbiala en vivo con update({ appearance }).
WhopElementsLocale
Configuración regional para el texto de la interfaz de los elementos de este grupo. Establécela en una de las configuraciones regionales incluidas en la app para anular la configuración global. Cualquier otro valor recurre a la configuración regional predeterminada.

Eventos

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

onLoadingChange

Se ejecuta cuando cambia el estado de carga agrupado. El valor es true mientras algún elemento montado todavía se está cargando.
boolean

Métodos

Llámalos en el handle de Dashboard obtenido de whop.dashboard.create({ … }) o useDashboard().

update

Combina nuevas opciones del handle en todos los elementos montados. En React, cambia las props del namespace en su lugar. Parámetros
Partial<DashboardOptions>
requerido

destroy

Destruye todos los elementos y subcontroladores que creó este handle, elimina el frame del controlador y libera sus suscripciones. Puedes llamarlo más de una vez, pero un handle destruido rechaza cualquier otra llamada: crea un nuevo handle para empezar de nuevo. React elimina el grupo automáticamente cuando el provider se desmonta.

Elementos

Los elementos que monta este grupo. Cada uno tiene su propia página:

RequiredActionsElement

Los banners de acciones pendientes del panel de saldo de Whop (verificación de identidad, depósitos, impuestos y el resto) en el mismo orden en que los devuelve la API. Una cuenta sin nada pendiente no renderiza nada en absoluto, por lo que el elemento puede permanecer fijo en un diseño. Los textos provienen de la API. Pulsar Verify inicia una sesión de identidad alojada y se dirige a ella; Add money informa de depositRequested y se queda donde está, para que el host monte su propio flujo de depósito (por ejemplo, el elemento deposit del controlador wallet); todos los demás botones siguen el propio enlace de la acción. Lee con el accessToken del handle de Dashboard, que necesita payout:account:read, además de identity:write para iniciar la verificación. Una lectura fallida no renderiza nada en lugar de un error: un banner nunca debería convertirse en lo más llamativo de la página de otra persona.

VerificationElement

Un banner que pide al titular de la cuenta que verifique su identidad, mostrado solo mientras la verificación está pendiente: una cuenta que ya se ha verificado no renderiza nada en absoluto, por lo que el elemento puede permanecer fijo en un diseño. El titular y los mensajes de estado provienen de la API, con una descripción más corta al invitar al titular de la cuenta a iniciar la verificación, de modo que reflejan el estado real de la cuenta: a una cuenta que no ha empezado se le invita a desbloquear tarjetas y pagos, una en revisión aparece como pendiente, y una fallida o marcada lo indica. Pulsar el botón informa de verificationRequested y se queda donde está, para que el host monte su propia verificación (por ejemplo, el elemento kyc del controlador verifications). Lee con el accessToken del handle de Dashboard, que necesita payout:account:read. Una lectura fallida no renderiza nada en lugar de un error: un recordatorio nunca debería convertirse en lo más llamativo de la página.

PaymentsTableElement

La tabla de pagos del panel con tarjetas de estado, búsqueda, filtros, ordenación, selección de filas, exportación a CSV, configuración de columnas y paginación. Lee todas las páginas de pagos para calcular recuentos completos y filtrar localmente; pensada para cuentas con historiales de pagos modestos. Los detalles del cliente y los reembolsos se pasan a tu aplicación mediante eventos.

PaymentDetailElement

Una página de detalle del pago con el desglose del panel, la actividad, el cliente, los detalles y el recorrido del cliente. Cada sección se puede ocultar. Lee payment:basic:read; el correo electrónico del cliente necesita member:email:read y el recorrido necesita member:basic:read. Los eventos de acción permiten que tu aplicación confirme y autorice cambios; este elemento nunca reembolsa, reintenta ni anula un pago por sí mismo.