| /* |
| * Copyright 2020 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package androidx.navigation.compose |
| |
| import androidx.compose.runtime.Composable |
| import androidx.compose.ui.window.DialogProperties |
| import androidx.navigation.NamedNavArgument |
| import androidx.navigation.NavBackStackEntry |
| import androidx.navigation.NavDeepLink |
| import androidx.navigation.NavGraphBuilder |
| import androidx.navigation.get |
| |
| /** |
| * Add the [Composable] to the [NavGraphBuilder] |
| * |
| * @param route route for the destination |
| * @param arguments list of arguments to associate with destination |
| * @param deepLinks list of deep links to associate with the destinations |
| * @param content composable for the destination |
| */ |
| public fun NavGraphBuilder.composable( |
| route: String, |
| arguments: List<NamedNavArgument> = emptyList(), |
| deepLinks: List<NavDeepLink> = emptyList(), |
| content: @Composable (NavBackStackEntry) -> Unit |
| ) { |
| addDestination( |
| ComposeNavigator.Destination(provider[ComposeNavigator::class], content).apply { |
| this.route = route |
| arguments.forEach { (argumentName, argument) -> |
| addArgument(argumentName, argument) |
| } |
| deepLinks.forEach { deepLink -> |
| addDeepLink(deepLink) |
| } |
| } |
| ) |
| } |
| |
| /** |
| * Construct a nested [NavGraph] |
| * |
| * @param startDestination the starting destination's route for this NavGraph |
| * @param route the destination's unique route |
| * @param arguments list of arguments to associate with destination |
| * @param deepLinks list of deep links to associate with the destinations |
| * @param builder the builder used to construct the graph |
| * |
| * @return the newly constructed nested NavGraph |
| */ |
| public fun NavGraphBuilder.navigation( |
| startDestination: String, |
| route: String, |
| arguments: List<NamedNavArgument> = emptyList(), |
| deepLinks: List<NavDeepLink> = emptyList(), |
| builder: NavGraphBuilder.() -> Unit |
| ) { |
| addDestination( |
| NavGraphBuilder(provider, startDestination, route).apply(builder).build().apply { |
| arguments.forEach { (argumentName, argument) -> |
| addArgument(argumentName, argument) |
| } |
| deepLinks.forEach { deepLink -> |
| addDeepLink(deepLink) |
| } |
| } |
| ) |
| } |
| |
| /** |
| * Add the [Composable] to the [NavGraphBuilder] that will be hosted within a |
| * [androidx.compose.ui.window.Dialog]. This is suitable only when this dialog represents |
| * a separate screen in your app that needs its own lifecycle and saved state, independent |
| * of any other destination in your navigation graph. For use cases such as `AlertDialog`, |
| * you should use those APIs directly in the [composable] destination that wants to show that |
| * dialog. |
| * |
| * @param route route for the destination |
| * @param arguments list of arguments to associate with destination |
| * @param deepLinks list of deep links to associate with the destinations |
| * @param dialogProperties properties that should be passed to [androidx.compose.ui.window.Dialog]. |
| * @param content composable content for the destination that will be hosted within the Dialog |
| */ |
| public fun NavGraphBuilder.dialog( |
| route: String, |
| arguments: List<NamedNavArgument> = emptyList(), |
| deepLinks: List<NavDeepLink> = emptyList(), |
| dialogProperties: DialogProperties = DialogProperties(), |
| content: @Composable (NavBackStackEntry) -> Unit |
| ) { |
| addDestination( |
| DialogNavigator.Destination( |
| provider[DialogNavigator::class], |
| dialogProperties, |
| content |
| ).apply { |
| this.route = route |
| arguments.forEach { (argumentName, argument) -> |
| addArgument(argumentName, argument) |
| } |
| deepLinks.forEach { deepLink -> |
| addDeepLink(deepLink) |
| } |
| } |
| ) |
| } |