Solivagant (#70)

* basic desktop

* ktlint

* basic android

* basic android

Author: hoc081098

.editorconfig

@@ -8,14 +8,20 @@ insert_final_newline=true
 [*.{kt,kts}]
 ij_kotlin_imports_layout=*
 ij_continuation_indent_size=4
+ij_kotlin_allow_trailing_comma_on_call_site=true
+ij_kotlin_allow_trailing_comma=true
 ktlint_standard_filename=disabled
 ktlint_standard_package-name=disabled
 ktlint_standard_property-naming=disabled
 ktlint_standard_function-naming=disabled
-filename=disabled
-ktlint_experimental=enabled
+ktlint_experimental=disabled
 ktlint_code_style=ktlint_official
+ktlint_standard_argument-list-wrapping=disabled
+ktlint_standard_multiline-expression-wrapping=disabled
+ktlint_standard_string-template-indent=disabled
+max_line_length=120
 [*.kts]
-ktlint_standard_function-literal=disabled
+max_line_length=400
+ktlint_standard_chain-wrapping=disabled
 [*.xml]
 indent_size=4

README.md

@@ -71,138 +71,10 @@ is configured correctly:
    [✓] Android Studio
    [✓] Xcode
    [✓] Cocoapods
-   
+
    Conclusion:
      ✓ Your system is ready for Kotlin Multiplatform Mobile development!
    ```
 
 Otherwise, KDoctor will highlight which parts of your setup still need to be configured and will suggest a way to fix
 them.
-
-#### Examine the project structure
-
-Open the project in Android Studio and switch the view from **Android** to **Project** to see all the files and targets
-belonging to the project
-
-##### `desktopApp`
-
-This is a Kotlin module that builds into a desktop application. It uses Gradle as the build system. The `desktopApp`
-module depends on and uses the `shared` module as a regular library.
-
-##### `androidApp`
-
-This is a Kotlin module that builds into an Android application. It uses Gradle as the build system.
-The `androidApp` module depends on and uses the `shared` module as a regular Android library.
-
-##### `iosApp`
-
-This is an Xcode project that builds into an iOS application.
-It depends on and uses the `shared` module as a CocoaPods dependency.
-
-### Run your application
-
-#### On desktop
-
-To run your desktop application in Android Studio, select `desktopApp` in the list of run configurations and click **Run**:
-
-<img src="readme_images/run_on_desktop.png" height="60px"><br />
-
-You can also run Gradle tasks in the terminal:
-
-* `./gradlew run` to run application
-* `./gradlew package` to store native distribution into `build/compose/binaries`
-
-#### On Android
-
-To run your application on an Android emulator:
-
-1. Ensure you have an Android virtual device available.
-   Otherwise, [create one](https://developer.android.com/studio/run/managing-avds#createavd).
-2. In the list of run configurations, select `androidApp`.
-3. Choose your virtual device and click **Run**:
-
-    <img src="readme_images/run_on_android.png" height="60px"><br />      
-
-<details>
-  <summary>Alternatively, use Gradle</summary>
-
-To install an Android application on a real Android device or an emulator, run `./gradlew installDebug` in the terminal.
-
-</details>
-
-#### On iOS
-
-##### Running on a simulator
-
-To run your application on an iOS simulator in Android Studio, modify the `iosApp` run configuration:
-
-1. In the list of run configurations, select **Edit Configurations**:
-
-   <img src="readme_images/edit_run_config.png" height="200px">
-
-2. Navigate to **iOS Application** | **iosApp**.
-3. In the **Execution target** list, select your target device. Click **OK**:
-
-   <img src="readme_images/target_device.png" height="400px">
-
-4. The `iosApp` run configuration is now available. Click **Run** next to your virtual device
-
-##### Running on a real iOS device
-
-You can run your Compose Multiplatform application on a real iOS device for free.
-To do so, you'll need the following:
-
-* The `TEAM_ID` associated with your [Apple ID](https://support.apple.com/en-us/HT204316)
-* The iOS device registered in Xcode
-
-> **Note**
-> Before you continue, we suggest creating a simple "Hello, world!" project in Xcode to ensure you can successfully run
-> apps on your device.
-> You can follow the instructions below or watch
-> this [Stanford CS193P lecture recording](https://youtu.be/bqu6BquVi2M?start=716&end=1399).
-
-<details>
-<summary>How to create and run a simple project in Xcode</summary>
-
-1. On the Xcode welcome screen, select **Create a new project in Xcode**.
-2. On the **iOS** tab, choose the **App** template. Click **Next**.
-3. Specify the product name and keep other settings default. Click **Next**.
-4. Select where to store the project on your computer and click **Create**. You'll see an app that displays "Hello,
-   world!" on the device screen.
-5. At the top of your Xcode screen, click on the device name near the **Run** button.
-6. Plug your device into the computer. You'll see this device in the list of run options.
-7. Choose your device and click **Run**.
-
-</details>
-
-###### Finding your Team ID
-
-In the terminal, run `kdoctor --team-ids` to find your Team ID.
-KDoctor will list all Team IDs currently configured on your system, for example:
-
-```text
-3ABC246XYZ (Max Sample)
-ZABCW6SXYZ (SampleTech Inc.)
-```
-
-<details>
-<summary>Alternative way to find your Team ID</summary>
-
-If KDoctor doesn't work for you, try this alternative method:
-
-1. In Android Studio, run the `iosApp` configuration with the selected real device. The build should fail.
-2. Go to Xcode and select **Open a project or file**.
-3. Navigate to the `iosApp/iosApp.xcworkspace` file of your project.
-4. In the left-hand menu, select `iosApp`.
-5. Navigate to **Signing & Capabilities**.
-6. In the **Team** list, select your team.
-
-If you haven't set up your team yet, use the **Add account** option and follow the steps.
-
-</details>
-
-To run the application, set the `TEAM_ID`:
-
-1. In the template, navigate to the `iosApp/Configuration/Config.xcconfig` file.
-2. Set your `TEAM_ID`.
-3. Re-open the project in Android Studio. It should show the registered iOS device in the `iosApp` run configuration.

androidApp/src/androidMain/kotlin/com/hoc081098/compose_multiplatform_kmpviewmodel_sample/MainActivity.kt

@@ -4,11 +4,13 @@ import android.os.Bundle
 import androidx.activity.compose.setContent
 import androidx.appcompat.app.AppCompatActivity
 import androidx.compose.runtime.remember
-import com.freeletics.khonshu.navigation.compose.NavHost
 import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.common_ui.theme.AppTheme
 import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.koin_compose_utils.koinInjectSetMultibinding
-import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.navigation_shared.SearchPhotoRoute
+import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.navigation_shared.SearchPhotoScreenRoute
+import com.hoc081098.solivagant.navigation.NavDestination
+import com.hoc081098.solivagant.navigation.NavHost
 import io.github.aakira.napier.Napier
+import kotlinx.collections.immutable.toImmutableSet
 
 class MainActivity : AppCompatActivity() {
   override fun onCreate(savedInstanceState: Bundle?) {
@@ -17,17 +19,12 @@ class MainActivity : AppCompatActivity() {
     setContent {
       AppTheme {
         NavHost(
-          startRoute = SearchPhotoRoute as com.freeletics.khonshu.navigation.NavRoot,
-          destinations = koinInjectSetMultibinding(AllDestinationsQualifier),
-          destinationChangedCallback =
-            remember {
-              { route ->
-                Napier.d(
-                  message = "Destination changed: $route",
-                  tag = "MainActivity",
-                )
-              }
-            },
+          startRoute = SearchPhotoScreenRoute,
+          destinations = koinInjectSetMultibinding<NavDestination>(AllDestinationsQualifier)
+            .let { remember(it) { it.toImmutableSet() } },
+          destinationChangedCallback = { route ->
+            Napier.d(message = "Destination changed: $route", tag = "MainActivity")
+          },
         )
       }
     }

androidApp/src/androidMain/kotlin/com/hoc081098/compose_multiplatform_kmpviewmodel_sample/navigation.kt

@@ -1,18 +1,15 @@
 package com.hoc081098.compose_multiplatform_kmpviewmodel_sample
 
 import androidx.compose.runtime.Stable
-import androidx.compose.runtime.remember
-import com.freeletics.khonshu.navigation.NavEventNavigator
-import com.freeletics.khonshu.navigation.compose.NavDestination
-import com.freeletics.khonshu.navigation.compose.NavigationSetup
-import com.freeletics.khonshu.navigation.compose.ScreenDestination
 import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.koin_utils.declareSetMultibinding
 import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.koin_utils.intoSetMultibinding
-import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.navigation_shared.PhotoDetailRoute
-import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.navigation_shared.SearchPhotoRoute
+import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.navigation_shared.PhotoDetailScreenRoute
+import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.navigation_shared.SearchPhotoScreenRoute
 import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.photo_detail.PhotoDetailScreen
 import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.search_photo.SearchPhotoScreen
-import org.koin.compose.koinInject
+import com.hoc081098.solivagant.navigation.NavDestination
+import com.hoc081098.solivagant.navigation.NavEventNavigator
+import com.hoc081098.solivagant.navigation.ScreenDestination
 import org.koin.core.module.dsl.singleOf
 import org.koin.core.qualifier.qualifier
 import org.koin.dsl.module
@@ -29,39 +26,20 @@ val NavigationModule =
     declareSetMultibinding<NavDestination>(qualifier = AllDestinationsQualifier)
 
     intoSetMultibinding(
-      key = SearchPhotoRoute::class.java,
+      key = SearchPhotoScreenRoute::class.java,
       multibindingQualifier = AllDestinationsQualifier,
     ) {
-      ScreenDestination<SearchPhotoRoute> { route ->
-        val navigator = koinInject<NavEventNavigator>()
-
-        NavigationSetup(navigator)
-
-        SearchPhotoScreen(
-          route = route,
-          navigateToPhotoDetail =
-            remember(navigator) {
-              {
-                navigator.navigateTo(PhotoDetailRoute(id = it))
-              }
-            },
-        )
+      ScreenDestination<SearchPhotoScreenRoute> {
+        SearchPhotoScreen(route = it)
       }
     }
 
     intoSetMultibinding(
-      key = PhotoDetailRoute::class.java,
+      key = PhotoDetailScreenRoute::class.java,
       multibindingQualifier = AllDestinationsQualifier,
     ) {
-      ScreenDestination<PhotoDetailRoute> { route ->
-        val navigator = koinInject<NavEventNavigator>()
-
-        NavigationSetup(navigator)
-
-        PhotoDetailScreen(
-          route = route,
-          onNavigationBack = remember(navigator) { navigator::navigateBack },
-        )
+      ScreenDestination<PhotoDetailScreenRoute> {
+        PhotoDetailScreen(route = it)
       }
     }
   }

build.gradle.kts

@@ -23,7 +23,7 @@ plugins {
 
 allprojects {
   configurations.all {
-    resolutionStrategy.eachDependency { ->
+    resolutionStrategy.eachDependency {
       if (requested.group == "io.github.hoc081098") {
         // Check for updates every build
         resolutionStrategy.cacheChangingModulesFor(30, TimeUnit.MINUTES)

core/common_ui_shared/src/commonMain/kotlin/com/hoc081098/compose_multiplatform_kmpviewmodel_sample/common_ui/theme/Theme.kt

@@ -78,9 +78,7 @@ private val DarkColors =
 @Composable
 fun AppTheme(
   useDarkTheme: Boolean = isSystemInDarkTheme(),
-  content:
-    @Composable()
-    () -> Unit,
+  content: @Composable () -> Unit,
 ) {
   val colors =
     if (!useDarkTheme) {

core/navigation_shared/build.gradle.kts

@@ -52,8 +52,9 @@ kotlin {
   sourceSets {
     val commonMain by getting {
       dependencies {
-        api(projects.libraries.navigation)
         compileOnly("org.jetbrains.compose.runtime:runtime:${org.jetbrains.compose.ComposeBuildConfig.composeVersion}")
+
+        api(libs.solivagant.navigation)
       }
     }
     val commonTest by getting {

core/navigation_shared/src/commonMain/kotlin/com/hoc081098/compose_multiplatform_kmpviewmodel_sample/navigation_shared/appRoutes.common.kt

@@ -1,16 +1,16 @@
 package com.hoc081098.compose_multiplatform_kmpviewmodel_sample.navigation_shared
 
 import androidx.compose.runtime.Immutable
-import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.navigation.NavRoot
-import com.hoc081098.compose_multiplatform_kmpviewmodel_sample.navigation.NavRoute
 import com.hoc081098.kmp.viewmodel.parcelable.Parcelize
+import com.hoc081098.solivagant.navigation.NavRoot
+import com.hoc081098.solivagant.navigation.NavRoute
 
 @Immutable
 @Parcelize
-data object SearchPhotoRoute : NavRoute, NavRoot
+data object SearchPhotoScreenRoute : NavRoot
 
 @Immutable
 @Parcelize
-data class PhotoDetailRoute(
+data class PhotoDetailScreenRoute(
   val id: String,
 ) : NavRoute

desktopApp/build.gradle.kts

@@ -43,7 +43,6 @@ kotlin {
         implementation(projects.libraries.koinUtils)
         implementation(projects.libraries.koinComposeUtils)
         implementation(projects.libraries.coroutinesUtils)
-        implementation(projects.libraries.navigation)
 
         // Feature modules
         implementation(projects.features.featureSearchPhotoShared)