Skip to main content
Cette page documente @whop/elements@1.10.0 et @whop/elements-react@1.10.0.
Depuis v1.0.0.
Se monte à l’intérieur de Wallet. accountId et accessToken en proviennent. Transmettez les props et les callbacks via les options de création ou les props React. Conservez le handle créé, ou la ref React, pour appeler refresh() et setDateRange().
Se monte n’importe où dans votre hiérarchie de vues. Prend un accountId et charge ses propres données ; transmettez aussi une closure et vous recevrez la ligne touchée par l’utilisateur.

Données d’exemple. Ouvrir le Playground.

Props

string
N’affiche que l’activité dans cette devise. Sans elle, l’activité de toutes les devises est affichée.
string
Un jeton à portée limitée pour la lecture. Un compte nécessite company:balance:read, et un utilisateur user:balance:read. Générez-le sur votre serveur avec POST /api/v1/access_tokens. Sans lui, la lecture utilise la propre session de l’utilisateur, qui ne fonctionne qu’en same-origin.
number
Affiche au maximum ce nombre de lignes et arrête la pagination, pour un aperçu de l’activité récente. La liste gagne une commande See all activity qui signale seeAllRequested au lieu de naviguer.
boolean
Lorsqu’il est désactivé, les lignes de transactions par carte s’affichent inertes (ni clic, ni survol) au lieu de déclencher activitySelected. Utilisez-le lorsque vous savez que l’utilisateur n’est pas autorisé à voir ces détails. Par défaut : true.
string[]
Types d’activité sélectionnés lorsque l’élément est monté ou que son compte change. L’utilisateur peut les modifier avec les filtres intégrés. Par défaut : [].
boolean
Masque les puces de filtre, pour une liste compacte que l’utilisateur ne filtre pas. Par défaut : false.

Événements

Transmettez les callbacks dans les options de création ou dans les props React.

onActivitySelected

Une ligne a été cliquée. Ouvrez votre propre vue ou route de détail pour celle-ci ; l’élément ne navigue jamais.
object

onActivityHovered

Le pointeur est entré dans une ligne, ou en est sorti (null). Pointez au même moment un élément qui vous est propre, par exemple en marquant la ligne sur un graphique de solde.
object | null

onSeeAllRequested

L’utilisateur a appuyé sur See all activity dans une liste maxItems. Ouvrez votre propre écran d’activité complète ; l’élément ne navigue jamais.

onDateRangeChanged

L’utilisateur a modifié le filtre de date via les puces de filtre plutôt que via setDateRange. Effacez toute sélection de plage qui vous est propre, comme une sélection (brush) sur un graphique, qui ne correspond plus.
object

onLoaderStart

S’exécute après le premier affichage du squelette de chargement et avant onReady.

onReady

S’exécute après le premier affichage complet de l’élément.

onError

S’exécute lorsque l’élément ne parvient pas à se charger ou plante. L’affichage de repli reste visible. Utilisez code pour une gestion programmatique. sourceKey identifie une source d’état hôte en échec.
object

Méthodes

Appelez-les sur le handle renvoyé par create, ou via une ref React.

refresh

Récupère à nouveau l’activité du compte à partir de la première page. Appelez-la après une mutation effectuée ailleurs (un dépôt, un envoi) pour que la liste la reflète sans attendre l’expiration du cache.Renvoie Promise<void>

setDateRange

Définit le filtre de date depuis l’extérieur de l’élément, par exemple en reliant une sélection (brush) d’un graphique à la liste. Transmettez null pour l’effacer.Paramètres
ActivityDateRangeOverride | null
requis
Renvoie Promise<void>

mount

Monte l’élément dans target et démarre le chargement. Les composants React se montent eux-mêmes.Paramètres
string | HTMLElement
requis

destroy

Supprime l’élément et libère son frame et ses abonnements. Vous pouvez l’appeler plusieurs fois. React supprime l’élément automatiquement.

update

Fusionne de nouvelles props dans l’élément monté. Avec React, modifiez plutôt les props du composant.Paramètres
Partial<ActivityElementProps>
requis

Style

Stylisez ces parties via appearance.classes. Utilisez le camel case ou le kebab case pour les noms de propriétés et incluez les unités. Les feuilles de style de la page ne peuvent pas atteindre le frame de l’élément. Le framework valide chaque déclaration avant de l’injecter.
Avec React, transmettez appearance à <Wallet>. Définissez-la globalement avec WhopElements({ appearance }).

Paramètres

String
requis
Le registre à lister. Utilisez un ID de compte préfixé par biz_ ou un ID d’utilisateur préfixé par user_. Les deux fonctionnent directement, car le flux lit l’ID sans résoudre d’abord un registre.
Bool
Affiche le titre intégré « Activity ». Par défaut : true. Désactivez-le lorsque votre écran en a déjà un.
((WalletActivity) -> Void)?
Appelée avec la ligne touchée par l’utilisateur. La vue ne navigue jamais : redirigez donc vers votre propre écran de détail.

WalletActivity

Ce que renvoie une sélection :
  • id: String : stable pour chaque ligne
  • title: String / subtitle: String : les deux lignes de la ligne
  • amount: Decimal : signé, négatif pour l’argent sortant
  • currencyCode: String
  • postedAt: Date
  • isIncoming: Bool

États

Affiche une liste squelette pendant le chargement de la première page, No activity found lorsque le registre n’a aucun mouvement, et le message d’échec avec un bouton Try again lorsque la lecture échoue. Si une page ultérieure échoue, les lignes déjà chargées restent à l’écran et un Try again apparaît en bas.

Bon à savoir

  • Placez-le dans un conteneur défilant. Le flux est un LazyVStack qui se pagine lorsque sa dernière ligne apparaît : en dehors d’une ScrollView, il affiche la première page et n’en charge jamais d’autre.
  • Accepte directement les tags biz_… et user_… : contrairement aux autres vues du wallet, il n’a donc jamais à résoudre d’abord un registre.
Appelez WhopSDK.configure(tokenProvider:) une seule fois au lancement. Les vues attendent le jeton. Consultez Premiers pas. Appliquez un thème avec .whopTheme(_:).