Skip to main content
Bu sayfa @whop/elements@1.10.0 ve @whop/elements-react@1.10.0 sürümlerini belgeler.
v1.0.0 sürümünden beri.
Payments içine bağlanır. Prop’ları ve geri çağırmaları oluşturma seçenekleri veya React prop’ları aracılığıyla iletin. validate() ve getValues() çağırmak için oluşturulan tanıtıcıyı veya React ref değerini saklayın.
Her mode için bir tane. Tek bir Payments tanıtıcısı altında her mode değeri için bir <AddressElement /> bağlayın. Aynı mode ile ikinci bir bağlama reddedilir. Bir elementin mode değeri onu oluşturduğunuzda ayarlanır; değiştirmek için elementi yok edin ve yeni bir tane oluşturun.
Bir WhopPayments kapsamı içine bağlanır. Fatura adresini seçilen ülkenin kendi biçiminde toplar ve siz bağlasanız da bağlamasanız da denetleyici token oluşturma için onu okur.
Ücretin ve onay token’ının sahibi olan <Payments> içine bağlayın. <Payments> ise <WhopElements> içine bağlanır. Fatura adresini alıcının kendi ülke biçiminde gösterir ve sağlayıcıya yayımlar; böylece createConfirmationToken, kendisine herhangi bir şey iletilmeden onu alır.

Örnek veriler. Playground’u açın.

Prop’lar

"billing" | "shipping"
Bunun hangi adresi topladığı: billing (varsayılan) veya shipping. Tarayıcının otomatik tamamlama amacını da ayarlar. Tek bir tanıtıcı altında her birinden bir tane bağlayabilirsiniz. Fatura ayrıntıları fatura elementinden veya hiçbir fatura elementi bağlı değilse teslimat elementinden gelir. Varsayılan değer "billing".
"split" | "none" | "combined"
Ad satırı: tek bir tam ad alanı (varsayılan), ayrı ad/soyad alanları veya hiçbiri. Varsayılan değer "combined".
"never" | "toggle" | "always"
Adres satırı 2: her zaman görünür (varsayılan), bir metin düğmesiyle ortaya çıkar (toggle) veya hiç toplanmaz. Varsayılan değer "always".
object
İlk çizimden önce bir kez uygulanan başlangıç değerleri (address.country bir ISO 3166-1 alpha-2 ülke kodudur). IP’ye dayalı ülke algılamasına göre önceliklidir.
"full" | "compact" | "wrap"
full (varsayılan) etiketli alanları üst üste dizer. compact, yer tutucuyla etiketlenmiş alanları tek bir kenarlık içinde gruplar. wrap, full düzeninin ayrı alanlarını korur ve ayrıca şehir, eyalet ve posta kodunu yan yana koyar. Bunlar ve full düzeninin zaten yan yana koyduğu çiftler (ad ve soyad, kuruluş), genişliğin izin verdiği kadar bir satıra sığar ve genişlik daraldıkça alt satıra geçer. Varsayılan değer "full".
"above" | "floating"
above (varsayılan) her etiketi alanının dışında tutar: full düzeninde alanın üstünde, compact düzeninde yer tutucusu olarak. floating, her iki düzende de her etiketi alanının yer tutucusu olarak kullanır, ardından alanın bir değeri olduğunda yazılan metnin üstünde küçük bir etiket gösterir. Varsayılan değer "above". v1.5.0 sürümünden beri.
"minimal" | "full"
full (varsayılan), seçilen ülkenin eksiksiz adres biçimini izler. minimal yalnızca ülke ve posta kodunu toplar. name, gerekli ad alanlarını bağımsız olarak ekler. Bunları atlamak için name değerini none olarak ayarlayın. Bu element bir ödeme yönteminin gerektirdiği alanları eklemez. Kart onayı bir ad, ülke ve posta kodu gerektirir, bu nedenle name seçeneğini etkin tutun veya billingDetails.name iletin. Varsayılan değer "full".
"none" | "name" | "name_with_type"
Kuruluş alanları: hiçbiri (varsayılan), yalnızca ad veya işletme/bireysel seçicisiyle birlikte ad. Varsayılan değer "none".
boolean
Ülkeyi varsayılan olarak alıcının IP adresinden belirler (ilk çizimden önce çözümlenir). Önce denetleyicinin countryHint değerine, ardından US’ye geri döner. Varsayılan değer true.
string[]
İzin verilen ISO 3166-1 alpha-2 ülke kodları. Tek bir kodla seçici görünür kalır ancak yalnızca o ülkeyi sunar.
boolean
Sokak adresi için Google Places önerilerini etkinleştirir. Hiçbir eşleşme görünmezse veya Places engellenmişse liste eşleşme olmadığını bildirir ve alıcıların adresi elle girmesine izin verir. Telefonda öneriler, klavyenin onları kapatacağı alanın altında değil, sokak alanındaki bir arama düğmesinden tam ekran açılır. Düz bir giriş için false olarak ayarlayın. Varsayılan değer true.
boolean
Her adres alanını baştan gösterir. Varsayılan olarak (false) form sokak adresiyle açılır ve alıcı bir öneri seçtiğinde, bir adres yazdığında veya elle girmeyi seçtiğinde geri kalanını ortaya çıkarır. Varsayılan değer false. v1.6.0 sürümünden beri.
object[]
Adres formuyla birlikte gösterilen ek alanlar. Değerler doğrulanır ve ayrı custom eşlemesinde yayınlanır.
string
defaultValues ve IP algılamasından sonraki yedek ülke. Bir ISO 3166-1 alpha-2 kodu kullanın. Boş bir değer US değerine geri döner. Varsayılan değer "".

