Merge pull request #962 from arkivanov/expose-PagerState

Add ChildPages composable functions exposing PagerState

Author: arkivanov

extensions-compose/api/android/extensions-compose.api

@@ -9,7 +9,9 @@ public final class com/arkivanov/decompose/extensions/compose/lazyitems/ChildIte
 
 public final class com/arkivanov/decompose/extensions/compose/pages/ChildPagesKt {
 	public static final fun ChildPages (Lcom/arkivanov/decompose/router/pages/ChildPages;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/Modifier;Lcom/arkivanov/decompose/extensions/compose/pages/PagesScrollAnimation;Lkotlin/jvm/functions/Function6;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function5;Landroidx/compose/runtime/Composer;II)V
+	public static final fun ChildPages (Lcom/arkivanov/decompose/router/pages/ChildPages;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/Modifier;Lcom/arkivanov/decompose/extensions/compose/pages/PagesScrollAnimation;Lkotlin/jvm/functions/Function6;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function6;Landroidx/compose/runtime/Composer;II)V
 	public static final fun ChildPages (Lcom/arkivanov/decompose/value/Value;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/Modifier;Lcom/arkivanov/decompose/extensions/compose/pages/PagesScrollAnimation;Lkotlin/jvm/functions/Function6;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function5;Landroidx/compose/runtime/Composer;II)V
+	public static final fun ChildPages (Lcom/arkivanov/decompose/value/Value;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/Modifier;Lcom/arkivanov/decompose/extensions/compose/pages/PagesScrollAnimation;Lkotlin/jvm/functions/Function6;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function6;Landroidx/compose/runtime/Composer;II)V
 	public static final fun defaultHorizontalPager ()Lkotlin/jvm/functions/Function6;
 	public static final fun defaultVerticalPager ()Lkotlin/jvm/functions/Function6;
 }

extensions-compose/api/extensions-compose.klib.api

@@ -89,7 +89,9 @@ final val com.arkivanov.decompose.extensions.compose.stack.animation/isFront //
 
 final fun (com.arkivanov.decompose.extensions.compose.stack.animation/StackAnimator).com.arkivanov.decompose.extensions.compose.stack.animation/plus(com.arkivanov.decompose.extensions.compose.stack.animation/StackAnimator): com.arkivanov.decompose.extensions.compose.stack.animation/StackAnimator // com.arkivanov.decompose.extensions.compose.stack.animation/plus|plus@com.arkivanov.decompose.extensions.compose.stack.animation.StackAnimator(com.arkivanov.decompose.extensions.compose.stack.animation.StackAnimator){}[0]
 final fun <#A: kotlin/Any, #B: kotlin/Any> com.arkivanov.decompose.extensions.compose.pages/ChildPages(com.arkivanov.decompose.router.pages/ChildPages<#A, #B>, kotlin/Function1<kotlin/Int, kotlin/Unit>, androidx.compose.ui/Modifier?, com.arkivanov.decompose.extensions.compose.pages/PagesScrollAnimation?, kotlin/Function6<androidx.compose.ui/Modifier, androidx.compose.foundation.pager/PagerState, kotlin/Function1<kotlin/Int, kotlin/Any>, kotlin/Function4<androidx.compose.foundation.pager/PagerScope, kotlin/Int, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>?, kotlin/Function1<com.arkivanov.decompose/Child<#A, #B>, kotlin/Any>?, kotlin/Function5<androidx.compose.foundation.pager/PagerScope, kotlin/Int, #B, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, androidx.compose.runtime/Composer?, kotlin/Int, kotlin/Int) // com.arkivanov.decompose.extensions.compose.pages/ChildPages|ChildPages(com.arkivanov.decompose.router.pages.ChildPages<0:0,0:1>;kotlin.Function1<kotlin.Int,kotlin.Unit>;androidx.compose.ui.Modifier?;com.arkivanov.decompose.extensions.compose.pages.PagesScrollAnimation?;kotlin.Function6<androidx.compose.ui.Modifier,androidx.compose.foundation.pager.PagerState,kotlin.Function1<kotlin.Int,kotlin.Any>,kotlin.Function4<androidx.compose.foundation.pager.PagerScope,kotlin.Int,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>?;kotlin.Function1<com.arkivanov.decompose.Child<0:0,0:1>,kotlin.Any>?;kotlin.Function5<androidx.compose.foundation.pager.PagerScope,kotlin.Int,0:1,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>;androidx.compose.runtime.Composer?;kotlin.Int;kotlin.Int){0§<kotlin.Any>;1§<kotlin.Any>}[0]
