routemaster library
Classes
- CupertinoTabPage
- A page used to manage a CupertinoTabBar and its child routes.
- CupertinoTabPageState
-
The state for a CupertinoTabPage. Creates and manages a
CupertinoTabController that can be accessed by calling
CupertinoTabPage.of(context).controller
. - Guard
- Provides functionality to block pages being loaded. Generally it's cleaner to not to use this class, and just use logic within the route map to return NotFound or Redirect, like this:
- IndexedPage
- A page for creating an indexed page, such as a tab bar. In most use cases, it's easier to use a TabPage or CupertinoTabPage.
- IndexedPageState
- The current state of an IndexedPage. Created when an instance of the page is shown. Provides a list of track of the currently active index.
- Provides access to the Route created after a route has been pushed.
- NotFound
- Can be returned instead of a page to inform the router that the page was not found.
- PageStack
- Manages a stack of pages. Used by PageStackNavigator.
- Provides a Navigator that shows pages from a PageStack.
- The state for a PageStackNavigator. Watches for changes in the stack and rebuilds the Navigator when required.
-
PageState<
T extends StatefulPage> - A page's state, similar to State for a StatefulWidget. For instance, maintains the current index for a tabbed page.
- PageTransition
- A transition for a page pop or push animation.
- Redirect
- Can be returned instead of a page to redirect the router to another path.
- RouteData
- Information generated from a specific path (URL).
- RouteHistory
- Allows navigating through the router's chronological history.
- RouteMap
- A standard simple routing table which takes a map of routes.
- Routemaster
- Provides access to router functionality.
- RoutemasterDelegate
- A delegate that is used by the Router widget to manage navigation.
- RoutemasterObserver
- An observer of changes in navigation.
- RoutemasterParser
- A delegate that is used by the Router widget to parse URLs.
- StackPage
- Creates a page that can provide a stack of inner pages.
- StackPageState
- The current state of an StackPage. Created when an instance of the page is shown.
-
StatefulPage<
T> - A Page that can create a state, for instance to keep track of the current tab index. Similar to StatefulWidget.
-
StatelessPage<
T extends Page> - A PageContainer for a regular Page that maintains no state.
- TabPage
-
A page used to manage tab views. Its state object creates and manages a
TabController that can be retrieved via
TabPage.of(context).controller
. - TabPageState
-
The state for a TabPage. Creates and manages a TabController that can be
retrieved via
TabPage.of(context).controller
. -
TransitionBuilderPage<
T> - A page that can be subclassed to provide push and pop animations.
-
TransitionBuilderPageRoute<
T> - The route created by by TransitionBuilderPage, which delegates push and pop transition animations to that page.
-
TransitionPage<
T> - A page that can use separate push and pop animations.
Enums
- RequestSource
- Where the navigation request originated from.
- TabBackBehavior
- Specifies how tabs behave when used with the system back button.
Mixins
-
IndexedPageStateMixIn<
T extends IndexedRouteMixIn> - Provides functionality for indexed pages, including managing the active index and a list of PageStack objects.
-
IndexedRouteMixIn<
T> - An interface for StatefulPage that provides a list of child route paths.
-
MultiChildPageContainer<
T extends StatefulPage> - A stateful page that hosts other child pages.
-
PageContainer<
T extends Page> - Provides routing information about a Page.
-
RedirectingPage<
T> - Marks a page as not being navigable to directly. It cannot be the top-level page, and if navigated to directly will redirect to a child page.
Typedefs
- PageBuilder = RouteSettings Function(RouteData route)
- A function that builds a Page from given RouteData.
- UnknownRouteCallback = RouteSettings Function(String path)
-
A function that returns a Page when the given
path
couldn't be found.
Exceptions / Errors
- RedirectLoopError
- Thrown when the router gets in an endless redirect loop due to a misconfigured routing map.