Olaylar

Geri çağırmaları oluşturma seçeneklerinde veya React prop’larında iletin.

onChange

Adres değiştiğinde tetiklenir. Ülkeye özgü tüm alanlar ve gerekli özel alanlar geçerli olduğunda complete true olur. address, postal_code dahil olmak üzere onay token’ının billing_details adlarını izler. country bir ISO 3166-1 alpha-2 kodudur. Özel değerler custom içindedir.
object

onLoaderStart

Yükleme iskeleti ilk kez çizildikten sonra ve onReady öncesinde çalışır.

onReady

Elementin ilk eksiksiz çiziminden sonra çalışır.

onError

Element yüklenemediğinde veya çöktüğünde çalışır. Yedek görünüm görünür kalır. Programatik işleme için code kullanın. sourceKey, başarısız olan host-state kaynağını tanımlar.
object

Metotlar

Bunları create tarafından döndürülen tanıtıcı (handle) üzerinde veya bir React ref aracılığıyla çağırın.

validate

Formu doğrular, tüm satır içi hataları ortaya çıkarır ve asla hata fırlatmaz. complete, address ve errors döndürür. errors, tam olarak complete true olduğunda boştur. Anahtarlar postal_code ve line1 gibi sözleşme adlarını, özel alanlar için custom:<key> biçimini ve yükleme sırasında geçici form anahtarını kullanır.Döndürür Promise<object>
boolean
gerekli
object
gerekli
Record<string, string>
gerekli

getValues

Doğrulama yapmadan veya hataları ortaya çıkarmadan address ve custom döndürür.Döndürür Promise<object>
object
gerekli
Record<string, string>
gerekli

mount

Elementi target içine bağlar ve yüklemeyi başlatır. React bileşenleri kendilerini bağlar.Parametreler
string | HTMLElement
gerekli

destroy

Elementi kaldırır ve çerçevesini ile aboneliklerini serbest bırakır. Birden fazla kez çağırabilirsiniz. React elementi otomatik olarak kaldırır.

update

Yeni prop’ları bağlı elementle birleştirir. React’te bunun yerine bileşen prop’larını değiştirin.Parametreler
Partial<AddressElementProps>
gerekli

Stil verme

Bu parçalara appearance.classes aracılığıyla stil verin. Özellik adları için camel case veya kebab case kullanın ve birimleri ekleyin. Sayfa stil sayfaları elementin çerçevesine ulaşamaz. Framework her bildirimi eklemeden önce doğrular.
React’te appearance değerini <Payments> bileşenine iletin. Genel olarak WhopElements({ appearance }) ile ayarlayın.

Parametreler

