BeamPage class
A wrapper for screens in a navigation stack.
- Inheritance
-
- Object
- RouteSettings
- Page
- BeamPage
Constructors
- BeamPage({LocalKey? key, String? name, required Widget child, String? title, bool onPopPage(BuildContext context, BeamerDelegate delegate, RouteInformationSerializable state, BeamPage poppedPage) = pathSegmentPop, String? popToNamed, BeamPageType type = BeamPageType.material, Route routeBuilder(BuildContext context, RouteSettings settings, Widget child)?, bool fullScreenDialog = false, bool opaque = true, bool keepQueryOnPop = false})
-
Creates a BeamPage with specified properties.
const
Properties
- arguments → Object?
-
The arguments passed to this route.
finalinherited
- child → Widget
-
The concrete Widget representing app's screen.
final
- fullScreenDialog → bool
-
Whether to present current BeamPage as a fullscreen dialog
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- keepQueryOnPop → bool
-
When this BeamPage pops from Navigator stack, whether to keep the
query parameters within current BeamLocation.
final
- key → LocalKey?
-
The key associated with this page.
finalinherited
- name → String?
-
The name of the route (e.g., "/settings").
finalinherited
- onPopPage → bool Function(BuildContext context, BeamerDelegate delegate, RouteInformationSerializable state, BeamPage poppedPage)
-
Overrides the default pop by executing an arbitrary closure.
Mainly used to manually update the
delegate.currentBeamLocationstate.final - opaque → bool
-
Whether the route obscures previous BeamPages when the transition is complete.
final
- popToNamed → String?
-
Overrides the default pop by beaming to specified URI string.
final
- restorationId → String?
-
Restoration ID to save and restore the state of the Route configured by
this page.
finalinherited
- routeBuilder → (Route Function(BuildContext context, RouteSettings settings, Widget child)?)
-
A builder for custom Route to use in createRoute.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- title → String?
-
The BeamPage's title. On the web, this is used for the browser tab title.
final
- type → BeamPageType
-
The type to determine how a route should be built.
final
Methods
-
canUpdate(
Page other) → bool -
Whether this page can be updated with the
otherpage.inherited -
createRoute(
BuildContext context) → Route -
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
Static Methods
-
pathSegmentPop(
BuildContext context, BeamerDelegate delegate, RouteInformationSerializable state, BeamPage poppedPage) → bool - The default pop behavior for BeamPage.
-
routePop(
BuildContext context, BeamerDelegate delegate, RouteInformationSerializable state, BeamPage poppedPage) → bool - Pops the last route from history and calls BeamerDelegate.update.
Constants
- notFound → const BeamPage
- A BeamPage to be the default for BeamerDelegate.notFoundPage.