mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-11-05 13:26:48 +08:00
chore: format
This commit is contained in:
Nathan Walker
266
nativescript-core/ui/page/index.d.ts
vendored
266
nativescript-core/ui/page/index.d.ts
vendored
@@ -11,158 +11,184 @@ import { Color } from "../../color";
|
||||
* Defines the data for the page navigation events.
|
||||
*/
|
||||
export interface NavigatedData extends EventData {
|
||||
/**
|
||||
* The navigation context (optional, may be undefined) passed to the page navigation events method.
|
||||
*/
|
||||
context: any;
|
||||
/**
|
||||
* The navigation context (optional, may be undefined) passed to the page navigation events method.
|
||||
*/
|
||||
context: any;
|
||||
|
||||
/**
|
||||
* Represents if a navigation is forward or backward.
|
||||
*/
|
||||
isBackNavigation: boolean;
|
||||
/**
|
||||
* Represents if a navigation is forward or backward.
|
||||
*/
|
||||
isBackNavigation: boolean;
|
||||
}
|
||||
|
||||
export module knownCollections {
|
||||
export const actionItems: string;
|
||||
export const actionItems: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents a logical unit for navigation (inside Frame).
|
||||
*/
|
||||
export class Page extends ContentView {
|
||||
/**
|
||||
* String value used when hooking to navigatingTo event.
|
||||
*/
|
||||
public static navigatingToEvent: string;
|
||||
/**
|
||||
* String value used when hooking to navigatingTo event.
|
||||
*/
|
||||
public static navigatingToEvent: string;
|
||||
|
||||
/**
|
||||
* String value used when hooking to navigatedTo event.
|
||||
*/
|
||||
public static navigatedToEvent: string;
|
||||
/**
|
||||
* String value used when hooking to navigatedTo event.
|
||||
*/
|
||||
public static navigatedToEvent: string;
|
||||
|
||||
/**
|
||||
* String value used when hooking to navigatingFrom event.
|
||||
*/
|
||||
public static navigatingFromEvent: string;
|
||||
/**
|
||||
* String value used when hooking to navigatingFrom event.
|
||||
*/
|
||||
public static navigatingFromEvent: string;
|
||||
|
||||
/**
|
||||
* String value used when hooking to navigatedFrom event.
|
||||
*/
|
||||
public static navigatedFromEvent: string;
|
||||
/**
|
||||
* String value used when hooking to navigatedFrom event.
|
||||
*/
|
||||
public static navigatedFromEvent: string;
|
||||
|
||||
/**
|
||||
* Gets or sets whether page background spans under status bar.
|
||||
*/
|
||||
public backgroundSpanUnderStatusBar: boolean;
|
||||
/**
|
||||
* Gets or sets whether page background spans under status bar.
|
||||
*/
|
||||
public backgroundSpanUnderStatusBar: boolean;
|
||||
|
||||
/**
|
||||
* Gets or sets the style of the status bar.
|
||||
*/
|
||||
public statusBarStyle: "light" | "dark";
|
||||
/**
|
||||
* Gets or sets the style of the status bar.
|
||||
*/
|
||||
public statusBarStyle: "light" | "dark";
|
||||
|
||||
/**
|
||||
* Gets or sets the color of the status bar in Android.
|
||||
*/
|
||||
public androidStatusBarBackground: Color;
|
||||
/**
|
||||
* Gets or sets the color of the status bar in Android.
|
||||
*/
|
||||
public androidStatusBarBackground: Color;
|
||||
|
||||
/**
|
||||
* Used to hide the Navigation Bar in iOS and the Action Bar in Android.
|
||||
*/
|
||||
public actionBarHidden: boolean;
|
||||
/**
|
||||
* Used to hide the Navigation Bar in iOS and the Action Bar in Android.
|
||||
*/
|
||||
public actionBarHidden: boolean;
|
||||
|
||||
/**
|
||||
* Used to control if swipe back navigation in iOS is enabled. This property is iOS specific. Default value: true
|
||||
*/
|
||||
public enableSwipeBackNavigation: boolean;
|
||||
/**
|
||||
* Used to control if swipe back navigation in iOS is enabled. This property is iOS specific. Default value: true
|
||||
*/
|
||||
public enableSwipeBackNavigation: boolean;
|
||||
|
||||
/**
|
||||
* Returns a CSS keyframe animation with the specified name, if it exists.
|
||||
*/
|
||||
public getKeyframeAnimationWithName(animationName: string): KeyframeAnimationInfo;
|
||||
/**
|
||||
* Returns a CSS keyframe animation with the specified name, if it exists.
|
||||
*/
|
||||
public getKeyframeAnimationWithName(
|
||||
animationName: string
|
||||
): KeyframeAnimationInfo;
|
||||
|
||||
/**
|
||||
* A property that is used to pass a data from another page (while navigate to).
|
||||
*/
|
||||
public navigationContext: any;
|
||||
/**
|
||||
* A property that is used to pass a data from another page (while navigate to).
|
||||
*/
|
||||
public navigationContext: any;
|
||||
|
||||
/**
|
||||
* Gets the Frame object controlling this instance.
|
||||
*/
|
||||
public frame: Frame;
|
||||
/**
|
||||
* Gets the Frame object controlling this instance.
|
||||
*/
|
||||
public frame: Frame;
|
||||
|
||||
/**
|
||||
* Gets the ActionBar for this page.
|
||||
*/
|
||||
public actionBar: ActionBar;
|
||||
/**
|
||||
* Gets the ActionBar for this page.
|
||||
*/
|
||||
public actionBar: ActionBar;
|
||||
|
||||
/**
|
||||
* A basic method signature to hook an event listener (shortcut alias to the addEventListener method).
|
||||
* @param eventNames - String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change").
|
||||
* @param callback - Callback function which will be executed when event is raised.
|
||||
* @param thisArg - An optional parameter which will be used as `this` context for callback execution.
|
||||
*/
|
||||
public 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).
|
||||
* @param eventNames - String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by `,` (e.g. "propertyChange", "change").
|
||||
* @param callback - Callback function which will be executed when event is raised.
|
||||
* @param thisArg - An optional parameter which will be used as `this` context for callback execution.
|
||||
*/
|
||||
public on(
|
||||
eventNames: string,
|
||||
callback: (data: EventData) => void,
|
||||
thisArg?: any
|
||||
): void;
|
||||
|
||||
/**
|
||||
* Raised when navigation to the page has started.
|
||||
*/
|
||||
public on(event: "navigatingTo", callback: (args: NavigatedData) => void, thisArg?: any): void;
|
||||
/**
|
||||
* Raised when navigation to the page has started.
|
||||
*/
|
||||
public on(
|
||||
event: "navigatingTo",
|
||||
callback: (args: NavigatedData) => void,
|
||||
thisArg?: any
|
||||
): void;
|
||||
|
||||
/**
|
||||
* Raised when navigation to the page has finished.
|
||||
*/
|
||||
public on(event: "navigatedTo", callback: (args: NavigatedData) => void, thisArg?: any): void;
|
||||
/**
|
||||
* Raised when navigation to the page has finished.
|
||||
*/
|
||||
public on(
|
||||
event: "navigatedTo",
|
||||
callback: (args: NavigatedData) => void,
|
||||
thisArg?: any
|
||||
): void;
|
||||
|
||||
/**
|
||||
* Raised when navigation from the page has started.
|
||||
*/
|
||||
public on(event: "navigatingFrom", callback: (args: NavigatedData) => void, thisArg?: any): void;
|
||||
/**
|
||||
* Raised when navigation from the page has started.
|
||||
*/
|
||||
public on(
|
||||
event: "navigatingFrom",
|
||||
callback: (args: NavigatedData) => void,
|
||||
thisArg?: any
|
||||
): void;
|
||||
|
||||
/**
|
||||
* Raised when navigation from the page has finished.
|
||||
*/
|
||||
public on(event: "navigatedFrom", callback: (args: NavigatedData) => void, thisArg?: any): void;
|
||||
//@private
|
||||
/**
|
||||
* Raised when navigation from the page has finished.
|
||||
*/
|
||||
public on(
|
||||
event: "navigatedFrom",
|
||||
callback: (args: NavigatedData) => void,
|
||||
thisArg?: any
|
||||
): void;
|
||||
//@private
|
||||
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
hasActionBar: boolean;
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
_frame: Frame;
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
hasActionBar: boolean;
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
_frame: Frame;
|
||||
|
||||
/**
|
||||
* A method called before navigating to the page.
|
||||
* @private
|
||||
* @param context - The data passed to the page through the NavigationEntry.context property.
|
||||
* @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
|
||||
* @param bindingContext - An object to become the binding context of the page navigating to. Optional.
|
||||
*/
|
||||
public onNavigatingTo(context: any, isBackNavigation: boolean, bindingContext?: any): void;
|
||||
/**
|
||||
* A method called before navigating to the page.
|
||||
* @private
|
||||
* @param context - The data passed to the page through the NavigationEntry.context property.
|
||||
* @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
|
||||
* @param bindingContext - An object to become the binding context of the page navigating to. Optional.
|
||||
*/
|
||||
public onNavigatingTo(
|
||||
context: any,
|
||||
isBackNavigation: boolean,
|
||||
bindingContext?: any
|
||||
): void;
|
||||
|
||||
/**
|
||||
* A method called after navigated to the page.
|
||||
* @private
|
||||
* @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
|
||||
*/
|
||||
public onNavigatedTo(isBackNavigation: boolean): void;
|
||||
/**
|
||||
* A method called after navigated to the page.
|
||||
* @private
|
||||
* @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
|
||||
*/
|
||||
public onNavigatedTo(isBackNavigation: boolean): void;
|
||||
|
||||
/**
|
||||
* A method called before navigating from the page.
|
||||
* @private
|
||||
* @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
|
||||
*/
|
||||
public onNavigatingFrom(isBackNavigation: boolean): void;
|
||||
/**
|
||||
* A method called before navigating from the page.
|
||||
* @private
|
||||
* @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
|
||||
*/
|
||||
public onNavigatingFrom(isBackNavigation: boolean): void;
|
||||
|
||||
/**
|
||||
* A method called after navigated from the page.
|
||||
* @private
|
||||
* @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
|
||||
*/
|
||||
public onNavigatedFrom(isBackNavigation: boolean): void;
|
||||
//@endprivate
|
||||
/**
|
||||
* A method called after navigated from the page.
|
||||
* @private
|
||||
* @param isBackNavigation - True if the Page is being navigated from using the Frame.goBack() method, false otherwise.
|
||||
*/
|
||||
public onNavigatedFrom(isBackNavigation: boolean): void;
|
||||
//@endprivate
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user