+final fun <#A: kotlin/Any, #B: kotlin/Any> com.arkivanov.decompose.extensions.compose.pages/ChildPages(com.arkivanov.decompose.router.pages/ChildPages<#A, #B>, kotlin/Function1<kotlin/Int, kotlin/Unit>, androidx.compose.ui/Modifier?, com.arkivanov.decompose.extensions.compose.pages/PagesScrollAnimation?, kotlin/Function6<androidx.compose.ui/Modifier, androidx.compose.foundation.pager/PagerState, kotlin/Function1<kotlin/Int, kotlin/Any>, kotlin/Function4<androidx.compose.foundation.pager/PagerScope, kotlin/Int, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>?, kotlin/Function1<com.arkivanov.decompose/Child<#A, #B>, kotlin/Any>?, kotlin/Function6<androidx.compose.foundation.pager/PagerScope, kotlin/Int, #B, androidx.compose.foundation.pager/PagerState, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, androidx.compose.runtime/Composer?, kotlin/Int, kotlin/Int) // com.arkivanov.decompose.extensions.compose.pages/ChildPages|ChildPages(com.arkivanov.decompose.router.pages.ChildPages<0:0,0:1>;kotlin.Function1<kotlin.Int,kotlin.Unit>;androidx.compose.ui.Modifier?;com.arkivanov.decompose.extensions.compose.pages.PagesScrollAnimation?;kotlin.Function6<androidx.compose.ui.Modifier,androidx.compose.foundation.pager.PagerState,kotlin.Function1<kotlin.Int,kotlin.Any>,kotlin.Function4<androidx.compose.foundation.pager.PagerScope,kotlin.Int,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>?;kotlin.Function1<com.arkivanov.decompose.Child<0:0,0:1>,kotlin.Any>?;kotlin.Function6<androidx.compose.foundation.pager.PagerScope,kotlin.Int,0:1,androidx.compose.foundation.pager.PagerState,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>;androidx.compose.runtime.Composer?;kotlin.Int;kotlin.Int){0§<kotlin.Any>;1§<kotlin.Any>}[0]
 final fun <#A: kotlin/Any, #B: kotlin/Any> com.arkivanov.decompose.extensions.compose.pages/ChildPages(com.arkivanov.decompose.value/Value<com.arkivanov.decompose.router.pages/ChildPages<#A, #B>>, kotlin/Function1<kotlin/Int, kotlin/Unit>, androidx.compose.ui/Modifier?, com.arkivanov.decompose.extensions.compose.pages/PagesScrollAnimation?, kotlin/Function6<androidx.compose.ui/Modifier, androidx.compose.foundation.pager/PagerState, kotlin/Function1<kotlin/Int, kotlin/Any>, kotlin/Function4<androidx.compose.foundation.pager/PagerScope, kotlin/Int, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>?, kotlin/Function1<com.arkivanov.decompose/Child<#A, #B>, kotlin/Any>?, kotlin/Function5<androidx.compose.foundation.pager/PagerScope, kotlin/Int, #B, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, androidx.compose.runtime/Composer?, kotlin/Int, kotlin/Int) // com.arkivanov.decompose.extensions.compose.pages/ChildPages|ChildPages(com.arkivanov.decompose.value.Value<com.arkivanov.decompose.router.pages.ChildPages<0:0,0:1>>;kotlin.Function1<kotlin.Int,kotlin.Unit>;androidx.compose.ui.Modifier?;com.arkivanov.decompose.extensions.compose.pages.PagesScrollAnimation?;kotlin.Function6<androidx.compose.ui.Modifier,androidx.compose.foundation.pager.PagerState,kotlin.Function1<kotlin.Int,kotlin.Any>,kotlin.Function4<androidx.compose.foundation.pager.PagerScope,kotlin.Int,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>?;kotlin.Function1<com.arkivanov.decompose.Child<0:0,0:1>,kotlin.Any>?;kotlin.Function5<androidx.compose.foundation.pager.PagerScope,kotlin.Int,0:1,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>;androidx.compose.runtime.Composer?;kotlin.Int;kotlin.Int){0§<kotlin.Any>;1§<kotlin.Any>}[0]
