Present a screen

present opens a screen over your app. It finishes when the user is done with it. Use it for upgrade buttons, feature gates, prompts and any moment your own code decides.

@MainActor
@discardableResult
static func present(_ source: ScreenSource, options: PresentOptions = PresentOptions(), from presenter: UIViewController? = nil) async throws -> PurchaseResult

// Shorthand for a placement:
static func present(placement: String, options: PresentOptions = PresentOptions()) async throws -> PurchaseResult

Miniwall.configure(apiKey: "pk_...")

var options = PresentOptions()
options.products = [
    "monthly": ProductInfo(price: 9.99, currency: "USD", period: .every(.month)),
    "annual": ProductInfo(price: 59.99, currency: "USD", period: .every(.year),
                          offer: .init(price: 0, period: .every(.day, count: 7))),
]
options.onPurchase = { request in try await buy(request.packageId) }

let result = try await Miniwall.present(placement: "upgrade_button", options: options)

Where the screen comes fromCopy Anchor Link

A JSON source must be a screen: components_config.base has to exist. Otherwise present throws Miniwall: not a screen JSON (expected components_config.base.stack).

OptionsCopy Anchor Link

Every option is optional.

How it looksCopy Anchor Link

Prices and textCopy Anchor Link

CallbacksCopy Anchor Link

Full details are on Callbacks.

TargetingCopy Anchor Link

The resultCopy Anchor Link

answers holds what the user answered. See Answers. skipped means nothing opened; its reason is frequency_cap, audience or holdout.

present throws (or the promise rejects) when the screen cannot be loaded, for example when the key is wrong or the network failed with no saved copy. Wrap the call in try/catch. See Errors.

do {
    switch try await Miniwall.present(placement: "upgrade_button", options: options) {
    case let .purchased(packageId, _): unlockPro(packageId)
    case let .action(actionId, answers): handleAction(actionId, answers)
    case .skipped: break // the placement chose not to show
    default: break       // closed or restored
    }
} catch {
    print("Could not show the screen:", error)
}

What happens while it is openCopy Anchor Link

• While your onPurchase, onRestore or onAction runs, the screen shows a busy spinner and ignores further taps, so a double tap cannot start two purchases.
• A screen with "Go to another screen" buttons moves between screens inside the same presentation. present finishes once, when the flow ends. The first screen is the one the placement returns, so its A/B test, schedule and audiences apply to the whole flow. See Answers.
• A sheet (popup, slide-in) closes with the system gesture: swipe down on iOS, tap outside or system back on Android. A full-screen cover has no gesture on iOS, and closes with system back on Android. On every platform the screen can also carry a button that uses the action Close the screen; the SDK adds no close button of its own. Closing finishes with closed.
• On Android, the system back button closes an open sheet inside the screen first, then the screen.
• Links open in the system browser unless you handle onOpenUrl. Only http, https, mailto, tel and links that start with a single / are ever opened.

With a placementCopy Anchor Link

When the source is a placement the SDK also applies the placement's setup in the dashboard: which screen, its A/B test, a schedule in force, audiences, the frequency limit, the holdout and the display format. See Placements.

Views, closes, purchase taps, purchases, restores, button presses and chosen answers are reported to your Analytics unless you set analytics to false. See Events and privacy.

RelatedCopy Anchor Link

• Display modes
• Callbacks
• Purchases and prices
• Embed a screen
• Auto placements