# Titanium.UI.WebView

See the example section "Usage of allowedURLSchemes and handleurl in iOS".

This property is available on devices that support 3D Touch. Default value is false.

If you set this value to true for a web view, users (with devices that support 3D Touch) can preview link destinations, and can preview detected data such as addresses, by pressing on links. Such previews are known to users as peeks. If a user presses deeper, the preview navigates (or pops, in user terminology) to the destination. Because pop navigation switches the user from your app to Safari, it is opt-in, by way of this property, rather default behavior for this class.

Use this property to change the resources the web view has access to when loading the content of a local file. By default the web view only has access to files inside the same directory as the loaded file. To reference resources from other directories (e.g. a parent directory) change this property accordingly.

If assetsDirectory references a single file, only that file may be loaded. If assetsDirectory references a directory, files inside that directory may be loaded.

This property needs to be set before url is assigned to a local file.

An array of url strings to blacklist. This will stop the webview from going to urls listed in the blacklist. Note, this only applies in the links clicked inside the webview. The first website that is loaded will not be stopped even if it matches the blacklist.

An array of url strings to be blocked from loading. This will stop the webview from going to urls listed in this array. Note that this only applies to the links tapped on by the end-user. The first website that is loaded will not be stopped, even if it is listed in the blocklist.

This property can only be set when creating the webview and will be ignored when set afterwards.

Android only supports loading data from a Blob, not a File.

See also: url and html.

Set to true to disable the bounce effect.

Set to true to disable the context menu. Note that disabling the context menu will also disable the text selection on iOS.

This property is introduced to prevent a security issue with older devices (< JELLY_BEAN_MR1)

By default any urls that are not handled by the Titanium platform but can be handled by the shared application are automatically sent to the shared application and the webview does not open these. When this property is set to true the webview will attempt to handle these urls and they will not be sent to the shared application. An example is links to telephone numbers.

See setHtml for additional parameters that can be specified when setting HTML content.

The web view's content can also be set using the data or url properties.

See also: data and url.

If set to true, the web page loads despite having an invalid SSL certificate. If set to false, a web page with an invalid SSL certificate does not load.

iOS Note: As soon as you set this property to true, iOS will cache the response for the lifetime of the current web view.

When this property is set to true, the user must explicitly tap the elements in the web view to display the keyboard (or other relevant input view) for that element. When set to false, a focus event on an element causes the input view to be displayed and associated with that element automatically.

Setting this property solves the problem of web links with specific length not triggering a link click in Android.

This is only an Android specific property and has no effect starting from API level 18.

This flag is true by default to retain backwards compatibility with previous behavior.

On iOS this functionality can be set in the <plist> section of the tiapp.xml using the NSAllowsArbitraryLoads key as part of the App Transport Security. The plist key is enabled by default, allowing arbitrary loads to be processed.

For example, the request is triggered if a web page wants to open a URL in a new window. By default, Titanium will open a new full-size window to host the new content. Use the callback to override the default behavior.

The callback needs to create a new WebView object to host the content in and add the WebView to the application UI. The callback must return either a WebView object to host the content in or null if it does not wish to handle the request.

The callback is passed a dictionary with two boolean properties:

• isDialog: set to true if the content should be opened in a dialog window rather than a full-size window.
• isUserGesture: set to true if the user initiated the request with a gesture, such as tapping a link.

The following example opens new web content in a new tab rather than a new window:

var tabGroup = Ti.UI.createTabGroup(),
    win = Ti.UI.createWindow(),
    tab = Ti.UI.createTab({window: win, title: 'Start Page'}),
    webview = Ti.UI.createWebView({ url:'index.html'});

webview.onCreateWindow = function(e) {
    var newWin = Ti.UI.createWindow(),
        newWebView = Ti.UI.createWebView(),
        newTab = Ti.UI.createTab({window: newWin, title: 'New Page'});
    newWin.add(newWebView);
    tabGroup.addTab(newTab);
    return newWebView;
};

win.add(webview);
tabGroup.addTab(tab);
tabGroup.open();

The callback will be called before navigating to the link. The Boolean return value of the callback will determine if the link will be navigated or discarded.

This setting affects the loading of content that requires web plugins.

To enable hardware acceleration, add the tool-api-level and manifest elements shown below inside the android element in your tiapp.xml file.

<android xmlns:android="http://schemas.android.com/apk/res/android">
    <tool-api-level>11</tool-api-level>
    <manifest>
        <application android:hardwareAccelerated="true"/>
    </manifest>
</android>

See Android documentation for WebSettings.PluginState.

This property only works on Android devices at API Level 8 or greater.

This value ranges from 0.0 to 1.0 based on the total number of bytes expected to be received, including the main document and all of its potential subresources. After loading completes, the progress remains at 1.0 until a new download starts, at which point progress is reset to 0.0.

Setting this property allows you to set custom headers to the URL requests. The parameter will be key-value pairs: {"Custom-field1":"value1", "Custom-field2":"value2"}

On Android you should avoid Calling setRequestHeaders() right after createWebView(). Use the requestHeaders property inside createWebView() or put it inside the window open event.

On iOS, setting this to true sets the initial zoom level to show the entire page, and enables the user to zoom the web view in and out. Setting this to false prevents the user from zooming the web view.

On Android, only controls the initial zoom level.

The scroll-to-top gesture is a tap on the status bar; The default value of this property is true. This gesture works when you have a single visible web view. If there are multiple table views, web views, text areas, and/or scroll views visible, you will need to disable (set to false) on the above views you DON'T want this behaviour on. The remaining view will then respond to scroll-to-top gesture.

This property changes as the content of the webview changes (such as when the user clicks a hyperlink inside the web view).

See also: data and html.

On the iOS platform, this is not per-webview. Once you have set this property for a webview it will not change for same. But while creating new webview it can be changed to new user agent.

On Android, changing the user agent after the webview has begun loading content may cause the webview to reload and fire multiple load or beforeload events. Developers should provide the user agent value in the creation properties to avoid the reload and multiple events firing.

On the iOS platform, if this web view or any of its parent views have touch listeners, the Titanium component intercepts all touch events. This prevents the user from interacting with the native web view components.

Set this flag to false to disable the default behavior. Setting this property to false allows the user to interact with the native web view and still honor any touch events sent to its parents. No touch events will be generated when the user interacts with the web view itself.

Set this flag to true if you want to receive touch events from the web view and the user does not need to interact with the web content directly.

This flag is true by default to retain backwards compatibility with previous behavior.