DesignDialogRoute<T> class

A modal dialog or alert. Push it with Navigator.push; its page is builder's, over a barrier.

It opens on a spring (dampingRatio, stiffness) and closes on the same one, or on its own (closeDampingRatio, closeStiffness), from wherever it is when it turns; under Reduce Motion it fades instead (designReduceMotionOf). As it opens it takes focus and keeps Tab inside it; as it closes, focus goes back to the node that held it when it was pushed (the button that opened it, when the keyboard pressed it).

Escape, Android's back, a barrier tap (when barrierDismissible) and DesignDialogDetails.close all close it through Navigator.maybePop, so a PopScope in it may refuse any of them. Escape closes an alert too, though its barrier does not.

A screen reader hears a dialog (an alert when isAlert) named by semanticLabel; with none, a DesignDialog inside names it by its title, or by the words for a dialog or an alert.

An alert that asks whether to delete, pushed with Navigator.of(context).push(route); the push's future answers true:

DesignDialogRoute<bool>(
  isAlert: true,
  builder: (context, details) => DesignDialog(
    title: 'Delete the draft?',
    content: const Text('It cannot be brought back.'),
    actions: [
      DesignDialogAction(
        label: 'Cancel',
        onPressed: () => Navigator.of(context).pop(false),
      ),
      DesignDialogAction(
        label: 'Delete',
        isDestructiveAction: true,
        onPressed: () => Navigator.of(context).pop(true),
      ),
    ],
    actionBuilder: (context, action, details) => Text(action.label),
  ),
)
Inheritance

Constructors

DesignDialogRoute({required DesignDialogBuilder builder, bool isAlert = false, String? semanticLabel, double dampingRatio = 1, double stiffness = 1400, double? closeDampingRatio, double? closeStiffness, Color barrierColor = const Color(0x66000000), DesignBarrierBuilder? barrierBuilder, String? barrierLabel, bool? barrierDismissible, Offset? anchorPoint, RouteSettings? settings})
A dialog whose page builder paints.

Properties

