1 /*
2  * Copyright 2021 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      https://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.google.accompanist.navigation.animation
18 
19 import androidx.compose.animation.ExperimentalAnimationApi
20 import androidx.compose.runtime.Composable
21 import androidx.navigation.NavDestination
22 import androidx.navigation.NavHostController
23 import androidx.navigation.Navigator
24 import androidx.navigation.compose.rememberNavController
25 
26 /**
27  * Creates a NavHostController that handles the adding of the [ComposeNavigator], [DialogNavigator]
28  * and [AnimatedComposeNavigator]. Additional [androidx.navigation.Navigator] instances should be
29  * added in a [androidx.compose.runtime.SideEffect] block.
30  *
31  * @see AnimatedNavHost
32  */
33 @Deprecated(
34     message = "Replace with Androidx rememberNavController. Change import to " +
35         "androidx.navigation.compose.rememberNavController",
36     replaceWith = ReplaceWith(
37         "rememberNavController(*navigators)",
38         "androidx.navigation.compose.rememberNavController"
39     )
40 )
41 @ExperimentalAnimationApi
42 @Composable
rememberAnimatedNavControllernull43 public fun rememberAnimatedNavController(
44     vararg navigators: Navigator<out NavDestination>
45 ): NavHostController = rememberNavController(*navigators)
46