Represents the logical View unit that is responsible for navigation within an application. Nested frames are supported, enabling hierarchical navigation scenarios.
Summary Constructors Properties actionBarVisibility: "auto" | "always" | "never"
Used to control the visibility the Navigation Bar in iOS and the Action Bar in Android.
Gets the AndroidFrame object that represents the Android-specific APIs for this Frame. Valid when running on Android OS.
Gets or sets if navigation transitions should be animated.
Gets the back stack of this instance.
Gets the NavigationEntry instance the Frame is currently navigated to.
Gets the Page instance the Frame is currently navigated to.
Gets the iOSFrame object that represents the iOS-specific APIs for this Frame. Valid when running on iOS.
Gets or sets the default navigation transition for this frame.
defaultAnimatedNavigation Static
defaultAnimatedNavigation: boolean
Gets or sets if navigation transitions should be animated globally.
Gets or sets the default NavigationTransition for all frames across the app.
Methods Checks whether the goBack operation is available.
Returns boolean
Navigates to the previous entry (if any) in the back stack.
Returns any
navigate(pageModuleName: string): any
Navigates to a Page instance as described by the module name. This method will require the module and will check for a Page property in the exports of the module.
Returns any
navigate(create: () => Page): any
Creates a new Page instance using the provided callback and navigates to that Page.
Returns any
Navigates to a Page resolved by the provided NavigationEntry object. Since there are a couple of ways to specify a Page instance through an entry, there is a resolution priority: 1. entry.moduleName 2. entry.create()
Returns any
on(eventNames: string, callback: (args: EventData) => void, thisArg?: any): void
A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
Returns void
on(
event: "navigatingTo",
callback: (args: NavigationData) => void,
thisArg?: any
): void
Raised when navigation to the page has started.
Returns void
on(
event: "navigatedTo",
callback: (args: NavigationData) => void,
thisArg?: any
): void
Raised when navigation to the page has finished.
Returns void
getFrameById(id: string): Frame
Navigates back using the navigation hierarchy (if any). Updates the Frame stack as needed. This method will start from the topmost Frame and will recursively search for an instance that has the canGoBack operation available.
Returns any
Gets the topmost frame in the frames stack. An application will typically has one frame instance. Multiple frames handle nested (hierarchical) navigation scenarios.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4