WebView#

Availability (Key)#

macOS

GTK

Windows

iOS

Android

Web

○

○

○

○

○

The Web View widget is used for displaying an embedded browser window within an application.

Both sites served by a web server and local content can be displayed. Due to security restrictions in the macOS backend WKWebView, local content on macOS can only be loaded from a single directory, relative to the base URL, and not from an absolute “file://” URL. As a workaround, it is possible to use a lightweight web server instead.

../../../_images/WebView.jpeg

Usage#

import toga

web = toga.WebView(url='https://google.com')

Debugging#

If you need to debug the HTML, JavaScript or CSS content of a view, you may want to use the “inspect element” feature of the WebView. This is not be turned on by default on some platforms. To enable WebView debugging:

  • macOS

    Run the following at the terminal:

    $ defaults write com.example.appname WebKitDeveloperExtras -bool true

substituting ``com.example.appname`` with the bundle ID for your app.

Reference#

class toga.widgets.webview.WebView(id=None, style=None, factory=None, url=None, user_agent=None, on_key_down=None, on_webview_load=None)#

A widget to display and open html content.

Parameters:

  • id (str) – An identifier for this widget.

  • style (Style) – An optional style object. If no style is provided then a new one will be created for the widget.

  • url (str) – The URL to start with.

  • user_agent (str) – The user agent for the web view.

  • on_key_down (callable) – The callback method for when a key is pressed within the web view

  • on_webview_load (callable) – The callback method for when the web view loads (or reloads).

Create a base Toga widget.

This is an abstract base class; it cannot be instantiated.

Parameters:

  • id – The ID for the widget.

  • style – A style object. If no style is provided, a default style will be applied to the widget.

property dom#

The current DOM.

Returns:

The current DOM

Return type:

str

async evaluate_javascript(javascript)#

Evaluate a JavaScript expression, returning the result.

This is an asynchronous operation. The method will complete when the return value is available.

Parameters:

javascript (str) – The JavaScript expression to evaluate.

invoke_javascript(javascript)#

Invoke a JavaScript expression.

The result (if any) of the JavaScript is ignored.

No guarantee is provided that the JavaScript has completed execution when `invoke()` returns

Parameters:

javascript (str) – The JavaScript expression to evaluate.

property on_key_down#

The handler to invoke when the button is pressed.

Returns:

The function that is called on button press.

Return type:

callable

property on_webview_load#

The handler to invoke when the web view finishes loading.

Returns:

The function that is called when the web view finishes loading.

Return type:

callable

set_content(root_url, content)#

Set the content of the web view.

Parameters:

  • root_url (str) – The URL

  • content (str) – The new content

property url#

The current URL.

Returns:

The current URL

Return type:

str

property user_agent#

The user agent for the web view as a str.

Returns:

The user agent

Return type:

str