Skip to main content
Denne side dokumenterer @whop/elements@1.10.0 og @whop/elements-react@1.10.0.
Siden v1.0.0.
Monteres inde i Wallet. accountId og accessToken kommer derfra. Angiv props og callbacks via create-indstillingerne eller som React-props. Behold det oprettede handle eller React-ref for at kalde refresh() og setDateRange().
Monteres hvor som helst i dit visningshierarki. Tager et accountId og indlæser sine egne data; angiv også en closure, så får du den række, seeren trykkede på.

Eksempeldata. Åbn Playground.

Props

string
Viser kun aktivitet i denne valuta. Uden den vises aktivitet i alle valutaer.
string
Et afgrænset token til læsningen. En konto kræver company:balance:read, og en bruger kræver user:balance:read. Udsted det på din server med POST /api/v1/access_tokens. Uden det bruger læsningen seerens egen session, som kun virker på same-origin.
number
Viser højst så mange rækker og stopper sideindlæsningen, til en forhåndsvisning af nylig aktivitet. Listen får en See all activity-kontrol, der rapporterer seeAllRequested i stedet for at navigere.
boolean
Når den er slået fra, renderes korttransaktionsrækker inaktive (intet klik, ingen hover) i stedet for at udløse activitySelected. Brug den, når du ved, at seeren ikke må se de detaljer. Standard er true.
string[]
Aktivitetstyper, der er valgt, når elementet monteres, eller dets konto ændres. Seeren kan ændre dem med de indbyggede filtre. Standard er [].
boolean
Skjuler filterchipsene, til en kompakt liste, som seeren ikke filtrerer. Standard er false.

Hændelser

Send callbacks i create-indstillingerne eller React-props.

onActivitySelected

Der blev klikket på en række. Åbn din egen detaljevisning eller rute til den; elementet navigerer aldrig.
object

onActivityHovered

Markøren kom ind over en række eller forlod en (null). Peg på noget af dit eget i samme øjeblik, f.eks. ved at markere rækken på et saldodiagram.
object | null

onSeeAllRequested

Seeren trykkede på See all activity på en maxItems-liste. Åbn din egen fulde aktivitetsskærm; elementet navigerer aldrig.

onDateRangeChanged

Seeren ændrede datofilteret via filterchipsene i stedet for via setDateRange. Ryd ethvert af dine egne intervalvalg, f.eks. en diagrammarkering, der ikke længere passer.
object

onLoaderStart

Kører, efter at indlæsningsskelettet først er tegnet, og før onReady.

onReady

Kører efter elementets første fuldstændige rendering.

onError

Kører, når elementet ikke kan indlæses eller går ned. Fallback-visningen forbliver synlig. Brug code til programmatisk håndtering. sourceKey identificerer en host-state-kilde, der fejlede.
object

Metoder

Kald disse på det handle, som create returnerer, eller via en React-ref.

refresh

Henter kontoens aktivitet igen fra første side. Kald den efter en ændring foretaget et andet sted (en indbetaling, en overførsel), så listen afspejler den uden at vente på, at cachen udløber.Returnerer Promise<void>

setDateRange

Sætter datofilteret uden for elementet, for eksempel ved at koble en diagrammarkering til listen. Send null for at rydde det.Parametre
ActivityDateRangeOverride | null
påkrævet
Returnerer Promise<void>

mount

Monterer elementet i target og begynder indlæsningen. React-komponenter monterer sig selv.Parametre
string | HTMLElement
påkrævet

destroy

Fjerner elementet og frigiver dets frame og abonnementer. Du kan kalde den mere end én gang. React fjerner elementet automatisk.

update

Fletter nye props ind i det monterede element. I React ændrer du i stedet komponentens props.Parametre
Partial<ActivityElementProps>
påkrævet

Styling

Style disse dele via appearance.classes. Brug camel case eller kebab case til egenskabsnavne, og medtag enheder. Sidens stylesheets kan ikke nå elementets frame. Frameworket validerer hver deklaration, før den indsættes.
I React sender du appearance til <Wallet>. Sæt det globalt med WhopElements({ appearance }).

Parametre

String
påkrævet
Hvis hovedbog der skal vises. Brug et konto-ID med præfikset biz_ eller et bruger-ID med præfikset user_. Begge virker direkte, fordi feedet læser ID’et uden først at opløse en hovedbog.
Bool
Viser den indbyggede “Activity”-overskrift. Standard er true. Slå den fra, når din skærm allerede har en.
((WalletActivity) -> Void)?
Kaldes med den række, seeren trykkede på. Visningen navigerer aldrig, så send videre til din egen detaljeskærm.

WalletActivity

Hvad et valg returnerer:
  • id: String: stabil pr. række
  • title: String / subtitle: String: rækkens to linjer
  • amount: Decimal: med fortegn, negativt for penge ud
  • currencyCode: String
  • postedAt: Date
  • isIncoming: Bool

Tilstande

Viser en skeletliste, mens den første side indlæses, No activity found, når hovedbogen ikke har nogen bevægelser, og fejlbeskeden med en Try again-knap, når læsningen mislykkes. Hvis en senere side mislykkes, bliver de allerede indlæste rækker på skærmen, og en Try again vises nederst.

Godt at vide

  • Giv den en scroll-container. Feedet er en LazyVStack og indlæser næste side, når dets sidste række vises, så uden for en ScrollView renderer den første side og indlæser aldrig flere.
  • Tager biz_…- og user_…-tags direkte, så i modsætning til de andre wallet-visninger skal den aldrig først opløse en hovedbog.
Kald WhopSDK.configure(tokenProvider:) én gang ved opstart. Visninger venter på tokenet. Se Kom godt i gang. Anvend et tema med .whopTheme(_:).