Renamed Pages composable function to ChildPages, promoted all Child Pages API to stable #756
Conversation
WalkthroughThe recent changes enhance the stability of the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ChildPages
participant Navigator
User->>ChildPages: Request to display child pages
ChildPages->>Navigator: Route to selected child page
Navigator->>ChildPages: Render the requested child page
ChildPages-->>User: Display child page content
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (13)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPages.kt (2 hunks)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPagesFactory.kt (4 hunks)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/Pages.kt (1 hunks)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigation.kt (2 hunks)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigator.kt (1 hunks)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigatorExt.kt (7 hunks)
- extensions-compose/api/android/extensions-compose.api (1 hunks)
- extensions-compose/api/extensions-compose.klib.api (1 hunks)
- extensions-compose/api/jvm/extensions-compose.api (1 hunks)
- extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPages.kt (8 hunks)
- extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/PagesScrollAnimation.kt (1 hunks)
- extensions-compose/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPagesTest.kt (3 hunks)
- sample/shared/compose/src/commonMain/kotlin/com/arkivanov/sample/shared/pages/PagesContent.kt (2 hunks)
Files skipped from review due to trivial changes (7)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPages.kt
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/Pages.kt
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigation.kt
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigator.kt
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigatorExt.kt
- extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/PagesScrollAnimation.kt
- sample/shared/compose/src/commonMain/kotlin/com/arkivanov/sample/shared/pages/PagesContent.kt
Additional comments not posted (16)
extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPages.kt (3)
Line range hint
141-145:
LGTM!The removal of the experimental annotation indicates the API is now stable.
Line range hint
25-36:
LGTM! But verify the function usage in the codebase.The code changes are approved.
However, ensure that all function calls to
ChildPagesmatch the new signature.
Line range hint
51-95:
LGTM! But verify the function usage in the codebase.The code changes are approved.
However, ensure that all function calls to
ChildPagesmatch the new signature.extensions-compose/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPagesTest.kt (2)
Line range hint
150-156:
LGTM!The test function
setContentis correctly updated to useChildPages.
17-17: LGTM! But verify the function usage in the codebase.The class and its test functions are correctly renamed.
However, ensure that all function calls to
ChildPagesmatch the new signature.Verification successful
Function calls to
ChildPagesmatch the new signature.The instances of
ChildPagesacross the codebase have been reviewed and they all use the correct signature.
- Verified in:
sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/pages/PagesComponent.ktsample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/pages/DefaultPagesComponent.ktextensions-compose/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPagesTest.ktextensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPages.ktdecompose/src/commonTest/kotlin/com/arkivanov/decompose/router/pages/ChildPagesBackButtonTest.ktdecompose/src/commonTest/kotlin/com/arkivanov/decompose/router/pages/ChildPagesSelectLastTest.ktdecompose/src/commonTest/kotlin/com/arkivanov/decompose/router/pages/ChildPagesSelectFirstTest.ktdecompose/src/commonTest/kotlin/com/arkivanov/decompose/router/pages/ChildPagesSelectTest.ktdecompose/src/commonTest/kotlin/com/arkivanov/decompose/router/pages/ChildPagesSelectPrevTest.ktdecompose/src/commonTest/kotlin/com/arkivanov/decompose/router/pages/ChildPagesSelectNextTest.ktdecompose/src/commonTest/kotlin/com/arkivanov/decompose/router/pages/ChildPagesSavedStateTest.ktdecompose/src/commonTest/kotlin/com/arkivanov/decompose/router/pages/ChildPagesClearTest.ktdecompose/src/commonTest/kotlin/com/arkivanov/decompose/router/pages/BaseChildPagesTest.ktdecompose/src/commonTest/kotlin/com/arkivanov/decompose/router/pages/ChildPagesIntegrationTest.ktdecompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPagesFactory.ktdecompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPages.ktScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all function calls to `ChildPages` match the new signature. # Test: Search for the function usage. Expect: Only occurrences of the new signature. rg --type kotlin -A 5 $'ChildPages'Length of output: 33910
decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPagesFactory.kt (3)
Line range hint
26-51:
LGTM!The removal of the experimental annotation indicates the API is now stable.
Line range hint
72-114:
LGTM!The removal of the experimental annotation indicates the API is now stable.
Line range hint
116-116:
LGTM! But verify the class usage in the codebase.The removal of the class
PagesSavedNavStatesuggests a simplification or refactoring of state management.However, ensure that the removal does not affect other parts of the codebase.
Verification successful
LGTM! The removal of the
PagesSavedNavStateclass does not affect other parts of the codebase.
- The search command confirmed that there are no occurrences of
PagesSavedNavStatein the codebase.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all usages of `PagesSavedNavState` in the codebase. # Test: Search for the class usage. Expect: No occurrences of the class. rg --type kotlin -A 5 $'PagesSavedNavState'Length of output: 42
extensions-compose/api/android/extensions-compose.api (3)
8-9: LGTM! Verify the usage ofdefaultHorizontalPageranddefaultVerticalPager.The code changes are approved.
However, ensure that the new functions
defaultHorizontalPageranddefaultVerticalPagerare used correctly in the codebase.Verification successful
Verified the usage of
defaultHorizontalPageranddefaultVerticalPager.The functions are correctly defined and used within the
ChildPages.ktfile.
defaultHorizontalPageris used twice within theChildPagescomposable function.defaultVerticalPageris defined and used correctly.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the usage of `defaultHorizontalPager` and `defaultVerticalPager` functions in the codebase. # Test: Search for the function usage. Expect: Correct usage of the new functions. rg --type kotlin -A 5 $'defaultHorizontalPager' rg --type kotlin -A 5 $'defaultVerticalPager'Length of output: 3450
Script:
#!/bin/bash # Extract more context around the usages of `defaultHorizontalPager` and `defaultVerticalPager` in `ChildPages.kt` rg --type kotlin -A 10 -B 10 $'defaultHorizontalPager' extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPages.kt rg --type kotlin -A 10 -B 10 $'defaultVerticalPager' extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPages.kt # Search for any other references to `defaultHorizontalPager` across the entire codebase rg --type kotlin $'defaultHorizontalPager' # Search for any other references to `defaultVerticalPager` across the entire codebase rg --type kotlin $'defaultVerticalPager'Length of output: 3301
6-7: Ensure proper usage of overloadedChildPagesfunctions.The new
ChildPagesfunctions provide enhanced flexibility. Verify that the correct function overload is used in the codebase.Verification successful
Ensure proper usage of overloaded
ChildPagesfunctions.The new
ChildPagesfunctions provide enhanced flexibility. Verify that the correct function overload is used in the codebase.
Ensure proper usage of overloaded
ChildPagesfunctions.The new
ChildPagesfunctions provide enhanced flexibility. Based on the gathered context, the correct function overloads appear to be used in the codebase.
- In
PagesComponent.kt,pagesis of typeValue<ChildPages<*, KittenComponent>>, which matches the first overload.- In
DefaultPagesComponent.kt,pagesis also of typeValue<ChildPages<*, KittenComponent>>, which matches the first overload.- In
ChildPagesTest.kt, the usages ofChildPageswithitemsandselectedIndexmatch the second overload.- In
ChildPages.kt, both overloads are used correctly based on the provided contexts.No issues found with the usage of
ChildPagesoverloads.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the usage of overloaded `ChildPages` functions in the codebase. # Test: Search for `ChildPages` function usage. Expect: Correct overloads are used. rg --type kotlin -A 5 $'ChildPages'Length of output: 33910
Script:
#!/bin/bash # Description: Extract function signatures and usage contexts for `ChildPages` to verify correct overload usage. # Extract function signatures of `ChildPages` echo "Function Signatures:" rg --type kotlin --context 5 'fun <C : Any, T : Any> ChildPages' extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPages.kt # Extract context around each usage of `ChildPages` echo "Usage Contexts:" rg --type kotlin -A 10 -B 2 'ChildPages' sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/pages/PagesComponent.kt rg --type kotlin -A 10 -B 2 'ChildPages' sample/shared/shared/src/commonMain/kotlin/com/arkivanov/sample/shared/pages/DefaultPagesComponent.kt rg --type kotlin -A 10 -B 2 'ChildPages' extensions-compose/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPagesTest.kt rg --type kotlin -A 10 -B 2 'ChildPages' extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPages.kt rg --type kotlin -A 10 -B 2 'ChildPages' decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPagesFactory.ktLength of output: 11036
12-13: LGTM! Ensure singleton pattern is maintained correctly.The code changes are approved.
However, verify that the singleton pattern for
ChildPagesis maintained correctly in the codebase.extensions-compose/api/jvm/extensions-compose.api (3)
10-11: Ensure proper usage of overloadedChildPagesfunctions.The new
ChildPagesfunctions provide enhanced flexibility. Verify that the correct function overload is used in the codebase.
12-13: LGTM! Verify the usage ofdefaultHorizontalPageranddefaultVerticalPager.The code changes are approved.
16-17: LGTM! Ensure singleton pattern is maintained correctly.The code changes are approved.
extensions-compose/api/extensions-compose.klib.api (2)
89-90: Ensure proper usage of overloadedChildPagesfunctions.The new
ChildPagesfunctions provide enhanced flexibility. Verify that the correct function overload is used in the codebase.
90-90: Ensure proper usage ofpredictiveBackAnimationfunctions.The new
predictiveBackAnimationfunctions provide enhanced flexibility. Verify that the correct function overload is used in the codebase.
…ages API to stable
arkivanov
force-pushed
the
stabilize-pages
branch
from
0c9bb36 to
36c5d88
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (13)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPages.kt (2 hunks)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPagesFactory.kt (4 hunks)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/Pages.kt (1 hunks)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigation.kt (2 hunks)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigator.kt (1 hunks)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigatorExt.kt (7 hunks)
- extensions-compose/api/android/extensions-compose.api (1 hunks)
- extensions-compose/api/extensions-compose.klib.api (1 hunks)
- extensions-compose/api/jvm/extensions-compose.api (1 hunks)
- extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPages.kt (8 hunks)
- extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/PagesScrollAnimation.kt (1 hunks)
- extensions-compose/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPagesTest.kt (3 hunks)
- sample/shared/compose/src/commonMain/kotlin/com/arkivanov/sample/shared/pages/PagesContent.kt (2 hunks)
Files skipped from review as they are similar to previous changes (12)
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPages.kt
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/ChildPagesFactory.kt
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/Pages.kt
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigation.kt
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigator.kt
- decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/pages/PagesNavigatorExt.kt
- extensions-compose/api/extensions-compose.klib.api
- extensions-compose/api/jvm/extensions-compose.api
- extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPages.kt
- extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/PagesScrollAnimation.kt
- extensions-compose/src/jvmTest/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPagesTest.kt
- sample/shared/compose/src/commonMain/kotlin/com/arkivanov/sample/shared/pages/PagesContent.kt
Additional comments not posted (3)
extensions-compose/api/android/extensions-compose.api (3)
Line range hint
14-29: Ensure correct implementation of page scroll animations.The class
PagesScrollAnimationand its subclassesCustom,Default, andDisabledhandle page scroll animations. Ensure that the animations are implemented correctly and efficiently.
5-10: Ensure consistency in function naming and parameters.The class
ChildPagesKtintroduces new functionsChildPages,defaultHorizontalPager, anddefaultVerticalPager. Ensure that the function parameters and naming conventions are consistent with the rest of the codebase.Verification successful
To ensure consistency in function naming and parameters for the
ChildPagesfunctions, we need to locate their definitions in the main codebase. This will help us verify their consistency with the rest of the codebase.
To locate the definitions of the
ChildPagesfunctions in the main codebase, we need to perform a broader search. This will help ensure that we are reviewing the correct implementations.
The broader search results show multiple usages and definitions of
ChildPagesacross various files. The main implementation ofChildPagesappears to be inChildPages.kt. The definitions found in this file are crucial for verifying the consistency of function naming and parameters.Ensure consistency in function naming and parameters.
The definitions of
ChildPagesfunctions inChildPages.ktshould be reviewed to ensure they are consistent with the rest of the codebase.
- File:
extensions-compose/src/commonMain/kotlin/com/arkivanov/decompose/extensions/compose/pages/ChildPages.kt- Functions to review:
fun <C : Any, T : Any> ChildPages(pages: Value<ChildPages<C, T>>, ...)fun <C : Any, T : Any> ChildPages(pages: ChildPages<C, T>, ...)Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the consistency of function parameters and naming conventions. # Test: Search for the function definitions. Expect: Consistent naming and parameters. rg --type kotlin -A 5 $'fun ChildPages' rg --type kotlin -A 5 $'fun defaultHorizontalPager' rg --type kotlin -A 5 $'fun defaultVerticalPager'Length of output: 4040
Script:
#!/bin/bash # Description: Locate the definitions of the ChildPages functions in the main codebase. # Search for the definition of the ChildPages function in the main codebase. rg --type kotlin 'fun ChildPages'Length of output: 559
Script:
#!/bin/bash # Description: Perform a broader search to locate the definitions of the ChildPages functions in the main codebase. # Search for the definition of the ChildPages function in all Kotlin files. rg --type kotlin 'ChildPages'Length of output: 6888
12-13: Verify the singleton pattern implementation.The class
ComposableSingletons$ChildPagesKtimplements a singleton pattern. Ensure that the singleton pattern is correctly implemented and thread-safe.
Closes #752.
Summary by CodeRabbit
New Features
ChildPagesfunctionality for enhanced child page routing and animation control.ChildPagesfunctions for greater flexibility in child page management.Bug Fixes
Refactor
Pagesfunction toChildPagesfor clarity.PagesTesttoChildPagesTestto reflect the new naming.Documentation