ExpressiveSheetPage<T> class
The go_router Page for a route raised as a sheet: a modal bottom
sheet, or with drawer a full-screen dialog. The route names the root
navigator (parentNavigatorKey), so the sheet stands above the shell
and the bar under it does not move. The page publishes
RoutePresentation.sheet, so the screen inside derives its dismiss
affordance; the sheet draws only its container, handle, scrim and
anchors.
The modal sheet rises to its partial anchor (half the screen, or its own height when shorter) and is dragged between its anchors or away; its own pop, a tap on the scrim and the system back close it (the system back first settling an expanded sheet to its partial anchor). The full-screen dialog has no scrim; its pop and the system back close it.
- Inheritance
-
- Object
- RouteSettings
- Page<
T> - ExpressiveSheetPage
- Implementers
Constructors
- ExpressiveSheetPage({required Widget child, bool drawer = false, bool skipPartiallyExpanded = false, ExpressiveThemeData theme(BuildContext context)?, Listenable? themeListenable, ExpressiveComponentThemeData? style, LocalKey? key, String? name, Object? arguments, String? restorationId})
-
A page showing
childas a sheet, or as a full-screen dialog whendrawer.const
Properties
- arguments → Object?
-
The arguments passed to this route.
finalinherited
- canPop → bool
-
When false, blocks the associated route from being popped.
finalinherited
- child → Widget
-
The sheet's page.
final
- drawer → bool
-
Whether the page is a full-screen dialog rather than a modal bottom
sheet.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → LocalKey?
-
The key associated with this page.
finalinherited
- name → String?
-
The name of the route (e.g., "/settings").
finalinherited
-
onPopInvoked
→ PopInvokedWithResultCallback<
T> -
Called after a pop on the associated route was handled.
finalinherited
- restorationId → String?
-
Restoration ID to save and restore the state of the Route configured by
this page.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- skipPartiallyExpanded → bool
-
Whether the modal sheet skips its partial anchor and rises straight
to its content's height.
final
- style → ExpressiveComponentThemeData?
-
Stateful visual overrides for the modal bottom-sheet container.
final
- theme → ExpressiveThemeData Function(BuildContext context)?
-
The theme the whole modal sheet wears — its container, handle and page
— in place of the one around the navigator: a player tinted from the
playing artwork (
ExpressiveArtwork). The route builds the sheet with the navigator's themes, so a scope inside child would tint only the page, not the container under it. Called under the route whenever the sheet builds, with the navigator's theme ambient: a new page (the router's rebuild) and whatever it depends on rebuild it, and so does themeListenable (a scheme that springs between two artworks). Null keeps the navigator's theme. The full-screen dialog ignores it.final - themeListenable → Listenable?
-
Rebuilds theme when it notifies.
final
Methods
-
canUpdate(
Page other) → bool -
Whether this page can be updated with the
otherpage.inherited -
createRoute(
BuildContext context) → Route< T> -
Creates the Route that corresponds to this page.
override
-
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