mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-11-04 12:58:38 +08:00
143 lines
3.3 KiB
TypeScript
143 lines
3.3 KiB
TypeScript
/**
|
|
* Contains the WebView class, which represents a standard browser widget.
|
|
*/
|
|
|
|
import { View } from '../core/view';
|
|
import { Property } from '../core/properties';
|
|
import { EventData } from '../../data/observable';
|
|
|
|
/**
|
|
* Represents the observable property backing the Url property of each WebView instance.
|
|
*/
|
|
export const urlProperty: Property<WebView, string>;
|
|
|
|
/**
|
|
* Represents navigation type
|
|
*/
|
|
export type WebViewNavigationType = 'linkClicked' | 'formSubmitted' | 'backForward' | 'reload' | 'formResubmitted' | 'other' | undefined;
|
|
|
|
/**
|
|
* Represents a standard WebView widget.
|
|
*
|
|
* @nsView
|
|
*/
|
|
export class WebView extends View {
|
|
/**
|
|
* String value used when hooking to loadStarted event.
|
|
*
|
|
* @nsEvent {LoadEventData} loadStarted
|
|
*/
|
|
public static loadStartedEvent: string;
|
|
|
|
/**
|
|
* String value used when hooking to loadFinished event.
|
|
*
|
|
* @nsEvent {LoadEventData} loadFinished
|
|
*/
|
|
public static loadFinishedEvent: string;
|
|
|
|
/**
|
|
* Gets the native [android widget](http://developer.android.com/reference/android/webkit/WebView.html) that represents the user interface for this component. Valid only when running on Android OS.
|
|
*/
|
|
android: any /* android.webkit.WebView */;
|
|
|
|
/**
|
|
* Gets the native [WKWebView](https://developer.apple.com/documentation/webkit/wkwebview/) that represents the user interface for this component. Valid only when running on iOS.
|
|
*/
|
|
ios: any /* WKWebView */;
|
|
|
|
/**
|
|
* Gets or sets the url, local file path or HTML string.
|
|
*
|
|
* @nsProperty
|
|
*/
|
|
src: string;
|
|
|
|
/**
|
|
* Gets a value indicating whether the WebView can navigate back.
|
|
*/
|
|
canGoBack: boolean;
|
|
|
|
/**
|
|
* Gets a value indicating whether the WebView can navigate forward.
|
|
*/
|
|
canGoForward: boolean;
|
|
|
|
/**
|
|
* Disable scrolling in the WebView
|
|
*
|
|
* @nsProperty
|
|
*/
|
|
disableZoom: boolean;
|
|
|
|
/**
|
|
* Enables inline media playback on iOS.
|
|
* By default, webview forces iPhone into fullscreen media playback.
|
|
*
|
|
* @nsProperty
|
|
*/
|
|
iosAllowInlineMediaPlayback: boolean;
|
|
|
|
/**
|
|
* Stops loading the current content (if any).
|
|
*/
|
|
stopLoading(): void;
|
|
|
|
/**
|
|
* Navigates back.
|
|
*/
|
|
goBack();
|
|
|
|
/**
|
|
* Navigates forward.
|
|
*/
|
|
goForward();
|
|
|
|
/**
|
|
* Reloads the current url.
|
|
*/
|
|
reload();
|
|
|
|
/**
|
|
* Adds a listener for the specified event name.
|
|
*
|
|
* @param eventName The name of the event.
|
|
* @param callback The event listener to add. Will be called when an event of
|
|
* the given name is raised.
|
|
* @param thisArg An optional parameter which, when set, will be bound as the
|
|
* `this` context when the callback is called. Falsy values will be not be
|
|
* bound.
|
|
*/
|
|
on(eventName: string, callback: (data: EventData) => void, thisArg?: any): void;
|
|
|
|
/**
|
|
* Raised when a loadFinished event occurs.
|
|
*/
|
|
on(event: 'loadFinished', callback: (args: LoadEventData) => void, thisArg?: any): void;
|
|
|
|
/**
|
|
* Raised when a loadStarted event occurs.
|
|
*/
|
|
on(event: 'loadStarted', callback: (args: LoadEventData) => void, thisArg?: any): void;
|
|
}
|
|
|
|
/**
|
|
* Event data containing information for the loading events of a WebView.
|
|
*/
|
|
export interface LoadEventData extends EventData {
|
|
/**
|
|
* Gets the url of the web-view.
|
|
*/
|
|
url: string;
|
|
|
|
/**
|
|
* Gets the navigation type of the web-view.
|
|
*/
|
|
navigationType: NavigationType;
|
|
|
|
/**
|
|
* Gets the error (if any).
|
|
*/
|
|
error: string;
|
|
}
|