1 /*
2 * Copyright 2018 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 * http://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 androidx.navigation.ui
18
19 import android.view.MenuItem
20 import androidx.navigation.NavController
21
22 /**
23 * Attempt to navigate to the [NavDestination] associated with this [MenuItem].
24 *
25 * Importantly, it assumes the [menu item id][getItemId] matches a valid
26 * [action id][androidx.navigation.NavDestination.getAction] or
27 * [destination id][androidx.navigation.NavDestination.id] to be navigated to.
28 *
29 * By default, the back stack will be popped back to the navigation graph's start destination. Menu
30 * items that have `android:menuCategory="secondary"` will not pop the back stack.
31 *
32 * @return True if the [NavController] was able to navigate to the destination.
33 */
onNavDestinationSelectednull34 public fun MenuItem.onNavDestinationSelected(navController: NavController): Boolean =
35 NavigationUI.onNavDestinationSelected(this, navController)
36