README.md

Adapty UI

AdaptyUI is an open-source framework that is an extension to the Adapty SDK that allows you to easily add purchase screens to your application. It’s 100% open-source, native, and lightweight.

1. Fetching Paywalls & ViewConfiguration

Paywall can be obtained in the way you are already familiar with:

Adapty.getPaywall("YOUR_PAYWALL_ID") { result ->
    when (result) {
        is AdaptyResult.Success -> {
            val paywall = result.value
            // the requested paywall
        }
        is AdaptyResult.Error -> {
            val error = result.error
            // handle the error
        }
    }
}

After fetching the paywall call the Adapty.getViewConfiguration(paywall, locale) method to load the view configuration:

Adapty.getViewConfiguration(paywall, locale) { result ->
    when(result) {
        is AdaptyResult.Success -> {
            val viewConfiguration = result.value
            // use loaded configuration
        }
        is AdaptyResult.Error -> {
            val error = result.error
            // handle the error
        }
    }
}

2. Presenting Visual Paywalls

In order to display the visual paywall on the device screen, you must first configure it. To do this, call the method AdaptyUI.getPaywallView() or create the AdaptyPaywallView directly:

val paywallView = AdaptyUI.getPaywallView(
    activity,
    paywall,
    products,
    viewConfiguration,
    AdaptyPaywallInsets.of(topInset, bottomInset),
    eventListener,
)

//======= OR =======

val paywallView =
    AdaptyPaywallView(activity) // or retrieve it from xml
...
with(paywallView) {
    setEventListener(eventListener)
    showPaywall(
        paywall,
        products,
        viewConfiguration,
        AdaptyPaywallInsets.of(topInset, bottomInset),
    )
}

After the object has been successfully created, you can add it to the view hierarchy and display on the screen of the device.

3. Full Documentation and Next Steps

We recommend that you read the full documentation. If you are not familiar with Adapty, then start here.

Contributing

• Feel free to open an issue, we check all of them or drop us an email at [email protected] and tell us everything you want.
• Want to suggest a feature? Just contact us or open an issue in the repo.

Like AdaptyUI?

So do we! Feel free to star the repo ⭐️⭐️⭐️ and make our developers happy!

License

AdaptyUI is available under the MIT license. Click here for details.

---