androidx.navigation.fragment
Classes
AbstractListDetailFragment |
A fragment supports adaptive two-pane layout. |
DialogFragmentNavigator |
Navigator that uses |
DialogFragmentNavigator.Destination |
NavDestination specific to |
DialogFragmentNavigatorDestinationBuilder |
DSL for constructing a new |
FragmentNavigator |
Navigator that navigates through |
FragmentNavigator.Destination |
NavDestination specific to |
FragmentNavigator.Extras |
Extras that can be passed to FragmentNavigator to enable Fragment specific behavior |
FragmentNavigator.Extras.Builder |
Builder for constructing new |
FragmentNavigatorDestinationBuilder |
DSL for constructing a new |
NavHostFragment |
NavHostFragment provides an area within your layout for self-contained navigation to occur. |
Top-level functions summary
FragmentNavigator.Extras |
FragmentNavigatorExtras(vararg sharedElements: Pair<View, String>)Create a new |
Extension functions summary
Top-level functions
FragmentNavigatorExtras
fun FragmentNavigatorExtras(vararg sharedElements: Pair<View, String>): FragmentNavigator.Extras
Create a new FragmentNavigator.Extras instance with the given shared elements
| Parameters | |
|---|---|
vararg sharedElements: Pair<View, String> |
One or more pairs of View+String names to be passed through to |
Extension functions
dialog
inline fun <F : DialogFragment> NavGraphBuilder.dialog(id: @IdRes Int): Unit
Construct a new DialogFragmentNavigator.Destination
dialog
inline fun <F : DialogFragment> NavGraphBuilder.dialog(route: String): Unit
Construct a new DialogFragmentNavigator.Destination
| Parameters | |
|---|---|
route: String |
the destination's unique route |
dialog
inline fun <F : DialogFragment, T : Any> NavGraphBuilder.dialog(
typeMap: Map<KType, NavType<*>> = emptyMap()
): Unit
Construct a new DialogFragmentNavigator.Destination
dialog
inline fun <F : DialogFragment> NavGraphBuilder.dialog(
id: @IdRes Int,
builder: DialogFragmentNavigatorDestinationBuilder.() -> Unit
): Unit
Construct a new DialogFragmentNavigator.Destination
| Parameters | |
|---|---|
id: @IdRes Int |
the destination's unique id |
builder: DialogFragmentNavigatorDestinationBuilder.() -> Unit |
the builder used to construct the fragment destination |
dialog
inline fun <F : DialogFragment> NavGraphBuilder.dialog(
route: String,
builder: DialogFragmentNavigatorDestinationBuilder.() -> Unit
): Unit
Construct a new DialogFragmentNavigator.Destination
| Parameters | |
|---|---|
route: String |
the destination's unique route |
builder: DialogFragmentNavigatorDestinationBuilder.() -> Unit |
the builder used to construct the fragment destination |
dialog
inline fun <F : DialogFragment, T : Any> NavGraphBuilder.dialog(
typeMap: Map<KType, NavType<*>> = emptyMap(),
builder: DialogFragmentNavigatorDestinationBuilder.() -> Unit
): Unit
Construct a new DialogFragmentNavigator.Destination
| Parameters | |
|---|---|
<T : Any> |
the destination's unique route from a |
typeMap: Map<KType, NavType<*>> = emptyMap() |
map of destination arguments' kotlin type |
builder: DialogFragmentNavigatorDestinationBuilder.() -> Unit |
the builder used to construct the fragment destination |
findNavController
fun Fragment.findNavController(): NavController
Find a NavController given a Fragment
Calling this on a Fragment that is not a NavHostFragment or within a NavHostFragment will result in an IllegalStateException
fragment
inline fun <F : Fragment> NavGraphBuilder.fragment(id: @IdRes Int): Unit
Construct a new FragmentNavigator.Destination
fragment
inline fun <F : Fragment> NavGraphBuilder.fragment(route: String): Unit
Construct a new FragmentNavigator.Destination
| Parameters | |
|---|---|
route: String |
the destination's unique route |
fragment
inline fun <F : Fragment, T : Any> NavGraphBuilder.fragment(
typeMap: Map<KType, NavType<*>> = emptyMap()
): Unit
Construct a new FragmentNavigator.Destination
fragment
inline fun <F : Fragment> NavGraphBuilder.fragment(id: @IdRes Int, builder: FragmentNavigatorDestinationBuilder.() -> Unit): Unit
Construct a new FragmentNavigator.Destination
| Parameters | |
|---|---|
id: @IdRes Int |
the destination's unique id |
builder: FragmentNavigatorDestinationBuilder.() -> Unit |
the builder used to construct the fragment destination |
fragment
inline fun <F : Fragment> NavGraphBuilder.fragment(route: String, builder: FragmentNavigatorDestinationBuilder.() -> Unit): Unit
Construct a new FragmentNavigator.Destination
| Parameters | |
|---|---|
route: String |
the destination's unique route |
builder: FragmentNavigatorDestinationBuilder.() -> Unit |
the builder used to construct the fragment destination |
fragment
inline fun <F : Fragment, T : Any> NavGraphBuilder.fragment(
typeMap: Map<KType, NavType<*>> = emptyMap(),
builder: FragmentNavigatorDestinationBuilder.() -> Unit
): Unit
Construct a new FragmentNavigator.Destination
| Parameters | |
|---|---|
<T : Any> |
the destination's unique route from a |
typeMap: Map<KType, NavType<*>> = emptyMap() |
map of destination arguments' kotlin type |
builder: FragmentNavigatorDestinationBuilder.() -> Unit |
the builder used to construct the fragment destination |
navArgs
@MainThread
inline fun <Args : NavArgs> Fragment.navArgs(): NavArgsLazy<Args>
Returns a Lazy delegate to access the Fragment's arguments as an Args instance.
It is strongly recommended that this method only be used when the Fragment is created by androidx.navigation.NavController.navigate with the corresponding androidx.navigation.NavDirections object, which ensures that the required arguments are present.
class MyFragment : Fragment() {
val args: MyFragmentArgs by navArgs()
}
This property can be accessed only after the Fragment's constructor.