Skip to main content
Denne side dokumenterer @whop/elements@1.10.0 og @whop/elements-react@1.10.0.
Siden v1.0.0.

Playground

Sæt elementerne sammen med eksempeldata. Betjen kontrollerne, tilføj og arrangér elementer, og se events blive udløst live:

Indstillinger

Angiv disse til whop.dashboard.create({ … }) eller som props på <Dashboard> i React.
string
Et afgrænset token, som alle flader under dette handle læser med. Udsted ét token til hele handlet på din server med POST /api/v1/access_tokens, og sæt et nyt med update({ accessToken }), før det udløber. Læsning af betalinger kræver payment:basic:read; køber-e-mails kræver desuden member:email:read, kunderejsen member:basic:read, sporingskolonnen shipment:basic:read, og produkt- og plannavnene på en betaling access_pass:basic:read og plan:basic:read. Bannerne kræver payout:account:read, og start af verificering fra handlingslinjen identity:write. Udelades det, bærer læsningerne seerens egen session, som kun svarer ved samme origin.
string
påkrævet
Konto- eller bruger-ID, hvis poster disse flader læser. Konto-ID’er har præfikset biz_; bruger-ID’er har præfikset user_, kan kun læse seerens egne udestående handlinger og har ingen betalinger.
Appearance
Visuel tilpasning af denne gruppes elementer. Tilsidesætter den globale WhopElements({ appearance }). Ændr den live med update({ appearance }).
WhopElementsLocale
Sprog for UI-teksten i denne gruppes elementer. Sæt den til et af appens indbyggede sprog for at tilsidesætte den globale konfiguration. Enhver anden værdi falder tilbage til standardsproget.

Events

Angiv callbacks i create-indstillingerne eller som React-props.

onLoadingChange

Kører, når den samlede indlæsningstilstand ændres. Værdien er true, så længe et monteret element stadig indlæses.
boolean

Metoder

Kald disse på Dashboard-handlet fra whop.dashboard.create({ … }) eller useDashboard().

update

Fletter nye handle-indstillinger ind i alle monterede elementer. I React ændrer du i stedet namespace-props. Parametre
Partial<DashboardOptions>
påkrævet

destroy

Ødelægger alle elementer og sub-controllere, som dette handle har oprettet, fjerner controller-framen og frigiver dens abonnementer. Du kan kalde den mere end én gang, men et ødelagt handle afviser alle andre kald — opret et nyt handle for at starte forfra. React fjerner gruppen automatisk, når provideren afmonteres.

Elementer

De elementer, som denne gruppe monterer. Hvert element har sin egen side:

RequiredActionsElement

Bannerne med udestående handlinger fra Whops saldo-dashboard — identitetsverificering, indbetalinger, skat og resten — i samme rækkefølge, som API’et returnerer dem. En konto uden noget udestående renderer slet intet, så elementet kan stå permanent i et layout. Teksterne kommer fra API’et. Et tryk på Verify starter en hostet identitetssession og navigerer dertil; Add money rapporterer depositRequested og bliver, hvor den er, så hosten monterer sit eget indbetalingsflow — for eksempel wallet-controllerens deposit-element; alle andre knapper følger handlingens eget link. Læser med Dashboard-handlets accessToken, som kræver payout:account:read plus identity:write for at starte verificering. En mislykket læsning renderer intet frem for en fejl — et banner bør aldrig blive det mest larmende på en andens side.

VerificationElement

Et banner, der beder kontohaveren om at verificere sin identitet, og som kun vises, mens verificeringen er udestående — en konto, der allerede er verificeret, renderer slet intet, så elementet kan stå permanent i et layout. Overskriften og statusbeskederne kommer fra API’et, med en kortere beskrivelse, når kontohaveren inviteres til at starte verificering, så de følger kontoens faktiske tilstand: en konto, der ikke er startet, inviteres til at låse op for kort og udbetalinger, en konto under gennemgang vises som afventende, og en mislykket eller markeret konto siger det. Et tryk på knappen rapporterer verificationRequested og bliver, hvor den er, så hosten monterer sin egen verificering — for eksempel verifications-controllerens kyc-element. Læser med Dashboard-handlets accessToken, som kræver payout:account:read. En mislykket læsning renderer intet frem for en fejl — en påmindelse bør aldrig blive det mest larmende på siden.

PaymentsTableElement

Dashboardets betalingstabel med statuskort, søgning, filtre, sortering, rækkevalg, CSV-eksport, kolonneindstillinger og paginering. Læser alle betalingssider for at beregne fuldstændige antal og filtrere lokalt; beregnet til konti med beskedne betalingshistorikker. Kundedetaljer og refusioner overdrages til din applikation via events.

PaymentDetailElement

En betalingsdetaljeside med dashboardets opdeling, aktivitet, kunde, detaljer og kunderejse. Hver sektion kan skjules. Læser payment:basic:read; kundens e-mail kræver member:email:read, og kunderejsen kræver member:basic:read. Handlings-events lader din applikation bekræfte og godkende ændringer; dette element refunderer, genforsøger eller annullerer aldrig selv en betaling.