8.6 Released with 🥽 visionOS support and more!
Check it out
Represents a logical unit for navigation (inside Frame).

Summary ​

Constructors

constructor

Properties

accessibilityAnnouncePageEnabled
actionBar
actionBarHidden
androidStatusBarBackground
backgroundSpanUnderStatusBar
enableSwipeBackNavigation
frame
navigatedFromEvent
navigatedToEvent
navigatingFromEvent
navigatingToEvent
navigationContext
onAccessibilityPerformEscape
statusBarStyle
155 properties inherited from PageBase
Click to expand

Methods

accessibilityScreenChanged
getKeyframeAnimationWithName
on
112 methods inherited from PageBase
Click to expand

Constructors ​

constructor ​

new Page(): Page

Properties ​

accessibilityAnnouncePageEnabled ​

accessibilityAnnouncePageEnabled: boolean
Should page changed be annnounced to the screen reader.

actionBar ​

actionBar: ActionBar
Gets the ActionBar for this page.

actionBarHidden ​

actionBarHidden: boolean
Used to hide the Navigation Bar in iOS and the Action Bar in Android.

androidStatusBarBackground ​

androidStatusBarBackground: Color
Gets or sets the color of the status bar in Android.

backgroundSpanUnderStatusBar ​

backgroundSpanUnderStatusBar: boolean
Gets or sets whether page background spans under status bar.

enableSwipeBackNavigation ​

enableSwipeBackNavigation: boolean
Used to control if swipe back navigation in iOS is enabled. This property is iOS specific. Default value: true

frame ​

frame: Frame
Gets the Frame object controlling this instance.
navigationContext: any
A property that is used to pass a data from another page (while navigate to).

onAccessibilityPerformEscape ​

onAccessibilityPerformEscape?: () => boolean

statusBarStyle ​

statusBarStyle: "dark" | "light"
Gets or sets the style of the status bar.
StaticReadonly
navigatedFromEvent: "navigatedFrom" = 'navigatedFrom'
String value used when hooking to navigatedFrom event.
StaticReadonly
navigatedToEvent: "navigatedTo" = 'navigatedTo'
String value used when hooking to navigatedTo event.
StaticReadonly
navigatingFromEvent: "navigatingFrom" = 'navigatingFrom'
String value used when hooking to navigatingFrom event.
StaticReadonly
navigatingToEvent: "navigatingTo" = 'navigatingTo'
String value used when hooking to navigatingTo event.

Methods ​

accessibilityScreenChanged ​

accessibilityScreenChanged(refocus?: boolean): void
Announce screen changed
Parameter Default Description
refocus
boolean

Returns void

getKeyframeAnimationWithName ​

getKeyframeAnimationWithName(animationName: string): KeyframeAnimationInfo
Returns a CSS keyframe animation with the specified name, if it exists.
Parameter Default Description
animationName
string

on(eventNames: string, callback: (data: EventData) => void, thisArg?: any): void
A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
Parameter Default Description
eventNames
string

String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change").

callback
(data: EventData) => void

Callback function which will be executed when event is raised.

thisArg
any

An optional parameter which will be used as `this` context for callback execution.

Returns void
on(event: "navigatingTo", callback: (args: NavigatedData) => void, thisArg?: any): void
Raised when navigation to the page has started.
Parameter Default Description
event
"navigatingTo"

callback
(args: NavigatedData) => void

thisArg
any

Returns void
on(event: "navigatedTo", callback: (args: NavigatedData) => void, thisArg?: any): void
Raised when navigation to the page has finished.
Parameter Default Description
event
"navigatedTo"

callback
(args: NavigatedData) => void

thisArg
any

Returns void
on(event: "navigatingFrom", callback: (args: NavigatedData) => void, thisArg?: any): void
Raised when navigation from the page has started.
Parameter Default Description
event
"navigatingFrom"

callback
(args: NavigatedData) => void

thisArg
any

Returns void
on(event: "navigatedFrom", callback: (args: NavigatedData) => void, thisArg?: any): void
Raised when navigation from the page has finished.
Parameter Default Description
event
"navigatedFrom"

callback
(args: NavigatedData) => void

thisArg
any

Returns void