Merge pull request #38 from realAleksha/release/1.4.0

release (1.4.0)

Author: realAleksha

README.md

@@ -157,12 +157,12 @@ The generated project will include a similar table in its README.MD file, but wi
 | Base Setup | Material 3 | [Link](docs/Base%20Setup/Material%203/overview.md) | - | [Link](docs/Base%20Setup/Material%203/usage.md) |
 | Base Setup | Koin | [Link](docs/Base%20Setup/Koin/overview.md) | - | - |
 | Base Setup | Gradle (Kotlin DSL) | [Link](docs/Base%20Setup/Gradle%20%28Kotlin%20DSL%29/overview.md) | - | - |
+| Data Flows | Ktor HTTP Client | [Link](docs/Data%20Flows/Ktor%20HTTP%20Client/overview.md) | - | [Link](docs/Data%20Flows/Ktor%20HTTP%20Client/usage.md) |
 | Data Flows | Korlibs Crypto Library | [Link](docs/Data%20Flows/Korlibs%20Crypto%20Library/overview.md) | - | [Link](docs/Data%20Flows/Korlibs%20Crypto%20Library/usage.md) |
 | Data Flows | Basic Cache API | [Link](docs/Data%20Flows/Basic%20Cache%20API/overview.md) | - | [Link](docs/Data%20Flows/Basic%20Cache%20API/usage.md) |
 | Data Flows | Basic Config API | [Link](docs/Data%20Flows/Basic%20Config%20API/overview.md) | - | [Link](docs/Data%20Flows/Basic%20Config%20API/usage.md) |
 | Data Flows | SQLDelight | [Link](docs/Data%20Flows/SQLDelight/overview.md) | - | [Link](docs/Data%20Flows/SQLDelight/usage.md) |
 | Data Flows | SQLite (Jetpack Room) | [Link](docs/Data%20Flows/SQLite%20%28Jetpack%20Room%29/overview.md) | - | [Link](docs/Data%20Flows/SQLite%20%28Jetpack%20Room%29/usage.md) |
-| Data Flows | Ktor HTTP Client | [Link](docs/Data%20Flows/Ktor%20HTTP%20Client/overview.md) | - | [Link](docs/Data%20Flows/Ktor%20HTTP%20Client/usage.md) |
 | Data Flows | Multiplatform Paging Library | [Link](docs/Data%20Flows/Multiplatform%20Paging%20Library/overview.md) | - | [Link](docs/Data%20Flows/Multiplatform%20Paging%20Library/usage.md) |
 | Data Flows | Basic Analytics API | [Link](docs/Data%20Flows/Basic%20Analytics%20API/overview.md) | - | [Link](docs/Data%20Flows/Basic%20Analytics%20API/usage.md) |
 | Data Flows | Gemini AI | [Link](docs/Data%20Flows/Gemini%20AI/overview.md) | - | [Link](docs/Data%20Flows/Gemini%20AI/usage.md) |
@@ -179,11 +179,11 @@ The generated project will include a similar table in its README.MD file, but wi
 | User Flows | Toggle Theme Button | [Link](docs/User%20Flows/Toggle%20Theme%20Button/overview.md) | - | [Link](docs/User%20Flows/Toggle%20Theme%20Button/usage.md) |
 | User Flows | Auth Flow | [Link](docs/User%20Flows/Auth%20Flow/overview.md) | - | [Link](docs/User%20Flows/Auth%20Flow/usage.md) |
 | User Flows | Passcode Flow | [Link](docs/User%20Flows/Passcode%20Flow/overview.md) | - | [Link](docs/User%20Flows/Passcode%20Flow/usage.md) |
-| User Flows | Placeholder UI | [Link](docs/User%20Flows/Placeholder%20UI/overview.md) | - | [Link](docs/User%20Flows/Placeholder%20UI/usage.md) |
 | User Flows | FileKit | [Link](docs/User%20Flows/FileKit/overview.md) | - | [Link](docs/User%20Flows/FileKit/usage.md) |
 | Dev Tools | kotlin-logging | [Link](docs/Dev%20Tools/kotlin-logging/overview.md) | - | [Link](docs/Dev%20Tools/kotlin-logging/usage.md) |
 | Dev Tools | Kermit | [Link](docs/Dev%20Tools/Kermit/overview.md) | - | [Link](docs/Dev%20Tools/Kermit/usage.md) |
 | Dev Tools | Napier | [Link](docs/Dev%20Tools/Napier/overview.md) | - | [Link](docs/Dev%20Tools/Napier/usage.md) |
+| Dev Tools | Compose Hot Reload | [Link](docs/Dev%20Tools/Compose%20Hot%20Reload/overview.md) | - | [Link](docs/Dev%20Tools/Compose%20Hot%20Reload/usage.md) |
 | Guides | README.md | [Link](docs/Guides/README.md/overview.md) | - | - |
 | Guides | Feature Showcases | [Link](docs/Guides/Feature%20Showcases/overview.md) | - | - |
 | Guides | Feature Template | [Link](docs/Guides/Feature%20Template/overview.md) | - | [Link](docs/Guides/Feature%20Template/usage.md) |