Binding<PostalAddress>?
Toplanan adresi geri okur. Denetleyici her iki durumda da onu toplar.
Binding<Bool>?
Ülkenin gerektirdiği her alan doldurulup geçerli olduğunda true olur.
WhopAddressElement.Mode
.billing veya .shipping. Shipping, klavyeden teslimat alanlarını ister. Varsayılan değer .billing.
WhopAddressElement.Layout
.full her alanı etiketler ve üst üste dizer; .compact etiketleri yer tutuculara taşır. Varsayılan değer .full.
WhopAddressElement.Scope
.full ülkenin tam biçimini toplar; .minimal yalnızca ülke ve posta kodunu toplar. Varsayılan değer .full.
WhopAddressElement.NameFields
Tek bir tam ad alanı için .combined, ad ve soyad için .split, adı dışarıda bırakmak için .none. Varsayılan değer .combined.
WhopAddressElement.OrganizationFields
.none, bir kuruluş adı için .name veya ayrıca bunun bir işletme mi yoksa bir birey mi olduğunu sormak için .nameWithType. Varsayılan değer .none.
WhopAddressElement.Line2Field
.always ikinci satırı gösterir, .toggle onu bir düğmeyle ortaya çıkarır, .never dışarıda bırakır. Varsayılan değer .toggle.
PostalAddress?
Başlangıç değerleri. country değeri bir ISO 3166-1 alpha-2 kodudur ve algılamaya göre önceliklidir.
Bool
True olduğunda alıcının kendi ülkesiyle başlar. Önce countryHint değerine, ardından ücret para biriminin ülkesine, ardından US’ye geri döner. Varsayılan değer true.
[String]?
Seçiciyi, seçilen yöntemin kendi kısıtlamasıyla kesiştirilmiş bu ISO 3166-1 alpha-2 kodlarıyla sınırlar.
String?
Ülke zinciri için ISO 3166-1 alpha-2 yedek değeri.
Bool
Alıcı yazarken sokak önerileri. Kapalıyken seçilecek bir şey olmadığından her alan baştan gösterilir. Varsayılan değer true.

PostalAddress

Bir seçimin döndürdüğü değerler:
  • country: String: ISO 3166-1 alpha-2, büyük harfle
  • line1 / line2 / city / state / postalCode: String?, ülkenin kendi biçiminde
  • name / firstName / lastName: String?, name moduna göre
  • organization / organizationType: String?, organization moduna göre

Durumlar

Form hemen görüntülenir. .full kapsamında otomatik tamamlama açıkken yerleşim alanları bir öneri veya elle girişten sonra görünür; kapatırsanız her alan bir kerede gösterilir. Hatalar ilk onay denemesinde, ardından canlı olarak ortaya çıkar.

Bilmekte fayda var

  • Sokak önerilerini cihaz üzerinde MapKit sağlar. Whop, alıcının yazarken girdiği sorguyu asla görmez.
  • defaultValues.country algılamaya göre önceliklidir. Algılama önce countryHint değerine, ardından ücret para biriminin ülkesine, ardından US’ye geri döner.
  • allowedCountries, seçilen yöntemin kendi fatura ülkesi kısıtlamasıyla kesiştirilir; böylece yalnızca tek bir ülkeyi kabul eden bir yöntem seçiciyi kendiliğinden daraltır.
  • PostalAddress, onay token’ının billing_details anahtarlarını kullanır; böylece aynı JSON platformlar arasında çalışır.

Kurulum

Denetleyiciyi oluşturan ve içeriğine ileten bir WhopPayments(accountID:charge:) kapsamı içine bağlayın. Bir e-posta oturum açma işlemi alıcıyı doğruladığında payments.buyer oturum açmış alıcıdır. WhopBrandingElement da ekranda olmalıdır; çünkü bu satışlarda kayıtlı satıcı (merchant of record) Whop’tur ve createConfirmationToken onsuz reddeder. .whopElementsAppearance(_:) ile stil verin. Modül, cüzdan SDK’sının WhopElements modülü değil, Elements modülüdür. Başlarken ve Görünüm sayfalarına bakın.

Prop’lar

