DestinationSettings class

Encapsulates the settings attributes which are applied when the navigation state is updated with the the destination.

There are convenient factory constructors for commonly used settings. material - pushes the destination to the navigation stack with standard material animations. dialog - display the destination like a dialog quiet - replace the previous destination with the current one without animations.

See also:

• TransitionMethod
• DestinationTransition

Constructors

DestinationSettings({required TransitionMethod transitionMethod, required DestinationTransition transition, Destination<DestinationParameters>? redirectedFrom, bool reset = false, RouteTransitionsBuilder? transitionBuilder, bool updateHistory = true})

Creates an instance of DestinationSettings.

const

DestinationSettings.dialog()

Creates a settings to displays a destination as a modal dialog.

const

factory

DestinationSettings.material()

Creates a settings to push a destination to the top of navigation stack with a standard Material animations.

const

factory

DestinationSettings.quiet()

Creates a settings to replaces the current destination with a new one with no animations.

const

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

redirectedFrom → Destination<DestinationParameters>?

In case of redirection, contains a destination from which the redirection was performed.

final

reset → bool

Whether the stack would be cleared before adding the destination.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transition → DestinationTransition

Visual effects that would be applied on updating the stack with the destination.

final

transitionBuilder → RouteTransitionsBuilder?

Function that build custom destination transitions.

final

transitionMethod → TransitionMethod

How the destination will update the navigation stack.

final

updateHistory → bool

Controls if the destination will be added to the navigation history.

final

Methods

copyWith({TransitionMethod? transitionMethod, Destination<DestinationParameters>? redirectedFrom, bool? reset, bool? updateHistory}) → DestinationSettings

Creates a copy of this settings with the given fields replaced with the new values.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited