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 openHoldingOnSelect 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; pasa también un closure y las filas se vuelven pulsables. 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 la lectura. Una cuenta necesita company:balance:read; los activos de un usuario o su lista de cuentas propias necesitan user:balance:read. Genéralo en tu servidor con POST /api/v1/access_tokens. Sin él, la lectura usa la propia sesión del visitante, que solo funciona en el mismo origen.
boolean
Para la cuenta user_… de un usuario, lista su saldo personal seguido de cada cuenta propia que devuelve el backend, en lugar de listar los activos dentro de su cuenta personal. Se ignora para una cuenta. Por defecto es false.
boolean
Muestra cada fila en la moneda en la que se mantiene (€4.20, 0.00000009 cbBTC) y coloca el valor en dólares debajo. Desactivado por defecto, así que todas las filas están en dólares. Por defecto es false.
boolean
Mantiene el valor en dólares debajo de un activo mostrado en su propia moneda. Solo se aplica cuando showSourceCurrency está activado. Por defecto es true.
boolean
Mantiene la fila personal cuando includeOwnedAccounts está activado. Desactívalo si tu app no tiene ninguna cuenta personal que abrir. Por defecto es true.
number
Muestra como máximo este número de filas de activos, de mayor a menor. Cuando hay más, la lista incorpora un control Show all balances que despliega el resto en el mismo lugar. Sin él, se listan todos los activos.

Eventos

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

onBalanceSelected

Se hizo clic en una fila de activo, con includeOwnedAccounts desactivado. holding es usd para la fila combinada en dólares; en caso contrario, el símbolo del activo (cbBTC, EUR), y kind te indica cuál de los tres es, para que puedas enrutar sin tener que clasificar los símbolos tú mismo. El elemento nunca navega.
object

onAccountSelected

Se hizo clic en una fila de cuenta, con includeOwnedAccounts activado. accountId es la etiqueta personal user_… o una etiqueta biz_… de una cuenta propia, y kind te permite enrutar sin inspeccionarla. El elemento nunca navega.
object

onCreditsSelected

Se hizo clic en la fila de créditos de Whop. Los créditos solo se pueden gastar en Whop y nunca se pueden retirar, por lo que quedan fuera de todas las filas de activos; el host abre su propia pantalla de créditos. El elemento nunca navega.

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<ListElementProps>
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.
((WalletBalance) -> Void)?
Se llama con la fila que pulsó el visitante. Si lo omites, las filas se renderizan sin chevrons y pulsarlas no hace nada.

WalletBalance

Lo que devuelve una selección:
  • id: String: estable por fila
  • symbol: String: USD, BTC, …
  • displayName: String: el nombre que se muestra en la fila
  • amountUsd: Decimal: el valor de la fila en dólares
  • isCrypto: Bool: un activo cripto en lugar de fiat

Estados

Muestra dos filas de marcador de posición mientras se cargan los saldos. Un ID de cuenta que no se puede resolver muestra Couldn't load this account. Si falla la propia lectura del saldo, la lista se renderiza vacía en lugar de mostrar un error.

Información útil

  • No se desplaza por sí sola, así que colócala en un ScrollView cuando comparta pantalla con otro contenido.
  • Se combina con BalanceElement, que muestra el total de la misma cuenta y cómo ha cambiado.
Llama a WhopSDK.configure(tokenProvider:) una vez al iniciar. Las vistas esperan al token. Consulta Primeros pasos. Aplica un tema con .whopTheme(_:).