Skip to content

Document UIKit customPaywallTraits handling; fix stale API names #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
salami wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document UIKit customPaywallTraits handling; fix stale API names #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 43 additions & 1 deletion guides/ways-to-show-paywall.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ HeliumPaywall(

<Accordion title="Example with PaywallEventHandlers">
```swift
HeliumPaywallView(
HeliumPaywall(
trigger: "post_onboarding",
eventHandlers: PaywallEventHandlers()
.onOpen { event in
Expand All @@ -51,6 +51,48 @@ HeliumPaywall(
```
</Accordion>

<Accordion title="Keeping customPaywallTraits current when hosting in UIKit">
`customPaywallTraits` are captured when the paywall **displays** and then stay fixed for that
presentation. In SwiftUI this is handled for you as long as the traits come from state that
re-renders the view — the normal way you'd pass dynamic values into a view.

When you host `HeliumPaywall` in UIKit with a `UIHostingController`, UIKit won't refresh the view
for you. If you build the hosting controller ahead of time and update traits before showing it,
drive the view from an `ObservableObject` so the latest traits reach the paywall before display:

```swift
final class PaywallTraitsStore: ObservableObject {
@Published var traits: HeliumUserTraits?
}

struct PaywallHost: View {
@ObservedObject var store: PaywallTraitsStore
let trigger: String
var body: some View {
HeliumPaywall(
trigger: trigger,
config: PaywallPresentationConfig(customPaywallTraits: store.traits)
) { paywallNotShownReason in
Text("Paywall failed to show")
}
}
}

// UIKit
let store = PaywallTraitsStore()
store.traits = initialTraits
let vc = UIHostingController(rootView: PaywallHost(store: store, trigger: "onboarding"))

// Later, before the paywall is displayed:
store.traits = freshTraits // reaches the paywall via the refreshed config
```

<Note>
This applies before the paywall is on screen. Once displayed, traits are locked for that
presentation — updating the store afterward won't change an already-shown paywall.
</Note>
</Accordion>

#### SwiftUI ViewModifier

Attach a paywall to any SwiftUI view using the **`.heliumPaywall`** view modifier:
Expand Down
4 changes: 2 additions & 2 deletions sdk/quickstart-ios.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,10 +466,10 @@ Helium.identify.revenueCatAppUserId = Purchases.shared.appUserID

You can also create a custom delegate and implement your own purchase logic. You can look at our [StoreKitDelegate](https://github.com/cloudcaptainai/helium-swift/blob/main/Sources/Helium/HeliumCore/StoreKitDelegate.swift) and [RevenueCatDelegate](https://github.com/cloudcaptainai/helium-swift/blob/main/Sources/HeliumRevenueCat/HeliumRevenueCat.swift) in the SDK for examples (also linked below).

The `HeliumPurchaseDelegate` is defined as follows:
The `HeliumPaywallDelegate` is defined as follows:

```swift
public protocol HeliumPurchaseDelegate: AnyObject {
public protocol HeliumPaywallDelegate: AnyObject {
// Execute the purchase of a product given the product ID.
func makePurchase(productId: String) async -> HeliumPaywallTransactionStatus

Expand Down