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 validate() en getValues() aan te roepen.Eén per
mode. Mount één <AddressElement /> voor elke mode-waarde onder één Payments-handle. Een tweede mount met dezelfde mode wordt geweigerd. De mode van een element wordt ingesteld wanneer je het aanmaakt; om die te wijzigen, verwijder je het element en maak je een nieuw aan.Voorbeeldgegevens. Open de Playground.
Props
Welk adres dit verzamelt:
billing (standaard) of shipping. Stelt ook het autocomplete-doel van de browser in. Je kunt van elk één mounten onder één handle. Factuurgegevens komen van het factuurelement, of van het verzendelement wanneer er geen factuurelement is gemount. Standaard "billing".De naamrij: één veld voor de volledige naam (standaard), gesplitste velden voor voor- en achternaam, of geen. Standaard
"combined".Adresregel 2: altijd zichtbaar (standaard), getoond via een tekstknop (
toggle), of nooit verzameld. Standaard "always".Startwaarden die eenmaal vóór de eerste weergave worden toegepast (
address.country is een ISO 3166-1 alpha-2-landcode). Heeft voorrang op landdetectie via IP.full (standaard) stapelt velden met labels. compact groepeert velden met placeholderlabels binnen één rand. wrap behoudt de afzonderlijke velden van full en zet daarnaast plaats, staat en postcode naast elkaar. Die en de paren die full al naast elkaar zet (voor- en achternaam, organisatie) passen zoveel per rij als de breedte toelaat en lopen door naar een volgende rij naarmate die smaller wordt. Standaard "full".above (standaard) houdt elk label buiten het veld: erboven in de full-lay-out, als placeholder in compact. floating gebruikt elk label als placeholder van het veld, in beide lay-outs, en toont daarna een klein label boven de getypte tekst zodra het veld een waarde heeft. Standaard "above". Sinds v1.5.0.full (standaard) volgt het volledige adresformaat van het geselecteerde land. minimal verzamelt alleen land en postcode. name voegt onafhankelijk daarvan vereiste naamvelden toe. Stel name in op none om ze weg te laten. Dit element voegt geen velden toe die een betaalmethode vereist. Kaartbevestiging vereist een naam, land en postcode, dus houd name ingeschakeld of geef billingDetails.name mee. Standaard "full".Organisatievelden: geen (standaard), alleen naam, of naam met een kiezer voor bedrijf/particulier. Standaard
"none".Bepaal het standaardland op basis van het IP-adres van de koper (vastgesteld vóór de eerste weergave). Valt terug op
countryHint van de controller, daarna op US. Standaard true.Toegestane ISO 3166-1 alpha-2-landcodes. Met één code blijft de kiezer zichtbaar, maar biedt alleen dat land aan.
Schakelt Google Places-suggesties in voor het straatadres. Als er geen overeenkomst verschijnt of Places is geblokkeerd, meldt de lijst dat er geen overeenkomsten zijn en kunnen kopers het adres handmatig invoeren. Op een telefoon openen de suggesties schermvullend via een zoekknop in het straatveld in plaats van eronder, waar het toetsenbord ze zou bedekken. Stel in op
false voor een gewone invoer. Standaard true.Toont elk adresveld vanaf het begin. Standaard (
false) opent het formulier met het straatadres en toont het de rest zodra de koper een suggestie kiest, een adres typt of ervoor kiest het handmatig in te voeren. Standaard false. Sinds v1.6.0.Extra velden die met het adresformulier worden weergegeven. Waarden worden gevalideerd en uitgezonden in de afzonderlijke
custom-map.Fallbackland na
defaultValues en IP-detectie. Gebruik een ISO 3166-1 alpha-2-code. Een lege waarde valt terug op US. Standaard "".Events
Geef callbacks mee in de create-opties of als React-props.onChange
Wordt geactiveerd wanneer het adres verandert. complete is true wanneer alle landspecifieke velden en vereiste aangepaste velden geldig zijn. address volgt de namen van billing_details van het bevestigingstoken, waaronder postal_code. country is een ISO 3166-1 alpha-2-code. Aangepaste waarden staan in custom.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.validate
Valideert het formulier, toont alle inline fouten en gooit nooit een fout. Retourneert complete, address en errors. errors is leeg precies wanneer complete true is. Sleutels gebruiken contractnamen zoals postal_code en line1, custom:<key> voor aangepaste velden en tijdelijk form tijdens het laden.Retourneert Promise<object>getValues
Retourneert address en custom zonder validatie of het tonen van fouten.Retourneert Promise<object>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 }).
