StandardAppRouterContext extension

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

on

• BuildContext

Properties

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

Available on BuildContext, provided by the StandardAppRouterContext extension

The current nested page instances within each navigator.

no setter

pageInstances → List<StandardPageInterface<Object?, Object?>>

Available on BuildContext, provided by the StandardAppRouterContext extension

The current Page history.

no setter

rootPageInstances → List<StandardPageInterface<Object?, Object?>>

Available on BuildContext, provided by the StandardAppRouterContext extension

The root Navigator's current page instances.

no setter

router → Router

Available on BuildContext, provided by the StandardAppRouterContext extension

Retrieves the Router.

no setter

Methods

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

Available on BuildContext, provided by the StandardAppRouterContext 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 BuildContext, provided by the StandardAppRouterContext 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 BuildContext, provided by the StandardAppRouterContext 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.

removeRoute([Object? result]) → void

Available on BuildContext, provided by the StandardAppRouterContext extension

If the route corresponds to a StandardPageInterface, it performs necessary cleanup and updates the page stack accordingly. If the route does not correspond to a StandardPageInterface, it directly removes the route from the navigator.

route(String location, [StandardPageNavigationMode? navigationMode]) → void

Available on BuildContext, provided by the StandardAppRouterContext 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.