docs/Base Setup/Material 3/usage.md

@@ -6,40 +6,62 @@
 - State management: `shared.presentation.theme.ThemeState`
 - Integration config: `app.theme.ThemeConfig`
 
-This state instance is utilized by `app.theme.provide.presentation.ThemeProvider`, which is pre-defined at the app level to furnish themes for the entire application.
+This state instance is utilized by `app.theme.provide.presentation.ThemeProvider`, which is pre-defined at the app level
+to furnish themes for the entire application.
 
 ```kotlin
 @Composable
 fun App() = ViewModelProvider({ app() }) {
-    ThemeProvider {
-        AppScreen()
+        ThemeProvider {
+            AppScreen()
+        }
     }
-}
 ```
 
 ## Change Themes
 
-By default, `ThemeState` is initialized with pre-defined dark and light themes in the `presentation` module. To edit these themes:
+By default, `ThemeState` is initialized with pre-defined dark and light themes in the `app.theme` package of `app`
+module.
+
+```kotlin
+val theme = module {
+    single<ThemeState> {
+        DefaultThemeState(
+            defaultConfig = ThemeConfig(
+                defaultTheme = DsThemes.Light,
+                lightTheme = DsThemes.Light,
+                darkTheme = DsThemes.Dark,
+            )
+        )
+    }
+}
+```
+
+The themes itself are declared in `shared:presentation` module as part of the **design system**.
+
+To edit these themes:
 
 1. Visit the [Material 3 Theme Builder](https://m3.material.io/theme-builder#/custom).
 2. Customize the desired color theme.
 3. Click on the **Export** button and confirm exporting as **Jetpack Compose (Theme.kt)**.
-4. Paste the exported files (**Theme.kt** and **Color.kt**) into the package `shared.presentation.theme.m3` of the `presentation` module and update their package declaration accordingly.
-5. In the `Themes.kt` file add the following snippet:
+4. Paste the exported files (**Theme.kt** and **Color.kt**) into the package `shared.presentation.ui.theme.m3` of the
+   `shared:presentation` module and update their package declaration accordingly.
+5. In the `shared.presentation.ui.theme.DsThemes` file add the following snippet:
    ```kotlin
-   object Themes {
-      val Light = Theme(
+   object DsThemes {
+      val Light = DsTheme(
           dark = false,
-          id = "material_3_light",
+          id = "light",
           colorScheme = lightScheme
       )
 
-      val Dark = Theme(
+      val Dark = DsTheme(
           dark = true,
-          id = "material_3_dark",
+          id = "dark",
           colorScheme = darkScheme
       )
    }
    ```
 
-The themes can be declared directly in the app module. However, if you plan to use feature modules, it might be beneficial to declare the theme in the `presentation` module.
+The themes can be declared directly in the `app` module. However, if you plan to use feature modules, it might be
+beneficial to declare the theme in the `shared:presentation` module.

docs/Data Flows/Multiplatform Paging Library/usage.md

@@ -25,7 +25,7 @@ class BasicPagingViewModel(pagingSource: PagingSource) : BaseViewModel() {
 @Composable
 fun BasicPagingScreen() {
     val viewModel: BasicPagingViewModel = provideViewModel()
-    AppPagingList(
+    DsPagingList(
         pager = viewModel.pager,
         itemContent = {
             ItemBlock(item = it)
@@ -35,6 +35,6 @@ fun BasicPagingScreen() {
 
 @Composable
 private fun ItemBlock(item: String?) {
-    AppText(text = item.orEmpty())
+    DsText(text = item.orEmpty())
 }
 ```

docs/Dev Tools/Compose Hot Reload/overview.md

@@ -0,0 +1,8 @@
+# About
+
+Make changes to your UI code in a Compose Multiplatform application and see the results in real time. No restarts required. Compose Hot Reload runs your application on the JetBrains Runtime and intelligently reloads your code whenever it is changed.
+
+# Links
+
+- [Official Site](https://github.com/JetBrains/compose-hot-reload)
+- [Integration Guide](https://github.com/JetBrains/compose-hot-reload?tab=readme-ov-file#getting-started)

docs/Dev Tools/Compose Hot Reload/usage.md

@@ -0,0 +1,11 @@
+# Usage
+
+## Overview
+
+The plugin is pre-configured in the `app` module.
+
+To start your app in **Hot Reload** mode, simply run:
+
+```
+./gradlew :app:runHot
+```

docs/User Flows/Adaptive Navigation/usage.md

@@ -33,22 +33,22 @@ class NavigationViewModel : BaseViewModel() {
             route = ARoute,
             onRoute = onRoute,
             label = "Page A",
-            activeIcon = AppIcons.wineBar,
-            inactiveIcon = AppIcons.wineBar,
+            activeIcon = DsIcons.wineBar,
+            inactiveIcon = DsIcons.wineBar,
         ),
         createItem(
             route = BRoute,
             onRoute = onRoute,
             label = "Page B",
-            activeIcon = AppIcons.localDrink,
-            inactiveIcon = AppIcons.localDrink,
+            activeIcon = DsIcons.localDrink,
+            inactiveIcon = DsIcons.localDrink,
         ),
         createItem(
             route = CRoute,
             onRoute = onRoute,
             label = "Page C",
-            activeIcon = AppIcons.coffee,
-            inactiveIcon = AppIcons.coffee,
+            activeIcon = DsIcons.coffee,
+            inactiveIcon = DsIcons.coffee,
         )
     )
     ...

docs/User Flows/Bottom Navigation/usage.md

@@ -33,22 +33,22 @@ class NavigationViewModel : BaseViewModel() {
             route = ARoute,
             onRoute = onRoute,
             label = "Page A",
-            activeIcon = AppIcons.wineBar,
-            inactiveIcon = AppIcons.wineBar,
+            activeIcon = DsIcons.wineBar,
+            inactiveIcon = DsIcons.wineBar,
         ),
         createItem(
             route = BRoute,
             onRoute = onRoute,
             label = "Page B",
-            activeIcon = AppIcons.localDrink,
-            inactiveIcon = AppIcons.localDrink,
+            activeIcon = DsIcons.localDrink,
+            inactiveIcon = DsIcons.localDrink,
         ),
         createItem(
             route = CRoute,
             onRoute = onRoute,
             label = "Page C",
-            activeIcon = AppIcons.coffee,
-            inactiveIcon = AppIcons.coffee,
+            activeIcon = DsIcons.coffee,
+            inactiveIcon = DsIcons.coffee,
         )
     )
     ...

docs/User Flows/Coil Image Library/usage.md

@@ -6,12 +6,12 @@ The usage guide is best described in the official component [documentation](http
 
 The inclusion of this component adds the dependency on this component and provides some general examples of how it can be used.
 
-In addition, it also extends the behaviour of the design component `AppIcon` with an extra model. See the example below.
+In addition, it also extends the behavior of the design component `DsIcon` with an extra model. See the example below.
 
 ## Example
 
 ```kotlin
-AppIcon(
+DsIcon(
     model = UrlModel("https://picsum.photos/id/1/200/300")
 )
 ```

docs/User Flows/Dismissible Navigation/usage.md

@@ -33,22 +33,22 @@ class NavigationViewModel : BaseViewModel() {
             route = ARoute,
             onRoute = onRoute,
             label = "Page A",
-            activeIcon = AppIcons.wineBar,
-            inactiveIcon = AppIcons.wineBar,
+            activeIcon = DsIcons.wineBar,
+            inactiveIcon = DsIcons.wineBar,
         ),
         createItem(
             route = BRoute,
             onRoute = onRoute,
             label = "Page B",
-            activeIcon = AppIcons.localDrink,
-            inactiveIcon = AppIcons.localDrink,
+            activeIcon = DsIcons.localDrink,
+            inactiveIcon = DsIcons.localDrink,
         ),
         createItem(
             route = CRoute,
             onRoute = onRoute,
             label = "Page C",
-            activeIcon = AppIcons.coffee,
-            inactiveIcon = AppIcons.coffee,
+            activeIcon = DsIcons.coffee,
+            inactiveIcon = DsIcons.coffee,
         )
     )
     ...

docs/User Flows/FileKit/usage.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-**Component**: `shared.presentation.ui.component.AppFilePicker`  
+**Component**: `shared.presentation.ui.component.DsFilePicker`  
 **Showcases**: `app.showcases.presentation.userflow.component.filepicker`
 
 The component provides a general facade to abstract the underlying framework, allowing for easier replacement or modification in the future.
@@ -11,25 +11,25 @@ The component provides a general facade to abstract the underlying framework, al
 
 ```kotlin
 @Composable
-fun AppFilePickerUsage() {
+fun DsFilePickerUsage() {
     val filePicker = getFileLauncher(onResult = { files ->
         // process the selected files
     })
-    AppElevatedButton(text = "Select files", onClick = filePicker::launch)
+    DsElevatedButton(text = "Select files", onClick = filePicker::launch)
 
     val imagesPicker = getImageLauncher(onResult = { images ->
         // process the selected images
     })
-    AppElevatedButton(text = "Select images", onClick = imagesPicker::launch)
+    DsElevatedButton(text = "Select images", onClick = imagesPicker::launch)
 
     val videoPicker = getVideoLauncher(onResult = { videos ->
         // process the selected videos
     })
-    AppElevatedButton(text = "Select videos", onClick = videoPicker::launch)
+    DsElevatedButton(text = "Select videos", onClick = videoPicker::launch)
 
     val mediaPicker = getMediaLauncher(onResult = { media ->
         // process the selected media
     })
-    AppElevatedButton(text = "Select media", onClick = mediaPicker::launch)
+    DsElevatedButton(text = "Select media", onClick = mediaPicker::launch)
 }
 ```