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 Balances, en Wallet. accountId y currency provienen de Wallet. Pasa las props y los callbacks a través de las opciones de creación o de las props de React.
Se monta en cualquier lugar de tu jerarquía de vistas. Recibe un accountId y carga sus propios datos; range elige el intervalo de tiempo con el que se abre. La raíz es un VStack, por lo que se ajusta a su contenido y ocupa el ancho que le des.

Datos de ejemplo. Abre el Playground.

Props

string
Un token con alcance limitado para las lecturas. Una cuenta necesita company:balance:read para el total y stats:read para el gráfico; el saldo propio de un usuario necesita user:balance:read. Genéralo en tu servidor con POST /api/v1/access_tokens y establece uno nuevo antes de que caduque. Sin él, las lecturas usan la propia sesión del visitante, que solo funciona en el mismo origen. Por defecto es "".
"1D" | "1W" | "1M" | "1Y" | "ALL"
El intervalo de tiempo con el que se abre. Los botones lo cambian a partir de ahí, o vuelve a establecer esta prop para controlarlo tú mismo. Por defecto es "1M".
string
Cuándo se abrió la cuenta, como marca de tiempo ISO 8601. ALL empieza aquí en lugar de en su valor predeterminado de cinco años, para que una cuenta más antigua conserve todo su historial. Por defecto es "".
string
Añade el nombre de la cuenta a la etiqueta: Total balance · Acme normalmente, y Acme balance on Jul 9 mientras el visitante lee un punto. Sin él, la etiqueta es solo Total balance. Por defecto es "".
object | null
El intervalo seleccionado en el gráfico, como marcas de tiempo ISO 8601. Establécelo para controlar la selección tú mismo, o null para borrar la que hizo el visitante. Devuelve lo que informa rangeBrushed, y al borrar un filtro en otra parte de tu página también se borra la selección aquí. Por defecto es null.
string
Un momento que marcar en el gráfico, como marca de tiempo ISO 8601: el punto al que apunta otra cosa de tu página, como la fila bajo el puntero en una lista de actividad. Se comporta como si el visitante pasara el puntero por ese punto, y se ignora cuando queda fuera de la ventana en pantalla o cuando el visitante está leyendo el gráfico. Por defecto es "".
boolean
Para un usuario, suma su propio dinero más el de cada cuenta de la que es propietario, en lugar de solo su propio dinero. Se ignora para una cuenta, que ya es una sola cuenta. Por defecto es false.
boolean
Oculta el total y su variación, dejando el gráfico y los botones del intervalo. Por defecto es false.
boolean
Oculta el gráfico, dejando el total y los botones del intervalo. Por defecto es false.
number
La altura a la que se dibuja el gráfico, en píxeles. Por defecto es 210.

Eventos

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

onRangeChanged

El intervalo de tiempo visible cambió. Replícalo si otra cosa de tu página lee el mismo periodo.
object

onRangeBrushed

El visitante arrastró sobre el gráfico para seleccionar un intervalo, o borró la selección (null). Proporciona marcas de tiempo ISO 8601 más el intervalo en el que se leyeron, para que puedas filtrar tus propias vistas, como una lista de actividad o una tabla, al mismo periodo.
object | null

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.

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<BalanceElementProps>
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 }).

Parámetros

String
requerido
La cuenta cuyo dinero lee la vista. Usa un ID de cuenta con el prefijo biz_. Un ID de usuario con el prefijo user_ lee el saldo propio del visitante y necesita autenticación del visitante (WhopSDK.configureWithOAuth), no un token de cuenta.
String
La moneda en la que se muestran el total y el gráfico. Por defecto es "usd".
WalletBalanceRange
El intervalo de tiempo con el que se abre el gráfico: .oneDay, .oneWeek, .oneMonth, .oneYear, .all. Por defecto es .oneMonth, y el visitante puede cambiarlo con el selector.

Estados

Muestra un gráfico de marcador de posición mientras se cargan los datos. Si el periodo de comparación falla, la variación se oculta en lugar de estimarse, de modo que cualquier cifra en pantalla es una que se midió realmente. Un ID de cuenta que no se puede resolver muestra Couldn't load this account. en lugar de quedarse cargando.

Información útil

  • Mantén pulsado y arrastra sobre el gráfico para recorrerlo. El titular sigue el punto bajo tu dedo y vuelve al total cuando lo sueltas.
  • El historial del saldo solo está disponible para los ID de cuenta con el prefijo biz_, así que una cuenta personal con el prefijo user_ renderiza el total sin gráfico.
  • Se combina con ListElement, que desglosa el mismo total en activos individuales.
Llama a WhopSDK.configure(tokenProvider:) una vez al iniciar. Las vistas esperan al token. Consulta Primeros pasos. Aplica un tema con .whopTheme(_:).