<webview> Tag

Navigates backward one history entry if possible. Equivalent to go(-1).

Indicates whether or not it is possible to navigate backward through history.

Indicates whether or not it is possible to navigate forward through history.

Clears browsing data for the webview partition.

Parameters
ClearDataOptions	options	Options determining exactly what data to clear.
ClearDataTypeSet	types	The types of data to be cleared.
function	(optional) callback	Called after the data has been successfully cleared. If you specify the callback parameter, it should be a function that looks like this: function() {...};

Injects JavaScript code into the guest page.

The following sample code uses script injection to set the guest page's background color to red:

webview.executeScript({ code: "document.body.bgColor = 'red'" });

Parameters
InjectDetails	details	Details of the script to run.
function	(optional) callback	Called after all the JavaScript has been executed. If you specify the callback parameter, it should be a function that looks like this: function(array of any result) {...}; array of any (optional) result The result of the script in every injected frame.

Initiates a find-in-page request.

Parameters
string	searchText	The string to find in the page.
FindOptions	(optional) options	Options for the find request.
function	(optional) callback	Called after all find results have been returned for this find request. If you specify the callback parameter, it should be a function that looks like this: function( FindCallbackResults results) {...}; FindCallbackResults (optional) results Contains all of the results of the find request. results can be omitted if it is not utilized in the callback function body; for example, if the callback is only used to discern when the find request has completed.

Navigates forward one history entry if possible. Equivalent to go(1).

Returns Chrome's internal process ID for the guest web page's current process, allowing embedders to know how many guests would be affected by terminating the process. Two guests will share a process only if they belong to the same app and have the same storage partition ID. The call is synchronous and returns the embedder's cached notion of the current process ID. The process ID isn't the same as the operating system's process ID.

Returns the user agent string used by the webview for guest page requests.

Navigates to a history entry using a history index relative to the current navigation. If the requested navigation is impossible, this method has no effect.

Parameters
integer	relativeIndex	Relative history index to which the webview should be navigated. For example, a value of 2 will navigate forward 2 history entries if possible; a value of -3 will navigate backward 3 entries.

Injects CSS into the guest page.

Parameters
InjectDetails	details	Details of the CSS to insert.
function	(optional) callback	Called after the CSS has been inserted. If you specify the callback parameter, it should be a function that looks like this: function() {...};

Indicates whether or not the webview's user agent string has been overridden by webviewTag.setUserAgentOverride

Reloads the current top-level page.

Override the user agent string used by the webview for guest page requests.

Parameters
string	userAgent	The user agent string to use.

Stops loading the current <webview> navigation if in progress.

Ends the current find session (clearing all highlighting) and cancels all find requests in progress.

Parameters
enum of "clear", "keep", or "activate"	(optional) action	Determines what to do with the active match after the find session has ended. clear will clear the highlighting over the active match; keep will keep the active match highlighted; activate will keep the active match highlighted and simulate a user click on that match. The default action is keep.

Forcibly kills the guest web page's renderer process. This may affect multiple webview tags in the current app if they share the same process, but it will not affect webview tags in other apps.

Fired when the guest window attempts to close itself.

The following example code navigates the webview to about:blank when the guest attempts to close itself.

webview.addEventListener('close', function() {
  webview.src = 'about:blank';
});

Fired when the guest window logs a console message.

The following example code forwards all log messages to the embedder's console without regard for log level or other properties.

webview.addEventListener('consolemessage', function(e) {
  console.log('Guest page logged a message: ', e.message);
});

integer level The severity level of the log message. Ranges from 0 to 4. string message The logged message contents. integer line The line number of the message source. string sourceId A string identifying the resource which logged the message.

Fired when the guest window fires a load event.

The following example code modifies the default font size of the guest's body element after the page loads:

webview.addEventListener('contentload', function() {
  webview.executeScript({ code: 'document.body.style.fontSize = "42px"' });
});

Fired when the guest window attempts to open a modal dialog via window.alert, window.confirm, or window.prompt.

Handling this event will block the guest process until each event listener returns or the dialog object becomes unreachable (if preventDefault() was called.)

The default behavior is to cancel the dialog.

enum of "alert", "confirm", or "prompt" messageType The type of modal dialog requested by the guest. string messageText The text the guest attempted to display in the modal dialog. DialogController dialog An interface that can be used to respond to the guest's modal request.

