* Added onLoad callback for BannerAd, InterstitialAd, RewardedAd, and…

… RewardedInterstitialAd @composables (#60) * Updated documentation
LexiLabs-App · Jan 31, 2025 · ca5f789 · ca5f789
1 parent 11f9e12
commit ca5f789
Show file tree

Hide file tree

Showing 168 changed files with 224 additions and 194 deletions.
diff --git a/basic-ads/src/androidMain/kotlin/app/lexilabs/basic/ads/Composables.kt b/basic-ads/src/androidMain/kotlin/app/lexilabs/basic/ads/Composables.kt
@@ -6,14 +6,19 @@ import androidx.compose.ui.viewinterop.AndroidView
 
 @RequiresPermission("android.permission.INTERNET")
 @Composable
-public actual fun BannerAd(adUnitId: String, adSize: AdSize) {
+public actual fun BannerAd(
+    adUnitId: String,
+    adSize: AdSize,
+    onLoad: () -> Unit
+) {
     AndroidView(
         factory = { context ->
             val adView = AdView(context)
             adView.apply {
                 this.setAdSize(adSize.toAndroid())
                 this.adUnitId = adUnitId
                 this.loadAd(AdLoader().requestAd())
+                if (!this.isLoading) { onLoad() }
             }
         }
     )
@@ -29,12 +34,14 @@ public actual fun InterstitialAd(
     onImpression: () -> Unit,
     onClick: () -> Unit,
     onFailure: () -> Unit,
+    onLoad: () -> Unit
 ) {
     val adLoader = AdLoader()
     adLoader.loadInterstitialAd(
         activity,
         adUnitId,
         onLoaded = {
+            onLoad()
             adLoader.showInterstitialAd(
                 activity = activity,
                 onDismissed = { onDismissed() },
@@ -58,12 +65,14 @@ public actual fun RewardedAd(
     onImpression: () -> Unit,
     onClick: () -> Unit,
     onFailure: () -> Unit,
+    onLoad: () -> Unit
 ) {
     val adLoader = AdLoader()
     adLoader.loadRewardedAd(
         activity = activity,
         adUnitId = adUnitId,
         onLoaded = {
+            onLoad()
             adLoader.showRewardedAd(
                 activity = activity,
                 onDismissed = { onDismissed() },
@@ -88,12 +97,14 @@ public actual fun RewardedInterstitialAd(
     onImpression: () -> Unit,
     onClick: () -> Unit,
     onFailure: () -> Unit,
+    onLoad: () -> Unit
 ) {
     val adLoader = AdLoader()
     adLoader.loadRewardedInterstitialAd(
         activity = activity,
         adUnitId = adUnitId,
         onLoaded = {
+            onLoad()
             adLoader.showRewardedInterstitialAd(
                 activity = activity,
                 onDismissed = { onDismissed() },

diff --git a/basic-ads/src/commonMain/kotlin/app/lexilabs/basic/ads/Composables.kt b/basic-ads/src/commonMain/kotlin/app/lexilabs/basic/ads/Composables.kt
@@ -6,12 +6,14 @@ import androidx.compose.runtime.Composable
  * Loads and displays a Banner Ad using a [Composable].
  * @param adUnitId Your AdMob AdUnitId [String]
  * @param adSize Your AdMob [AdSize]
+ * @param onLoad Lambda expression that executes after the [AdRequest] has fully loaded
  * @see AdUnitId.autoSelect
  */
 @DependsOnGoogleMobileAds
 @Composable public expect fun BannerAd(
     adUnitId: String = AdUnitId.BANNER_DEFAULT,
-    adSize: AdSize = AdSize.FULL_BANNER
+    adSize: AdSize = AdSize.FULL_BANNER,
+    onLoad: () -> Unit = {}
 )
 
 /**
@@ -23,6 +25,7 @@ import androidx.compose.runtime.Composable
  * @param onImpression Lambda expression that executes after the user has seen the ad
  * @param onClick Lambda expression that executes after the user clicks the ad
  * @param onFailure Lambda expression that executes after the ad fails to load or redirect
+ * @param onLoad Lambda expression that executes after the [AdRequest] has fully loaded
  * @see AdUnitId.autoSelect
  */
 @DependsOnGoogleMobileAds
@@ -34,6 +37,7 @@ import androidx.compose.runtime.Composable
     onImpression: () -> Unit = {},
     onClick: () -> Unit = {},
     onFailure: () -> Unit = {},
+    onLoad: () -> Unit = {}
 )
 
 /**
@@ -46,6 +50,7 @@ import androidx.compose.runtime.Composable
  * @param onImpression Lambda expression that executes after the user has seen the ad
  * @param onClick Lambda expression that executes after the user clicks the ad
  * @param onFailure Lambda expression that executes after the ad fails to load or redirect
+ * @param onLoad Lambda expression that executes after the [AdRequest] has fully loaded
  * @see AdUnitId.autoSelect
  */
 @DependsOnGoogleMobileAds
@@ -58,6 +63,7 @@ import androidx.compose.runtime.Composable
     onImpression: () -> Unit = {},
     onClick: () -> Unit = {},
     onFailure: () -> Unit = {},
+    onLoad: () -> Unit = {}
 )
 
 /**
@@ -70,6 +76,7 @@ import androidx.compose.runtime.Composable
  * @param onImpression Lambda expression that executes after the user has seen the ad
  * @param onClick Lambda expression that executes after the user clicks the ad
  * @param onFailure Lambda expression that executes after the ad fails to load or redirect
+ * @param onLoad Lambda expression that executes after the [AdRequest] has fully loaded
  * @see AdUnitId.autoSelect
  */
 @DependsOnGoogleMobileAds
@@ -82,4 +89,5 @@ import androidx.compose.runtime.Composable
     onImpression: () -> Unit = {},
     onClick: () -> Unit = {},
     onFailure: () -> Unit = {},
+    onLoad: () -> Unit = {}
 )
diff --git a/basic-ads/src/iosMain/kotlin/app/lexilabs/basic/ads/Composables.kt b/basic-ads/src/iosMain/kotlin/app/lexilabs/basic/ads/Composables.kt
@@ -11,7 +11,11 @@ import platform.UIKit.UIApplication
 
 @OptIn(ExperimentalForeignApi::class)
 @Composable
-public actual fun BannerAd(adUnitId: String, adSize: AdSize) {
+public actual fun BannerAd(
+    adUnitId: String,
+    adSize: AdSize,
+    onLoad: () -> Unit
+) {
     UIKitView(
         factory = {
             val viewController = UIApplication.sharedApplication.keyWindow?.rootViewController
@@ -21,6 +25,7 @@ public actual fun BannerAd(adUnitId: String, adSize: AdSize) {
                 adUnitID = adUnitId
                 this.rootViewController = viewController
                 loadRequest(AdLoader().requestAd())
+                if (viewController.viewLoaded) { onLoad() }
             }
             bannerView
         },
@@ -37,12 +42,14 @@ public actual fun InterstitialAd(
     onImpression: () -> Unit,
     onClick: () -> Unit,
     onFailure: () -> Unit,
+    onLoad: () -> Unit
 ) {
     val adLoader = AdLoader()
     adLoader.loadInterstitialAd(
         activity,
         adUnitId,
         onLoaded = {
+            onLoad()
             adLoader.showInterstitialAd(
                 activity = activity,
                 onDismissed = { onDismissed() },
@@ -65,12 +72,14 @@ public actual fun RewardedAd(
     onImpression: () -> Unit,
     onClick: () -> Unit,
     onFailure: () -> Unit,
+    onLoad: () -> Unit
 ) {
     val adLoader = AdLoader()
     adLoader.loadRewardedAd(
         activity = activity,
         adUnitId = adUnitId,
         onLoaded = {
+            onLoad()
             adLoader.showRewardedAd(
                 activity = activity,
                 onDismissed = { onDismissed() },
@@ -94,12 +103,14 @@ public actual fun RewardedInterstitialAd(
     onImpression: () -> Unit,
     onClick: () -> Unit,
     onFailure: () -> Unit,
+    onLoad: () -> Unit
 ) {
     val adLoader = AdLoader()
     adLoader.loadRewardedInterstitialAd(
         activity = activity,
         adUnitId = adUnitId,
         onLoaded = {
+            onLoad()
             adLoader.showRewardedInterstitialAd(
                 activity = activity,
                 onDismissed = { onDismissed() },

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -24,7 +24,7 @@ dependencies {
 
 allprojects {
     group = "app.lexilabs.basic"
-    version = "0.2.4"
+    version = "0.2.5-beta01"
 
     apply(plugin = "org.jetbrains.dokka")
     apply(plugin = "maven-publish")

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-error/-ad-error.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-error/-ad-error.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector common-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-error/index.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-error/index.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/-ad-loader.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/-ad-loader.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/index.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/index.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/load-interstitial-ad.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/load-interstitial-ad.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/load-rewarded-ad.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/load-rewarded-ad.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/.../basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/load-rewarded-interstitial-ad.html b/.../basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/load-rewarded-interstitial-ad.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/request-ad.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/request-ad.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/show-interstitial-ad.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/show-interstitial-ad.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/show-rewarded-ad.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/show-rewarded-ad.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/.../basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/show-rewarded-interstitial-ad.html b/.../basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-loader/show-rewarded-interstitial-ad.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-request/index.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-request/index.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-ad-size.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-ad-size.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/...basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-a-u-t-o_-h-e-i-g-h-t.html b/...basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-a-u-t-o_-h-e-i-g-h-t.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-b-a-n-n-e-r.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-b-a-n-n-e-r.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-f-l-u-i-d.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-f-l-u-i-d.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/...basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-f-u-l-l_-b-a-n-n-e-r.html b/...basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-f-u-l-l_-b-a-n-n-e-r.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-f-u-l-l_-w-i-d-t-h.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-f-u-l-l_-w-i-d-t-h.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-i-n-v-a-l-i-d.html b/docs/basic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-i-n-v-a-l-i-d.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/...sic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-l-a-r-g-e_-b-a-n-n-e-r.html b/...sic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-l-a-r-g-e_-b-a-n-n-e-r.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""

diff --git a/...asic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-l-e-a-d-e-r-b-o-a-r-d.html b/...asic-ads/basic-ads/app.lexilabs.basic.ads/-ad-size/-companion/-l-e-a-d-e-r-b-o-a-r-d.html
@@ -46,7 +46,7 @@
         </button>
         <div class="navigation-controls--break ui-kit_mobile-only"></div>
         <div class="library-version" id="library-version">
-0.2.4        </div>
+0.2.5-beta01        </div>
         <div class="navigation-controls">
         <div class="filter-section filter-section_loading" id="filter-section">
                 <button class="platform-tag platform-selector jvm-like" data-active=""