'billing' | 'shipping'
Otomatik tamamlama amacı. Varsayılan değer billing.
'full' | 'compact'
full her alanı etiketler ve üst üste dizer. compact etiketleri yer tutuculara taşır. Varsayılan değer full.
'full' | 'minimal'
full ülkenin eksiksiz biçimini izler. minimal yalnızca ülke ve posta kodunu toplar. Varsayılan değer full.
'combined' | 'split' | 'none'
Tek bir tam ad alanı, ad ve soyad veya ad alanı yok. Varsayılan değer combined.
'none' | 'name' | 'name_with_type'
Bir kuruluşun toplanıp toplanmayacağı ve ayrıca bunun bir işletme mi yoksa bir birey mi olduğunun sorulup sorulmayacağı. Varsayılan değer none.
'toggle' | 'always' | 'never'
İkinci adres satırının nasıl görüneceği. Varsayılan değer, bir “Add address line 2” düğmesi gösteren toggle değeridir.
string[]
Ülke seçiciyi bu ISO 3166-1 alpha-2 kodlarıyla sınırlayın. Seçilen bir ödeme yönteminin kendi ülke listesi bunu daha da daraltır, asla genişletmez.
boolean
Ülkeyi varsayılan olarak alıcının IP adresinden belirler.
string
defaultValues ve IP algılamasından sonraki yedek ülke. ISO 3166-1 alpha-2.
{ name?: string; address?: Partial<EmittedAddress> }
Devam ettirilen bir oturum için bağlama sırasında bir kez uygulanan başlangıç değerleri.
CustomFieldSpec[]
Bildirilen bir konumda (after_name, after_organization, before_country, after_address) gösterilen ek alanlar. Zorunlu olanlar complete durumunu koşullar.
(payload: AddressChangePayload) => void
Her düzenlemede geçerli anlık görüntüyle tetiklenir.
StyleProp<ViewStyle>
Elementin dış View bileşenine uygulanır. Tema için, bu yüzeydeki her elementi kapsayan sağlayıcı üzerindeki appearance.parts seçeneğini tercih edin. React Native parça adlarının bugün web’in whop-* sınıf adlarından farklı, kendine ait bir küme olduğunu unutmayın; bu nedenle bir web appearance nesnesi değiştirilmeden aktarılamaz.
ReactNode
Element yüklenirken yerleşik iskelet yerine gösterilir.
() => void
Element etkileşimli hâle geldiğinde bir kez tetiklenir. <Payments> bunları gruplar, bu nedenle genellikle istediğiniz şey onun kendi onLoadingChange geri çağırmasıdır.
(error: { message: string; code?: string }) => void
Bu element için bir yükleme veya yapılandırma hatası. Element her iki durumda da kendi hata ekranını gösterir.

AddressChangePayload

onChange geri çağırmasının döndürdüğü değerler:
  • complete: boolean: ülkenin gerektirdiği her alan doldurulmuş ve geçerli
  • address: EmittedAddress: alıcının şimdiye kadar girdiği bilgiler
  • custom: Record<string, string>: bildirdiğiniz tüm customFields alanlarının değerleri

Durumlar

Ülke kataloğu yüklenirken üç alanlı bir iskelet, ardından form. Ülkeyi değiştirmek alanları yeniden planlar, çünkü biçim sabit bir küme değil, ülkeye aittir. Ülkenin gerektirdiği her alan doldurulup geçerli olduğunda onChange, complete bildirir.

Bilmekte fayda var

  • detectCountry açıkken ülke varsayılan olarak alıcının IP adresinden, ardından countryHint değerinden, ardından US’den belirlenir. defaultValues.address.country üçünü de geçersiz kılar.
  • autocomplete web’de olduğu gibi varsayılan olarak açıktır, ancak Google Places yerine platform geocoder tarafından sunulur; bu nedenle API anahtarı, hesap veya ek bağımlılık gerektirmez. iOS, bir parçayı birkaç adayla yanıtlayan, gerçek bir yazarken öneri API’si olan MKLocalSearchCompleter kullanır. Android, kısmi bir adresten tahmin yürütmek yerine eksiksiz bir adresi çözümleyen android.location.Geocoder kullanır: yaklaşık bir sonuç ve yarım yazılmış bir sokakta daha kaba bir sonuç bekleyin. Android anahtarsız bir yazarken öneri özelliği sunmaz ve alternatifi olan Places SDK birkaç megabayt ekler ve bu SDK’yı gömen her uygulamada konum izinlerini zorunlu kılardı.
  • Herhangi bir platformun yetersiz kalması tasarım gereği sessizdir: arka ucu, ağı veya eşleşmesi olmayan bir geocoder hiçbir şey göstermez ve alıcı adresi, zaten başladığı gibi, elle yazar. Otomatik tamamlama hiçbir zaman bir ödemeyi engellemez.
  • Yayınlanan adres, web elementi ve onay token’ının billing_details değeriyle aynı anahtarları kullanır; böylece tek bir payload biçimi platformlar arasında çalışır.
  • Bağlı bir adres elementi, sağlayıcının fatura kaynağıdır. Onu kaldırırsanız createConfirmationToken, kendisine doğrudan ilettiğiniz değerlere geri döner.
Uygulamanızı bir kez <WhopElements getToken={…}> ile sarın, ardından elementlerin etrafına <Payments> bağlayın. Başlarken ve Görünüm sayfalarına bakın.