Class NavOptions

NavOptions stores special options for navigate actions

Inheritance

object

NavOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.AppUI.Navigation

Assembly: Unity.AppUI.Navigation.dll

Syntax

[Serializable]
public class NavOptions

Properties

enterAnim

The animation to use when navigating to the destination.

Declaration

public NavigationAnimation enterAnim { get; set; }

Property Value

Type	Description
NavigationAnimation

exitAnim

The animation to use when navigating away from the destination.

Declaration

public NavigationAnimation exitAnim { get; set; }

Property Value

Type	Description
NavigationAnimation

launchSingleTop

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).

Declaration

public bool launchSingleTop { get; set; }

Property Value

Type	Description
bool

popEnterAnim

The custom enter Animation/Animator that should be run when this destination is popped from the back stack.

Declaration

public NavigationAnimation popEnterAnim { get; set; }

Property Value

Type	Description
NavigationAnimation

popExitAnim

The custom exit Animation/Animator that should be run when this destination is popped from the back stack.

Declaration

public NavigationAnimation popExitAnim { get; set; }

Property Value

Type	Description
NavigationAnimation

popUpToInclusive

Whether the target destination in PopUpTo should be popped from the back stack.

Declaration

public bool popUpToInclusive { get; set; }

Property Value

Type	Description
bool

popUpToRoute

Route for the destination to pop up to before navigating. When set, all non-matching destinations should be popped from the back stack.

Declaration

public NavDestination popUpToRoute { get; set; }

Property Value

Type	Description
NavDestination

popUpToSaveState

Whether the back stack and the state of all destinations between the current destination and popUpToId should be saved for later restoration

Declaration

public bool popUpToSaveState { get; set; }

Property Value

Type	Description
bool

popUpToStrategy

Strategy for popping up to a destination.

Declaration

public PopupToStrategy popUpToStrategy { get; set; }

Property Value

Type	Description
PopupToStrategy

restoreState

Whether this navigation action should restore any state previously saved by Builder.setPopUpTo or the popUpToSaveState attribute.

Declaration

public bool restoreState { get; set; }

Property Value

Type	Description
bool