Please enable JavaScript.

Coggle requires JavaScript to display documents.

NAVIGATION - Coggle Diagram

- - - - previousBackStackEntry
  - - - default add backstack
    - - REMOVES FROM BACKSTACK ALL ROUTES UP TO THE SPECIFIED ROUTE
        
        REQUIRED INCLUSIVE
        
        IF NAVIGATE AND POPUPTO GOT SAME ROUTE
        
        if include popUpTo(Routes.HISTORY_SCREEN) (same route as navigate) will popup this screen and after going to some other route, HISTORY_SCREEN will be removed and will be redirect to the main screen
      - inclusive
        
        includes the specified route
      - Pop up to a given destination before navigating. This pops all non-matching destination routes from the back stack until the destination with a matching route is found.
    - - .popBackStack(route, inclusive)
        
        inclusive
        
        These overloads also take an inclusive boolean. It determines whether the NavController should also pop the specified destination off the back stack after having navigated to it.
        
        navController.popBackStack(R.id.destinationId, true)
        
        You can include an argument for the inclusive parameter with a value of true to indicate that the destination you have specified in popUpTo() should also pop off back stack.
        
        compose ex
        
        .popBackStack()
        Don't remove backstack - using this doesn't prevent user to come back to previous screen
        
        This does: navController.popBackStack(Routes.MAIN_SCREEN.name, false)
        
        SIMILAR TO
        
        navController.navigate(Routes.MAIN_SCREEN.name) { popUpTo(Routes.NESTED_GRAPH_AUTH.name) { inclusive = true } }
        
        IF INCLUSIVE TRUE
        
        ERROR
        
        No destination with route NESTED_GRAPH_AUTH is on the NavController's back stack. The current destination is null
        
        IF INCLUSIVE FALSE
        
        Ignoring popBackStack to route MAIN_SCREEN as it was not found on the current back stack
        
        WARNING: use navigate/popUpTo and previous target destination was probably popped up to avoid error: Ignoring popBackStack to route MAIN_SCREEN as it was not found on the current back stack :warning:
        
        :warning this error can occur and crash app: No destination with route NESTED_GRAPH_AUTH is on the NavController's back stack. The current destination is null
      - .navigateUp() :star:
        
        never exits app
        
        go to previous route
        
        navigate up already uses internally popBackStack to clear previous screens.
    - - Whether this navigation action should launch as single-top (i.e., there will be at most one copy of a given destination on the top of the back stack).
        This functions similarly to how android.content.Intent.FLAG_ACTIVITY_SINGLE_TOP works with activites.
      - you are specifying that if the destination you are navigating to is already at the top of the back stack, the system should not create a new instance of that destination but instead deliver the intent to the existing instance. This can help in maintaining a single instance of the destination screen at the top of the stack, preventing unnecessary duplication and improving the user experience by avoiding unnecessary back stack entries.
      - EXAMPLE
        
        // Navigate to the "search” destination only if we’re not already on
        
        // the "search" destination, avoiding multiple copies on the top of the back stack
        
        navController.navigate("search") { launchSingleTop = true }