Note: You are on the beta version of our docs. This is a work in progress and may contain broken links and pages.
Classes
Page
Page
Represents a logical unit for navigation (inside Frame).
Summary
Constructors
Properties
- accessibilityAnnouncePageEnabled
- actionBar
- actionBarHidden
- androidStatusBarBackground
- backgroundSpanUnderStatusBar
- enableSwipeBackNavigation
- frame
- navigatedFromEvent
- navigatedToEvent
- navigatingFromEvent
- navigatingToEvent
- navigationContext
- onAccessibilityPerformEscape
- statusBarStyle
155 properties inherited from PageBase
Click to expand
Methods
112 methods inherited from PageBase
Click to expand
Constructors
Properties
accessibilityAnnouncePageEnabled
defined in @nativescript/core/ui/page/index.d.ts:111:8
Should page changed be annnounced to the screen reader.
actionBar
actionBar: ActionBar
defined in @nativescript/core/ui/page/index.d.ts:100:8
Gets the ActionBar for this page.
actionBarHidden
actionBarHidden: boolean defined in @nativescript/core/ui/page/index.d.ts:72:8
Used to hide the Navigation Bar in iOS and the Action Bar in Android.
androidStatusBarBackground
androidStatusBarBackground: Color
defined in @nativescript/core/ui/page/index.d.ts:66:8
Gets or sets the color of the status bar in Android.
backgroundSpanUnderStatusBar
defined in @nativescript/core/ui/page/index.d.ts:54:8
Gets or sets whether page background spans under status bar.
enableSwipeBackNavigation
defined in @nativescript/core/ui/page/index.d.ts:77:8
Used to control if swipe back navigation in iOS is enabled. This property is iOS specific. Default value: true
frame
frame: Frame
defined in @nativescript/core/ui/page/index.d.ts:94:8
Gets the Frame object controlling this instance.
navigationContext
defined in @nativescript/core/ui/page/index.d.ts:88:8
A property that is used to pass a data from another page (while navigate to).
onAccessibilityPerformEscape
defined in @nativescript/core/ui/page/index.d.ts:106:8
statusBarStyle
defined in @nativescript/core/ui/page/index.d.ts:60:8
Gets or sets the style of the status bar.
navigatedFromEvent
StaticReadonly
defined in @nativescript/core/ui/page/index.d.ts:49:24
String value used when hooking to navigatedFrom event.
navigatedToEvent
StaticReadonly
defined in @nativescript/core/ui/page/index.d.ts:39:24
String value used when hooking to navigatedTo event.
navigatingFromEvent
StaticReadonly
defined in @nativescript/core/ui/page/index.d.ts:44:24
String value used when hooking to navigatingFrom event.
navigatingToEvent
StaticReadonly
defined in @nativescript/core/ui/page/index.d.ts:34:24
String value used when hooking to navigatingTo event.
Methods
accessibilityScreenChanged
defined in @nativescript/core/ui/page/index.d.ts:185:1
Announce screen changed
| Parameter | Default | Description |
refocus | | boolean |
Returns void
getKeyframeAnimationWithName
getKeyframeAnimationWithName(animationName: string): KeyframeAnimationInfo
defined in @nativescript/core/ui/page/index.d.ts:82:1
Returns a CSS keyframe animation with the specified name, if it exists.
| Parameter | Default | Description |
animationName | | string |
Returns KeyframeAnimationInfo
on
on(eventNames: string, callback: (data: EventData) => void, thisArg?: any): void
defined in @nativescript/core/ui/page/index.d.ts:119:1
A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
| Parameter | Default | Description |
eventNames | | stringString corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change"). |
callback | | (data: EventData) => voidCallback function which will be executed when event is raised. |
thisArg | | anyAn optional parameter which will be used as `this` context for callback execution. |
Returns void
on(event: "navigatingTo", callback: (args: NavigatedData) => void, thisArg?: any): void
defined in @nativescript/core/ui/page/index.d.ts:124:1
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
defined in @nativescript/core/ui/page/index.d.ts:129:1
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
defined in @nativescript/core/ui/page/index.d.ts:134:1
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
defined in @nativescript/core/ui/page/index.d.ts:139:1
Raised when navigation from the page has finished.
| Parameter | Default | Description |
event | | "navigatedFrom" |
callback | | (args: NavigatedData) => void |
thisArg | | any |
Returns void
- Previous
- ObservableArray
- Next
- PageBase