Skip to main content
Deze pagina documenteert @whop/elements@1.10.0 en @whop/elements-react@1.10.0.
Sinds v1.0.0.

Playground

Stel de elementen samen met voorbeeldgegevens. Bedien de besturingselementen, voeg elementen toe en schik ze, en zie events live worden geactiveerd:

Opties

Geef deze mee aan whop.dashboard.create({ … }), of als props op <Dashboard> in React.
string
Een token met beperkte scope waarmee elk oppervlak onder deze handle leest. Maak op je server één token aan voor de hele handle met POST /api/v1/access_tokens, en stel een nieuw token in met update({ accessToken }) voordat het verloopt. Het lezen van betalingen vereist payment:basic:read; e-mailadressen van kopers vereisen daarnaast member:email:read, het klanttraject member:basic:read, de trackingkolom shipment:basic:read, en de product- en abonnementsnamen op een betaling access_pass:basic:read en plan:basic:read. De banners vereisen payout:account:read, en het starten van verificatie vanuit de actiebalk identity:write. Wanneer het wordt weggelaten, gebruiken de leesacties de eigen sessie van de kijker, die alleen same-origin antwoordt.
string
vereist
Account- of gebruikers-ID waarvan deze oppervlakken de gegevens lezen. Account-ID’s hebben de prefix biz_; gebruikers-ID’s hebben de prefix user_, kunnen alleen de eigen openstaande acties van de kijker lezen en hebben geen betalingen.
Appearance
Visuele aanpassing voor de elementen van deze groep. Overschrijft de globale WhopElements({ appearance }). Wijzig het live met update({ appearance }).
WhopElementsLocale
Taalinstelling voor de UI-tekst van de elementen van deze groep. Stel het in op een van de ingebouwde taalinstellingen van de app om de globale configuratie te overschrijven. Elke andere waarde valt terug op de standaardtaalinstelling.

Events

Geef callbacks mee in de create-opties of als React-props.

onLoadingChange

Wordt uitgevoerd wanneer de gegroepeerde laadstatus verandert. De waarde is true zolang een gemount element nog laadt.
boolean

Methoden

Roep deze aan op de Dashboard-handle van whop.dashboard.create({ … }) of useDashboard().

update

Voegt nieuwe handle-opties samen in elk gemount element. Wijzig in React in plaats daarvan de namespace-props. Parameters
Partial<DashboardOptions>
vereist

destroy

Verwijdert elk element en elke subcontroller die deze handle heeft aangemaakt, verwijdert het controllerframe en geeft de abonnementen vrij. Je kunt het meerdere keren aanroepen, maar een verwijderde handle weigert elke andere aanroep — maak een nieuwe handle aan om opnieuw te beginnen. React verwijdert de groep automatisch wanneer de provider wordt ontkoppeld.

Elementen

De elementen die deze groep mount. Elk heeft een eigen pagina:

RequiredActionsElement

De banners met openstaande acties uit het saldodashboard van Whop — identiteitsverificatie, stortingen, belasting en de rest — in dezelfde volgorde als waarin de API ze retourneert. Een account zonder openstaande acties geeft helemaal niets weer, zodat het element permanent in een lay-out kan staan. De tekst komt uit de API. Een druk op Verify start een gehoste identiteitssessie en gaat daarheen; Add money meldt depositRequested en blijft staan, zodat de host zijn eigen stortingsflow mount — bijvoorbeeld het deposit-element van de wallet-controller; elke andere knop volgt de eigen link van de actie. Leest met de accessToken van de Dashboard-handle, die payout:account:read nodig heeft, plus identity:write om verificatie te starten. Een mislukte leesactie geeft niets weer in plaats van een fout — een banner mag nooit het meest opvallende element worden op de pagina van iemand anders.

VerificationElement

Een banner die de accounthouder vraagt de identiteit te verifiëren, alleen getoond zolang de verificatie openstaat — een account dat al is geverifieerd, geeft helemaal niets weer, zodat het element permanent in een lay-out kan staan. De kop en statusmeldingen komen uit de API, met een kortere beschrijving wanneer de accounthouder wordt uitgenodigd om de verificatie te starten, zodat ze de werkelijke status van het account volgen: een account dat nog niet is begonnen, wordt uitgenodigd om kaarten en uitbetalingen te ontgrendelen, een account in beoordeling wordt als in behandeling weergegeven, en een mislukt of gemarkeerd account meldt dat. Een druk op de knop meldt verificationRequested en blijft staan, zodat de host zijn eigen verificatie mount — bijvoorbeeld het kyc-element van de verifications-controller. Leest met de accessToken van de Dashboard-handle, die payout:account:read nodig heeft. Een mislukte leesactie geeft niets weer in plaats van een fout — een herinnering mag nooit het meest opvallende element op de pagina worden.

PaymentsTableElement

De betalingstabel uit het dashboard met statuskaarten, zoeken, filters, sorteren, rijselectie, CSV-export, kolominstellingen en paginering. Leest alle betalingspagina’s om volledige aantallen te berekenen en lokaal te filteren; bedoeld voor accounts met een bescheiden betalingsgeschiedenis. Klantgegevens en terugbetalingen worden via events aan je applicatie doorgegeven.

PaymentDetailElement

Een betalingsdetailpagina met de specificatie uit het dashboard, activiteit, klant, details en klanttraject. Elke sectie kan worden verborgen. Leest payment:basic:read; het e-mailadres van de klant vereist member:email:read en het traject vereist member:basic:read. Actie-events laten je applicatie wijzigingen bevestigen en autoriseren; dit element voert zelf nooit een terugbetaling, nieuwe poging of annulering van een betaling uit.