StandardAppRouter extension

An extension class that adds the Router functionality of StandardApp to Router.

on

Properties

nestedPageInstances → Map<StandardPageInterface<Object?, Object?>, List<StandardPageInterface<Object?, Object?>>>

Available on Router, provided by the StandardAppRouter extension

The current nested page instances within each navigator.
no setter
pageInstances → List<StandardPageInterface<Object?, Object?>>

Available on Router, provided by the StandardAppRouter extension

The current Page history.
no setter
rootPageInstances → List<StandardPageInterface<Object?, Object?>>

Available on Router, provided by the StandardAppRouter extension

The root Navigator's current page instances.
no setter

Methods

getPageFactory<T extends StandardPageWithResult<R, E>, R extends Object?, E extends Object?>() → StandardPageWithResultFactory<T, R, E>

Available on Router, provided by the StandardAppRouter extension

Get the factory class StandardPageWithResultFactory of StandardPageWithResult. T is the type of the destination page. R is the type of page data. E is the data type of the value that the page returns.
go<T extends StandardPage<R>, R extends Object?>(R pageData, [StandardPageNavigationMode? navigationMode, bool pushParentPage = false]) → Future<void>

Available on Router, provided by the StandardAppRouter extension

Navigate to the StandardPage of type T with the option to pass pageData during navigation. T represents the type of the destination page, and R signifies the type of page data. navigationMode is an optional mode of StandardPageNavigationMode to use during navigation. pushParentPage indicates whether to push the parent page when navigating to a child page. default is false.
goWithResult<T extends StandardPageWithResult<R, E>, R extends Object?, E extends Object?>(R pageData, [StandardPageNavigationMode? navigationMode, bool pushParentPage = false]) → Future<E?>

Available on Router, provided by the StandardAppRouter extension

Navigate to the StandardPageWithResult of type T that returns a value, with the option to pass pageData during the navigation. T is the type of the destination page. R is the type of page data. E is the data type of the value that the page returns. navigationMode is optional and represents the mode of StandardPageNavigationMode to use during navigation. pushParentPage indicates whether to push the parent page when navigating to a child page. default is false.
processInitialRoute() → void

Available on Router, provided by the StandardAppRouter extension

Selects the initial page that the application should display and navigates to that page. If this initialization has already been performed, it does nothing.
removeRoute(BuildContext context, [Object? result]) → void

Available on Router, provided by the StandardAppRouter extension

Remove the nearest page in context, if it exists. Do nothing if it doesn't exist.
route(String location, [StandardPageNavigationMode? navigationMode, bool pushParentPage = true]) → void

Available on Router, provided by the StandardAppRouter extension

Navigate to a page with the specified location. navigationMode represents the mode of StandardPageNavigationMode to use during navigation (optional). pushParentPage indicates whether to push the parent page when navigating to a child page. default is true.