Project Structure

[ken-soares]

Overview

The project is structured as followed

app\src\main\java\com\example\senpos
|   MainActivity.kt
|
\---ui
    +---components
    |       IntakeComponent.kt
    |       NavBarComponent.kt
    |       ...
    +---navigation
    |       AppNavGraph.kt
    |       Routes.kt
    |
    +---screens
    |       TodayScreen.kt
    |       ...

The main activity is the entry point of the application and is responsible of instantiating the AppNavGraph and passing the NavController to it.

Navigation

Google recommends using one activity per application and using multiple screens instead, the advantages of it being:

• A centralized navigation
• Shared state between screens
• Less bugs and performance issues
• Better handling of the stack

Our navigation structure relies on 3 components:

• NavHostController: The object that manages navigation between screens. It controls where the app goes and handles actions like navigate() and back stack operations. We should pass it to the AppNavGraph as an argument in the main activity.
• NavHost : The container that defines all possible screens in the app. It maps routes (screen names) to composable functions and sets the starting destination. It is used in the AppNavGraph composable.
• Route: A simple string wrapper sealed class that identifies a screen. It acts like an address (e.g., "home", "profile") used by the NavController to navigate between destinations.

Our screens are defined in the screens/ subdirectory and are composables which are made of components defined in the components/ subdirectory. Some components are common to every main screen like the NavBarComponent