Deze pagina documenteert
@whop/elements@1.10.0 en @whop/elements-react@1.10.0.v1.0.0.
Wordt gemount binnen
Payments. Geef props en callbacks mee via de create-opties of als React-props. Bewaar de aangemaakte handle, of de React-ref, om select() aan te roepen.Exclusief.
PaymentElement is een alternatief voor CardElement of CardFields in deze Payments-handle. Mount er één tegelijk. Verwijder het voordat je een ander mount.Wacht op
BrandingElement. Dit element blijft in de laadstatus totdat BrandingElement in dezelfde Payments-handle is gemount.Voorbeeldgegevens. Open de Playground.
Props
Bepaalt de weergavevolgorde in beide lay-outs. Vermelde typen verschijnen eerst, in volgorde. Niet-vermelde typen behouden hun relatieve volgorde. Heeft geen invloed op de beschikbaarheid. Standaard
[].Bepaalt welke wallets het element aanbiedt. Elke sleutel is standaard
'auto', wat de wallet aanbiedt overal waar het account, het apparaat van de koper en de afschrijving die ondersteunen. 'never' verwijdert die wallet uit de methodelijst. Gebruik het wanneer je pagina eigen knoppen voor Apple Pay, Google Pay of PayPal tekent met paymentRequest, zodat kopers elke wallet maar één keer zien. payPal: 'never' verwijdert de PayPal-methode. Opgeslagen betaalmethoden worden niet beïnvloed. Standaard {}. Sinds v1.8.0.Bepaalt het verzamelen van factuurgegevens.
billingDetails: 'minimal' (standaard) volgt de matrix van elke methode. Methoden verzamelen standaard de naam en het volledige landformaat. Een overschrijving kan alleen het gedeclareerde minimum of niets verzamelen. Voor kaarten is het minimum de naam op de kaart, het land en de postcode. 'full' vereist de naam en het volledige landformaat voor elke nieuwe methode. 'never' verbergt het blok. address: 'minimal' verzamelt alleen het gedeclareerde minimum van elke methode plus een land waar dat minimum er geen bevat (en ook de postcode wanneer billingDetails: 'full' aangeeft dat er belasting over de checkout wordt geheven), behalve voor wallets, crypto, bankincasso’s, bankoverschrijvingen, card-present en in-app-aankopen, die helemaal geen adres verzamelen, en behalve voor een methode waarvan de provider het volledige factuuradres vereist (requires_full_billing_address), waarvan de tegel dezelfde regels volgt als een checkout zonder deze markering; verder heeft het voorrang op billingDetails: 'full'; gebruik het wanneer de verkoper geen volledig factuuradres verzamelt. phone: 'never' verbergt alleen het telefoonveld voor facturering wanneer je formulier dat al verzamelt; geef billingDetails.phone mee aan createConfirmationToken voor methoden die het vereisen. Geef in plaats daarvan het adres mee aan createConfirmationToken. De landkiezer bevat alleen landen die door de methode en de betalingsvaluta worden ondersteund. Als er een termijnplan is geselecteerd, wordt deze beperkt tot de landen die het plan bedient — het factuurland is het transactieland waaronder de afschrijving wordt verwerkt. De kiezer wordt vergrendeld wanneer er maar één beschikbaar is. Standaard {"billingDetails":"minimal"}.Vult de factuurgegevens vooraf in wanneer het factuurblok van elke methode voor het eerst wordt weergegeven. De koper kan elk vooraf ingevuld veld bewerken.
address.country is een ISO 3166-1 alpha-2-code en geldt alleen wanneer de geselecteerde methode die accepteert. phone vult het telefoonveld voor facturering in voor methoden die er een verzamelen, in E.164-formaat zoals +14155552671; een nummer buiten de ondersteunde telefoonlanden van de methode wordt genegeerd. Alleen velden die het blok weergeeft, worden vooraf ingevuld en verzonden. Geef al het andere mee aan createConfirmationToken in billingDetails. Sinds v1.1.0.Lay-out van de kiezer.
accordion (standaard) stapelt methoden en klapt details inline uit. horizontal toont niet-scrollende tegels van gelijke breedte met de geselecteerde details eronder. Na vier methoden opent een tegel More een native kiezer. De daar gekozen methode bezet de laatste tegel tot de volgende selectie. Selectie en bevestiging werken hetzelfde. Standaard "accordion".Alleen
accordion. Voegt ruimte en een aparte kaartstijl toe tussen methoden. Wordt genegeerd wanneer layout horizontal is. Standaard false.Of de eerste aangeboden methode na het ophalen wordt geselecteerd. De standaardwaarde
true respecteert order en zendt selected en change uit zoals bij een interactie van de koper. Het wordt eenmaal uitgevoerd vóór interactie van de koper en doet niets wanneer er geen methode wordt aangeboden. Stel in op false om zonder selectie te mounten. Los daarvan valt de selectie terug op de eerste aangeboden methode als een update de geselecteerde methode verwijdert. Een element zonder selectie blijft zonder selectie. Standaard true.Events
Geef callbacks mee in de create-opties of als React-props.onChange
Wordt geactiveerd wanneer de selectie verandert. complete: true betekent dat de koper een methode heeft geselecteerd en de kaartvelden of vereiste invoer ervan heeft ingevuld. Gebruik het om bevestiging in te schakelen. paymentMethod is de geselecteerde betaalmethode, opgeslagen of nieuw, of null zolang er niets is geselecteerd: displayName en icons benoemen de keuze zoals het element die toont (met balance.imageUrl, de afbeelding van de eigenaar van een saldo), card bevat het netwerk, de laatste vier cijfers en het financieringstype van een kaart, requiresBillingPhone geeft aan of de methode een telefoonnummer in de factuurgegevens nodig heeft, en countries vermeldt vanuit welke landen de methode kan betalen in de valuta van de afschrijving. type, requiresBillingPhone en method op het hoogste niveau zijn verouderd: lees ze uit paymentMethod. supportsBuyerFee op het hoogste niveau is ook verouderd, zonder vervanging: Whop bepaalt de prijs van zijn servicekosten voor kopers zelf.onAddressChange
Wordt ongeveer 300 ms nadat het interne factuuradres verandert geactiveerd. Gebruik het voor belasting, verzending of andere updates die van het adres afhangen. country is een ISO 3166-1 alpha-2-code. De payload laat andere adressleutels weg wanneer die leeg zijn of voor dat land niet worden gebruikt. complete: true betekent dat het factuurblok geldig en volledig is. Dit event wordt alleen geactiveerd zolang het betaalelement het verzamelen van het adres beheert. Gebruik bij fields.billingDetails: 'never' je eigen adresbron. Gebruik bij een gemount AddressElement het change-event daarvan.onLoaderStart
Wordt uitgevoerd nadat het laadskelet voor het eerst is weergegeven en vóór onReady.onReady
Wordt uitgevoerd na de eerste volledige weergave van het element.onError
Wordt uitgevoerd wanneer het element niet kan laden of crasht. De fallback blijft zichtbaar. Gebruik code voor programmatische afhandeling. sourceKey identificeert een mislukte host-state-bron.Methoden
Roep deze aan op de handle diecreate retourneert, of via een React-ref.select
Selecteer een methode via hetzelfde pad als een interactie van de koper. select('cashapp') klapt bijvoorbeeld de tegel uit en zendt selected en change uit. Kaarten blijven complete: false totdat hun velden volledig zijn. Onbekende, niet-beschikbare of door het bedrag uitgesloten methoden worden geweigerd met code METHOD_NOT_OFFERED. select(null) wist de selectie en zendt change uit met complete: false. Gebruik het met autoSelect={false} voor volledige externe controle.ParametersRetourneert Promise<void>mount
Mount het element in target en begint met laden. React-componenten mounten zichzelf.Parametersdestroy
Verwijdert het element en geeft het frame en de abonnementen vrij. Je kunt het meerdere keren aanroepen. React verwijdert het element automatisch.update
Voegt nieuwe props samen in het gemounte element. Wijzig in React in plaats daarvan de componentprops.ParametersStyling
Style deze onderdelen viaappearance.classes. Gebruik camelCase of kebab-case voor eigenschapsnamen en vermeld eenheden. Stylesheets van de pagina kunnen het frame van het element niet bereiken. Het framework valideert elke declaratie voordat die wordt geïnjecteerd.appearance mee aan <Payments>. Stel het globaal in met WhopElements({ appearance }).
