DesignBottomSheetRoute<T> class
A modal bottom sheet. Push it with Navigator.push; its panel is
builder's, the screen's width, rising from the bottom edge.
With snapSizes it rests at one of them, each a share of the room it has (the screen less the on-screen keyboard, and the top inset with useSafeArea), opening at initialSize, and is laid out at its size, so a footer at its bottom shows at every size. With none it rests at its content's own height, at most the room.
It opens, settles and closes on a spring (dampingRatio, stiffness), or closes on its own (closeDampingRatio, closeStiffness); under Reduce Motion it fades instead of rising. A drag (enableDrag) moves it with the finger, from where it is drawn: past its largest size it gives a little and resists; below its smallest it slides away. Let go, it settles on the size nearest, or, flung, on the next one the fling points to; below half its smallest size, or flung down from there, it closes. Its content's scroll view hands drags over (DesignBottomSheetDetails.scrollController).
It closes through Navigator.maybePop on Escape, Android's back, a
barrier tap (barrierDismissible), a drag and
DesignBottomSheetDetails.close, so a PopScope may refuse any of them;
refused, a dragged sheet springs back. Focus moves into it and stays
there, and goes back to what held it as it closes. A screen reader hears
it named by semanticLabel, and can dismiss it.
The haptics table (DesignHaptics) plays thresholdCrossed as a drag
passes the point where letting go closes it, and selectionChanged as a
drag settles it on another size.
DesignBottomSheetRoute<void>(
snapSizes: const [0.5, 1],
builder: (context, details) => ListView(
controller: details.scrollController,
children: [for (var i = 0; i < 30; i++) Text('Row $i')],
),
)
- Inheritance
-
- Object
- Route<
T> - OverlayRoute<
T> - TransitionRoute<
T> - ModalRoute<
T> - PopupRoute<
T> - DesignBottomSheetRoute
Constructors
-
DesignBottomSheetRoute({required DesignBottomSheetBuilder builder, List<
double> ? snapSizes, double? initialSize, DesignBottomSheetController? sheetController, bool enableDrag = true, bool useSafeArea = false, double dampingRatio = 1, double stiffness = 700, double? closeDampingRatio, double? closeStiffness, Color barrierColor = const Color(0x66000000), DesignBarrierBuilder? barrierBuilder, String? barrierLabel, bool barrierDismissible = true, String? semanticLabel, RouteSettings? settings}) -
A sheet whose panel
builderpaints.
Properties
- allowSnapshotting → bool
-
Whether the route transition will prefer to animate a snapshot of the
entering/exiting routes.
no setterinherited
-
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.
no setteroverride
- barrierLabel → String?
-
What a screen reader calls the barrier; null:
DesignLocalizations.modalBarrierDismissLabel.
no setteroverride
- builder → DesignBottomSheetBuilder
-
Paints the panel.
final
- canPop → bool
-
Whether this route can be popped.
no setterinherited
- closeDampingRatio → double?
-
The close spring's damping ratio (ζ); null: dampingRatio. A look
whose sheet 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 spring's damping ratio (ζ): it opens and settles on it, and
closes on it 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
- enableDrag → bool
-
Whether a drag moves it. Defaults to true.
final
- 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
- initialSize → double?
-
The size it opens at, one of snapSizes; null: the smallest (or its
content's height).
final
- isActive → bool
-
Whether this route is on the navigator.
no setterinherited
- 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 it; null:
DesignLocalizations.bottomSheetLabel.
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
- sheetController → DesignBottomSheetController?
-
Moves it from outside; the caller's, never disposed by the route.
(Not
controller: a route'scontrolleris its own animation's.)final -
snapSizes
→ List<
double> -
The sizes it rests at, ascending, each a share of the room in (0, 1];
empty: one rest at its content's own height.
final
- stiffness → double
-
The spring's stiffness (k), and the close spring's unless
closeStiffness is given. Defaults to 700.
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
- useSafeArea → bool
-
Whether its room stops under the screen's top inset (a status bar, a
notch). Defaults to false.
final
- 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
childwith one or more transition widgets that define how the route arrives on and leaves the screen.override -
canTransitionFrom(
TransitionRoute previousRoute) → bool -
Returns true if
previousRouteshould 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
nextRouteis pushed on top of it or whennextRouteis 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 sheet is to open or gone, carrying a drag's
speed.
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.
override
-
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