+final fun <#A: kotlin/Any, #B: kotlin/Any> com.arkivanov.decompose.extensions.compose.pages/ChildPages(com.arkivanov.decompose.value/Value<com.arkivanov.decompose.router.pages/ChildPages<#A, #B>>, kotlin/Function1<kotlin/Int, kotlin/Unit>, androidx.compose.ui/Modifier?, com.arkivanov.decompose.extensions.compose.pages/PagesScrollAnimation?, kotlin/Function6<androidx.compose.ui/Modifier, androidx.compose.foundation.pager/PagerState, kotlin/Function1<kotlin/Int, kotlin/Any>, kotlin/Function4<androidx.compose.foundation.pager/PagerScope, kotlin/Int, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>?, kotlin/Function1<com.arkivanov.decompose/Child<#A, #B>, kotlin/Any>?, kotlin/Function6<androidx.compose.foundation.pager/PagerScope, kotlin/Int, #B, androidx.compose.foundation.pager/PagerState, androidx.compose.runtime/Composer, kotlin/Int, kotlin/Unit>, androidx.compose.runtime/Composer?, kotlin/Int, kotlin/Int) // com.arkivanov.decompose.extensions.compose.pages/ChildPages|ChildPages(com.arkivanov.decompose.value.Value<com.arkivanov.decompose.router.pages.ChildPages<0:0,0:1>>;kotlin.Function1<kotlin.Int,kotlin.Unit>;androidx.compose.ui.Modifier?;com.arkivanov.decompose.extensions.compose.pages.PagesScrollAnimation?;kotlin.Function6<androidx.compose.ui.Modifier,androidx.compose.foundation.pager.PagerState,kotlin.Function1<kotlin.Int,kotlin.Any>,kotlin.Function4<androidx.compose.foundation.pager.PagerScope,kotlin.Int,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>?;kotlin.Function1<com.arkivanov.decompose.Child<0:0,0:1>,kotlin.Any>?;kotlin.Function6<androidx.compose.foundation.pager.PagerScope,kotlin.Int,0:1,androidx.compose.foundation.pager.PagerState,androidx.compose.runtime.Composer,kotlin.Int,kotlin.Unit>;androidx.compose.runtime.Composer?;kotlin.Int;kotlin.Int){0§<kotlin.Any>;1§<kotlin.Any>}[0]
 final fun <#A: kotlin/Any, #B: kotlin/Any> com.arkivanov.decompose.extensions.compose.stack.animation.predictiveback/predictiveBackAnimation(com.arkivanov.essenty.backhandler/BackHandler, com.arkivanov.decompose.extensions.compose.stack.animation/StackAnimation<#A, #B>? = ..., kotlin/Function3<com.arkivanov.essenty.backhandler/BackEvent, com.arkivanov.decompose/Child.Created<#A, #B>, com.arkivanov.decompose/Child.Created<#A, #B>, com.arkivanov.decompose.extensions.compose.stack.animation.predictiveback/PredictiveBackAnimatable> = ..., kotlin/Function0<kotlin/Unit>): com.arkivanov.decompose.extensions.compose.stack.animation/StackAnimation<#A, #B> // com.arkivanov.decompose.extensions.compose.stack.animation.predictiveback/predictiveBackAnimation|predictiveBackAnimation(com.arkivanov.essenty.backhandler.BackHandler;com.arkivanov.decompose.extensions.compose.stack.animation.StackAnimation<0:0,0:1>?;kotlin.Function3<com.arkivanov.essenty.backhandler.BackEvent,com.arkivanov.decompose.Child.Created<0:0,0:1>,com.arkivanov.decompose.Child.Created<0:0,0:1>,com.arkivanov.decompose.extensions.compose.stack.animation.predictiveback.PredictiveBackAnimatable>;kotlin.Function0<kotlin.Unit>){0§<kotlin.Any>;1§<kotlin.Any>}[0]
 final fun <#A: kotlin/Any, #B: kotlin/Any> com.arkivanov.decompose.extensions.compose.stack.animation/stackAnimation(com.arkivanov.decompose.extensions.compose.stack.animation/StackAnimator = ..., kotlin/Boolean = ...): com.arkivanov.decompose.extensions.compose.stack.animation/StackAnimation<#A, #B> // com.arkivanov.decompose.extensions.compose.stack.animation/stackAnimation|stackAnimation(com.arkivanov.decompose.extensions.compose.stack.animation.StackAnimator;kotlin.Boolean){0§<kotlin.Any>;1§<kotlin.Any>}[0]
 final fun <#A: kotlin/Any, #B: kotlin/Any> com.arkivanov.decompose.extensions.compose.stack.animation/stackAnimation(kotlin/Boolean = ..., kotlin/Function1<com.arkivanov.decompose/Child.Created<#A, #B>, com.arkivanov.decompose.extensions.compose.stack.animation/StackAnimator?>): com.arkivanov.decompose.extensions.compose.stack.animation/StackAnimation<#A, #B> // com.arkivanov.decompose.extensions.compose.stack.animation/stackAnimation|stackAnimation(kotlin.Boolean;kotlin.Function1<com.arkivanov.decompose.Child.Created<0:0,0:1>,com.arkivanov.decompose.extensions.compose.stack.animation.StackAnimator?>){0§<kotlin.Any>;1§<kotlin.Any>}[0]

extensions-compose/api/jvm/extensions-compose.api

@@ -13,7 +13,9 @@ public final class com/arkivanov/decompose/extensions/compose/lifecycle/Lifecycl
 
 public final class com/arkivanov/decompose/extensions/compose/pages/ChildPagesKt {
 	public static final fun ChildPages (Lcom/arkivanov/decompose/router/pages/ChildPages;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/Modifier;Lcom/arkivanov/decompose/extensions/compose/pages/PagesScrollAnimation;Lkotlin/jvm/functions/Function6;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function5;Landroidx/compose/runtime/Composer;II)V
+	public static final fun ChildPages (Lcom/arkivanov/decompose/router/pages/ChildPages;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/Modifier;Lcom/arkivanov/decompose/extensions/compose/pages/PagesScrollAnimation;Lkotlin/jvm/functions/Function6;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function6;Landroidx/compose/runtime/Composer;II)V
 	public static final fun ChildPages (Lcom/arkivanov/decompose/value/Value;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/Modifier;Lcom/arkivanov/decompose/extensions/compose/pages/PagesScrollAnimation;Lkotlin/jvm/functions/Function6;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function5;Landroidx/compose/runtime/Composer;II)V
+	public static final fun ChildPages (Lcom/arkivanov/decompose/value/Value;Lkotlin/jvm/functions/Function1;Landroidx/compose/ui/Modifier;Lcom/arkivanov/decompose/extensions/compose/pages/PagesScrollAnimation;Lkotlin/jvm/functions/Function6;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function6;Landroidx/compose/runtime/Composer;II)V
 	public static final fun defaultHorizontalPager ()Lkotlin/jvm/functions/Function6;
 	public static final fun defaultVerticalPager ()Lkotlin/jvm/functions/Function6;
 }

extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPages.kt

@@ -12,6 +12,7 @@ import androidx.compose.runtime.remember
 import androidx.compose.runtime.rememberUpdatedState
 import androidx.compose.ui.Modifier
 import com.arkivanov.decompose.Child
+import com.arkivanov.decompose.ExperimentalDecomposeApi
 import com.arkivanov.decompose.Ref
 import com.arkivanov.decompose.extensions.compose.subscribeAsState
 import com.arkivanov.decompose.router.pages.ChildPages
@@ -29,6 +30,31 @@ fun <C : Any, T : Any> ChildPages(
     pager: ChildPagesPager = defaultHorizontalPager(),
     key: (Child<C, T>) -> Any = Child<*, *>::key,
     pageContent: @Composable PagerScope.(index: Int, page: T) -> Unit,
+) {
+    ChildPages(
+        pages = pages,
+        onPageSelected = onPageSelected,
+        modifier = modifier,
+        scrollAnimation = scrollAnimation,
+        pager = pager,
+        key = key,
+        pageContent = { index, page, _ -> pageContent(index, page) },
+    )
+}
+
+/**
+ * Displays a list of pages represented by [ChildPages].
+ */
+@ExperimentalDecomposeApi
+@Composable
+fun <C : Any, T : Any> ChildPages(
+    pages: Value<ChildPages<C, T>>,
+    onPageSelected: (index: Int) -> Unit,
+    modifier: Modifier = Modifier,
+    scrollAnimation: PagesScrollAnimation = PagesScrollAnimation.Disabled,
+    pager: ChildPagesPager = defaultHorizontalPager(),
+    key: (Child<C, T>) -> Any = Child<*, *>::keyHashString,
+    pageContent: @Composable PagerScope.(index: Int, page: T, PagerState) -> Unit,
 ) {
     val state by pages.subscribeAsState()
 
@@ -55,6 +81,31 @@ fun <C : Any, T : Any> ChildPages(
     pager: ChildPagesPager = defaultHorizontalPager(),
     key: (Child<C, T>) -> Any = Child<*, *>::key,
     pageContent: @Composable PagerScope.(index: Int, page: T) -> Unit,
+) {
+    ChildPages(
+        pages = pages,
+        onPageSelected = onPageSelected,
+        modifier = modifier,
+        scrollAnimation = scrollAnimation,
+        pager = pager,
+        key = key,
+        pageContent = { index, page, _ -> pageContent(index, page) },
+    )
+}
+
+/**
+ * Displays a list of pages represented by [ChildPages].
+ */
+@ExperimentalDecomposeApi
+@Composable
+fun <C : Any, T : Any> ChildPages(
+    pages: ChildPages<C, T>,
+    onPageSelected: (index: Int) -> Unit,
+    modifier: Modifier = Modifier,
+    scrollAnimation: PagesScrollAnimation = PagesScrollAnimation.Disabled,
+    pager: ChildPagesPager = defaultHorizontalPager(),
+    key: (Child<C, T>) -> Any = Child<*, *>::keyHashString,
+    pageContent: @Composable PagerScope.(index: Int, page: T, PagerState) -> Unit,
 ) {
     val selectedIndex = pages.selectedIndex.coerceAtLeast(0)
     val pageCountState = rememberUpdatedState(pages.items.size)
@@ -99,7 +150,7 @@ fun <C : Any, T : Any> ChildPages(
 
         val page = pageRef.value
         if (page != null) {
-            pageContent(pageIndex, page)
+            pageContent(pageIndex, page, state)
         }
     }
 }