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.

Playground

Elementleri örnek verilerle bir araya getirin. Kontrolleri kullanın, elementler ekleyip düzenleyin ve olayların canlı olarak tetiklenmesini izleyin:

Seçenekler

Bunları whop.dashboard.create({ … }) çağrısına veya React’te <Dashboard> üzerinde prop olarak iletin.
string
Bu tanıtıcı altındaki her yüzeyin okuma yaparken kullandığı kapsamlı bir token. Sunucunuzda POST /api/v1/access_tokens ile tanıtıcının tamamı için tek bir token oluşturun ve süresi dolmadan önce update({ accessToken }) ile yenisini ayarlayın. Ödemeleri okumak için payment:basic:read gerekir; alıcı e-postaları için ayrıca member:email:read, müşteri yolculuğu için member:basic:read, takip sütunu için shipment:basic:read ve bir ödemedeki ürün ve plan adları için access_pass:basic:read ile plan:basic:read gerekir. Afişler payout:account:read gerektirir; eylem çubuğundan doğrulama başlatmak için identity:write gerekir. Atlanırsa okumalar izleyicinin kendi oturumunu taşır; bu da yalnızca aynı kaynaktan (same-origin) gelen isteklere yanıt verir.
string
gerekli
Bu yüzeylerin kayıtlarını okuduğu hesap veya kullanıcı kimliği. Hesap kimlikleri biz_ öneklidir; kullanıcı kimlikleri user_ öneklidir, yalnızca izleyicinin kendi bekleyen eylemlerini okuyabilir ve ödemeleri yoktur.
Appearance
Bu grubun elementleri için görsel özelleştirme. Genel WhopElements({ appearance }) ayarını geçersiz kılar. update({ appearance }) ile canlı olarak değiştirin.
WhopElementsLocale
Bu grubun element arayüz metinleri için yerel ayar. Genel yapılandırmayı geçersiz kılmak için uygulamanın derlenmiş yerel ayarlarından birine ayarlayın. Diğer tüm değerler varsayılan yerel ayara geri döner.

Olaylar

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

onLoadingChange

Gruplanmış yükleme durumu değiştiğinde çalışır. Bağlı herhangi bir element hâlâ yüklenirken değer true olur.
boolean

Metotlar

Bunları whop.dashboard.create({ … }) veya useDashboard() üzerinden alınan Dashboard tanıtıcısında çağırın.

update

Yeni tanıtıcı seçeneklerini bağlı her elementle birleştirir. React’te bunun yerine ad alanı prop’larını değiştirin. Parametreler
Partial<DashboardOptions>
gerekli

destroy

Bu tanıtıcının oluşturduğu her elementi ve alt denetleyiciyi yok eder, denetleyici çerçevesini kaldırır ve aboneliklerini serbest bırakır. Birden fazla kez çağırabilirsiniz, ancak yok edilmiş bir tanıtıcı diğer tüm çağrıları reddeder; baştan başlamak için yeni bir tanıtıcı oluşturun. React, sağlayıcı kaldırıldığında grubu otomatik olarak kaldırır.

Elementler

Bu grubun bağladığı elementler. Her birinin kendi sayfası vardır:

RequiredActionsElement

Whop’un bakiye kontrol panelindeki bekleyen eylem afişleri (kimlik doğrulama, para yatırma, vergi ve diğerleri), API’nin döndürdüğü sırayla. Bekleyen hiçbir şeyi olmayan bir hesap hiçbir şey göstermez, bu nedenle element bir düzende kalıcı olarak yer alabilir. Metinler API’den gelir. Verify düğmesine basmak barındırılan bir kimlik oturumu başlatır ve oraya gider; Add money depositRequested bildirir ve yerinde kalır, böylece ana uygulama kendi para yatırma akışını, örneğin wallet denetleyicisinin deposit elementini bağlar; diğer tüm düğmeler eylemin kendi bağlantısını izler. Dashboard tanıtıcısının payout:account:read gerektiren accessToken değeriyle okur; doğrulamayı başlatmak için ayrıca identity:write gerekir. Başarısız bir okuma hata yerine hiçbir şey göstermez; bir afiş asla başkasının sayfasındaki en dikkat çekici şey olmamalıdır.

VerificationElement

Hesap sahibinden kimliğini doğrulamasını isteyen, yalnızca doğrulama beklerken gösterilen bir afiş; zaten doğrulanmış bir hesap hiçbir şey göstermez, bu nedenle element bir düzende kalıcı olarak yer alabilir. Başlık ve durum mesajları API’den gelir; hesap sahibini doğrulamaya başlamaya davet ederken daha kısa bir açıklama kullanılır; böylece hesabın gerçek durumunu izlerler: başlatılmamış bir hesap kartların ve ödemelerin kilidini açmaya davet edilir, incelemedeki bir hesap beklemede olarak görünür ve başarısız ya da işaretlenmiş bir hesap da bunu belirtir. Düğmeye basmak verificationRequested bildirir ve yerinde kalır, böylece ana uygulama kendi doğrulamasını, örneğin verifications denetleyicisinin kyc elementini bağlar. Dashboard tanıtıcısının payout:account:read gerektiren accessToken değeriyle okur. Başarısız bir okuma hata yerine hiçbir şey göstermez; bir hatırlatma asla sayfadaki en dikkat çekici şey olmamalıdır.

PaymentsTableElement

Durum kartları, arama, filtreler, sıralama, satır seçimi, CSV dışa aktarma, sütun ayarları ve sayfalama içeren kontrol paneli ödemeler tablosu. Eksiksiz sayıları hesaplamak ve yerel olarak filtrelemek için tüm ödeme sayfalarını okur; ödeme geçmişi mütevazı olan hesaplar için tasarlanmıştır. Müşteri ayrıntıları ve iadeler olaylar aracılığıyla uygulamanıza devredilir.

PaymentDetailElement

Kontrol paneli dökümü, etkinlik, müşteri, ayrıntılar ve müşteri yolculuğu içeren bir ödeme ayrıntısı sayfası. Her bölüm gizlenebilir. payment:basic:read ile okur; müşteri e-postası için member:email:read, yolculuk için member:basic:read gerekir. Eylem olayları, uygulamanızın değişiklikleri onaylamasını ve yetkilendirmesini sağlar; bu element hiçbir zaman bir ödemeyi kendisi iade etmez, yeniden denemez veya geçersiz kılmaz.