Fired when the process rendering the guest web content has exited.

The following example code will show a farewell message whenever the guest page crashes:

webview.addEventListener('exit', function(e) {
  if (e.reason === 'crash') {
    webview.src = 'data:text/plain,Goodbye, world!';
  }
});

integer processID Chrome's interal ID of the process that exited. enum of "normal", "abnormal", "crash", or "kill" reason String indicating the reason for the exit.

Fired when new find results are available for an active find request. This might happen multiple times for a single find request as matches are found.

string searchText The string that is being searched for in the page. integer numberOfMatches The number of matches found for searchText on the page so far. integer activeMatchOrdinal The ordinal number of the current active match, if it has been found. This will be 0 until then. SelectionRect selectionRect Describes a rectangle around the active match, if it has been found, in screen coordinates. boolean canceled Indicates whether the find request was canceled. string finalUpdate Indicates that all find requests have completed and that no more findupdate events will be fired until more find requests are made.

Fired when a top-level load has aborted without committing.

string url Requested URL. boolean isTopLevel Whether the load was top-level or in a subframe. enum of "networkError", "download", "canceled", "sslError", or "safeBrowsingError" reason String indicating what type of abort occurred.

Fired when a load has committed.

string url The URL that committed. boolean isTopLevel Whether the load is top-level or in a subframe.

Fired when a top-level load request has redirected to a different URL.

string oldUrl The requested URL before the redirect. string newUrl The new URL after the redirect. boolean isTopLevel Whether or not the redirect happened at top-level or in a subframe.

Fired when a load has begun.

string url Requested URL. boolean isTopLevel Whether the load is top-level or in a subframe.

Fired when all loads in the guest page (including all subframes) have completed. Fires in addition to any related loadcommit or loadabort events, which occur per-frame.

Fired when the guest page attempts to open a new browser window.

The following example code will create and navigate a new webview in the embedder for each requested new window:

webview.addEventListener('newwindow', function(e) {
  var newWebview = document.createElement('webview');
  document.body.appendChild(newWebview);
  e.window.attach(newWebview);
});

NewWindow window An interface that can be used to either attach the requested target page to an existing webview element or explicitly discard the request. string targetUrl The target URL requested for the new window. double initialWidth The initial width requested for the new window. double initialHeight The initial height requested for the new window. string name The requested name of the new window. enum of "ignore", "save_to_disk", "current_tab", "new_background_tab", "new_foreground_tab", "new_window", or "new_popup" windowOpenDisposition The requested disposition of the new window.

Fired when the guest page needs to request special permission from the embedder.

The following example code will grant the guest page access to the webkitGetUserMedia API. Note that an app using this example code must itself specify audioCapture and/or videoCapture manifest permissions:

webview.addEventListener('permissionrequest', function(e) {
  if (e.permission === 'media') {
    e.request.allow();
  }
});

enum of "media", "geolocation", "pointerLock", "download", or "loadplugin" permission The type of permission being requested. integer requestId A number which uniquely identifies this request from the guest. object request An object which holds details of the requested permission. Depending on the type of permission requested, this may be a webviewTag.MediaPermissionRequest, webviewTag.GeolocationPermissionRequest, webviewTag.PointerLockPermissionRequest, webviewTag.DownloadPermissionRequest, or webviewTag.LoadPluginPermissionRequest.

Fired when the process rendering the guest web content has become responsive again after being unresponsive.

The following example code will fade the webview element in or out as it becomes responsive or unresponsive:

webview.style.webkitTransition = 'opacity 250ms';
webview.addEventListener('unresponsive', function() {
  webview.style.opacity = '0.5';
});
webview.addEventListener('responsive', function() {
  webview.style.opacity = '1';
});

integer processID Chrome's internal ID of the process that became responsive.

Fired when the embedded web content has been resized. Only fires if autosize is enabled.

double oldWidth Old width of embedded web content. double oldHeight Old height of embedded web content. double newWidth New width of embedded web content. double newHeight New height of embedded web content.

Fired when the process rendering the guest web content has become unresponsive. This event will be generated once with a matching responsive event if the guest begins to respond again.

integer processID Chrome's internal ID of the process that has become unresponsive.