allowSnapshotting → bool
Whether the route transition will prefer to animate a snapshot of the entering/exiting routes.
no setterinherited
anchorPoint → Offset?
Which half of a folding screen it opens on: the half nearest this point (DisplayFeatureSubScreen); null: the reading start's.
final
animation → Animation<double>?
The animation that drives the route's transition and the previous route's forward transition.
no setterinherited
barrierBuilder → DesignBarrierBuilder?
Paints the barrier in place of the barrier colour (a look's own screen); null: the colour.
final
barrierColor → Color?
The barrier's colour; null while barrierBuilder paints it.
no setteroverride
barrierCurve → Curve
The curve that is used for animating the modal barrier in and out.
no setterinherited
barrierDismissible → bool
Whether a barrier tap closes it; defaults to true for a dialog and false for an alert.
no setteroverride
barrierLabel → String?
What a screen reader calls the barrier; null: DesignLocalizations.modalBarrierDismissLabel.
no setteroverride
builder → DesignDialogBuilder
Paints the dialog's page, which fills the screen: a DesignDialog places itself in it.
final
canPop → bool
Whether this route can be popped.
no setterinherited
closeDampingRatio → double?
The close spring's damping ratio (ζ); null: dampingRatio. A look whose dialog falls away on a spring of its own sets it with closeStiffness.
final
closeStiffness → double?
The close spring's stiffness (k); null: stiffness.
final
completed → Future<T?>
This future completes only once the transition itself has finished, after the overlay entries have been removed from the navigator's overlay.
no setterinherited
controller → AnimationController?
The animation controller that the route uses to drive the transitions.
no setterinherited
currentResult → T?
When this route is popped (see Navigator.pop) if the result isn't specified or if it's null, this value will be used instead.
no setterinherited
dampingRatio → double
The open spring's damping ratio (ζ), and the close spring's unless closeDampingRatio is given. Defaults to 1.
final
debugLabel → String
A short description of this route useful for debugging.
no setterinherited
delegatedTransition → DelegatedTransitionBuilder?
The DelegatedTransitionBuilder provided to the route below this one in the navigation stack.
no setterinherited
directionalTraversalEdgeBehavior → TraversalEdgeBehavior?
Controls the directional transfer of focus beyond the first and the last items of a FocusScopeNode.
finalinherited
filter → ImageFilter?
The filter to add to the barrier.
finalinherited
finishedWhenPopped → bool
Controls whether didPop calls NavigatorState.finalizeRoute.
no setterinherited
fullscreenDialog → bool
Whether this route is a full-screen dialog.
no setterinherited
hasActiveRouteBelow → bool
Whether there is at least one active route underneath this route.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hasScopedWillPopCallback → bool
True if one or more WillPopCallback callbacks exist.
no setterinherited
impliesAppBarDismissal → bool
Whether an AppBar in the route should automatically add a back button or close button.
no setterinherited
isActive → bool
Whether this route is on the navigator.
no setterinherited
isAlert → bool
Whether it is an alert, which asks for an answer: a screen reader hears an alert (SemanticsRole.alertDialog; the web's alertdialog) and a barrier tap does not close it unless barrierDismissible says so. Defaults to false: a dialog.
final
isCurrent → bool
Whether this route is the top-most route on the navigator.
no setterinherited
isFirst → bool
Whether this route is the bottom-most active route on the navigator.
no setterinherited
maintainState → bool
Whether the route should remain in memory when it is inactive.
no setterinherited
The navigator that the route is in, if any.
no setterinherited
offstage ↔ bool
Whether this route is currently offstage.
getter/setter pairinherited
opaque → bool
Whether the route obscures previous routes when the transition is complete.
no setterinherited
overlayEntries → List<OverlayEntry>
The overlay entries of this route.
no setterinherited
popDisposition → RoutePopDisposition
Returns RoutePopDisposition.doNotPop if any of the PopEntry instances registered with registerPopEntry have PopEntry.canPopNotifier set to false.
no setterinherited
popGestureEnabled → bool
Whether a pop gesture can be started by the user for this route.
no setterinherited
popGestureInProgress → bool
True if a back gesture (iOS-style back swipe or Android predictive back) is currently underway for this route.
no setterinherited
popped → Future<T?>
A future that completes when this route is popped off the navigator.
no setterinherited
receivedTransition ↔ DelegatedTransitionBuilder?
The DelegatedTransitionBuilder received from the route above this one in the navigation stack.
getter/setter pairinherited
requestFocus → bool
When the route state is updated, request focus if the current route is at the top.
no setterinherited
restorationScopeId → ValueListenable<String?>
The restoration scope ID to be used for the RestorationScope surrounding this route.
no setterinherited
reverseTransitionDuration → Duration
The duration the transition going in reverse.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secondaryAnimation → Animation<double>?
The animation for the route being pushed on top of this route. This animation lets this route coordinate with the entrance and exit transition of route pushed on top of this route.
no setterinherited
semanticLabel → String?
What a screen reader calls the dialog, usually its title; null: a DesignDialog's title names it, else DesignLocalizations.dialogLabel or DesignLocalizations.alertDialogLabel.
final
semanticsDismissible → bool
Whether the semantics of the modal barrier are included in the semantics tree.
no setterinherited
settings → RouteSettings
The settings for this route.
no setterinherited
stiffness → double
The open spring's stiffness (k), and the close spring's unless closeStiffness is given. Defaults to 1400.
final
subtreeContext → BuildContext?
The build context for the subtree containing the primary content of this route.
no setterinherited
transitionDuration → Duration
Nominal: the spring decides how long it takes (createSimulation).
no setteroverride
traversalEdgeBehavior → TraversalEdgeBehavior
Focus stays inside it: Tab from its last stop goes to its first.
no setteroverride
willDisposeAnimationController ↔ bool
Whether to takeover the controller created by createAnimationController.
getter/setter pairinherited
willHandlePopInternally → bool
Whether calling didPop would return false.
no setterinherited

Methods

addLocalHistoryEntry(LocalHistoryEntry entry) → void
Adds a local history entry to this route.
inherited
addScopedWillPopCallback(WillPopCallback callback) → void
Enables this route to veto attempts by the user to dismiss it.
inherited
buildModalBarrier() → Widget
Build the barrier for this ModalRoute, subclasses can override this method to create their own barrier with customized features such as color or accessibility focus size.
override
buildPage(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation) → Widget
Override this method to build the primary content of this route.
override
buildTransitions(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation, Widget child) → Widget
Override this method to wrap the child with one or more transition widgets that define how the route arrives on and leaves the screen.
override
canTransitionFrom(TransitionRoute previousRoute) → bool
Returns true if previousRoute should animate when this route is pushed on top of it or when then this route is popped off of it.
inherited
canTransitionTo(TransitionRoute nextRoute) → bool
Returns true if this route supports a transition animation that runs when nextRoute is pushed on top of it or when nextRoute is popped off of it.
inherited
changedExternalState() → void
Called whenever the Navigator has updated in some manner that might affect routes, to indicate that the route may wish to rebuild as well.
inherited
changedInternalState() → void
Called whenever the internal state of the route has changed.
inherited
createAnimation() → Animation<double>
Called to create the animation that exposes the current progress of the transition controlled by the animation controller created by createAnimationController().
inherited
createAnimationController() → AnimationController
Called to create the animation controller that will drive the transitions to this route from the previous one, and back to the previous route from this one.
inherited
createOverlayEntries() → Iterable<OverlayEntry>
Subclasses should override this getter to return the builders for the overlay.
inherited
createSimulation({required bool forward}) → Simulation
The spring from where the dialog is to open or gone.
override
debugTransitionCompleted() → bool
Returns true if the transition has completed.
inherited
didAdd() → void
Called after install when the route is added to the navigator.
inherited
didChangeNext(Route? nextRoute) → void
This route's next route has changed to the given new route.
inherited
didChangePrevious(Route? previousRoute) → void
This route's previous route has changed to the given new route.
inherited
didComplete(T? result) → void
The route was popped or is otherwise being removed somewhat gracefully.
inherited
didPop(T? result) → bool
A request was made to pop this route. If the route can handle it internally (e.g. because it has its own stack of internal state) then return false, otherwise return true (by returning the value of calling super.didPop). Returning false will prevent the default behavior of NavigatorState.pop.
override
didPopNext(Route nextRoute) → void
The given route, which was above this one, has been popped off the navigator.
inherited
didPush() → TickerFuture
Called after install when the route is pushed onto the navigator.
inherited
didReplace(Route? oldRoute) → void
Called after install when the route replaced another in the navigator.
inherited
dispose() → void
Discards any resources used by the object.
inherited
handleCancelBackGesture() → void
Handles a predictive back gesture ending in cancellation.
inherited
handleCommitBackGesture() → void
Handles a predictive back gesture ending successfully.
inherited
handleStartBackGesture({double progress = 0.0}) → void
Handles a predictive back gesture starting.
inherited
handleUpdateBackGestureProgress({required double progress}) → void
Handles a predictive back gesture updating as the user drags across the screen.
inherited
install() → void
Called when the route is inserted into the navigator.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onPopInvoked(bool didPop) → void
Called after a route pop was handled.
inherited
onPopInvokedWithResult(bool didPop, T? result) → void
Called after a route pop was handled.
inherited
registerPopEntry(PopEntry<Object?> popEntry) → void
Registers the existence of a PopEntry in the route.
inherited
removeLocalHistoryEntry(LocalHistoryEntry entry) → void
Remove a local history entry from this route.
inherited
removeScopedWillPopCallback(WillPopCallback callback) → void
Remove one of the callbacks run by willPop.
inherited
setState(VoidCallback fn) → void
Schedule a call to buildTransitions.
inherited
toString() → String
A string representation of this object.
inherited
unregisterPopEntry(PopEntry<Object?> popEntry) → void
Unregisters a PopEntry in the route's widget subtree.
inherited
willPop() → Future<RoutePopDisposition>
Returns RoutePopDisposition.doNotPop if any of callbacks added with addScopedWillPopCallback returns either false or null. If they all return true, the base Route.willPop's result will be returned. The callbacks will be called in the order they were added, and will only be called if all previous callbacks returned true.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited