Browser

Native webview using system browser.

Using Browser requires relatively new operating systems, for macOS the minimum version required is 10.10, for Linux it is required to install the webkit2gtk library with at least version 2.8.

On Windows the latest version of IE installed would be used by default.

On Linux due to poor support of hardware acceleration, the browser may fail to show anything, in that case you may want to disable hardware acceleration.

WebView2 support

On Windows there is support for using WebView2 as browser backend, to enable it, you need to:

1. Set the webview2support option to true.
2. Ship the WebView2Loader.dll file together with your program.
3. Have users install Edge Beta/Dev/Canary or WebView2 Runtime on their machines.

There are also a few things to notice:

1. When WebView2 failed to initialize for any reason, the browser will fallback to use IE as backend quietly.
2. If you don't use WebView2, it is safe to remove the WebView2Loader.dll file.
3. WebView2 can not use stable channels of Edge, it will search channels in the order of WebView2 Runtime, Beta, Dev, and Canary.
4. Some Browser APIs are not implemented with WebView2 backend, due to lack of APIs in WebView2.

Class methods

create(options)

Create a new browser view.

Parameters

• Browser::Options options

Return

registerprotocol(scheme, handler)

Register a custom protocol with scheme and handler.

When the browser sends a request with scheme, the handler will be called with handler(url), and the handler must return an instance of class that inherits from ProtocolJob.

The handler is guaranteed to be called in the main thread.

This API is not supported on Windows with WebView2 backend.

Parameters

• string scheme
• function handler

Return

unregisterprotocol(scheme)

Unregister the custom protocol with scheme.

This API is not supported on Windows with WebView2 backend.

Parameters

• string scheme

Methods

loadurl(url)

Load the URL.

Parameters

• string url

loadhtml(html, baseurl)

Set the webpage contents and base URL.

On Windows with WebView2 backend, baseurl is not respected.

Parameters

• string html - The string to use as the contents of the webpage.
• string baseurl - A URL used to resolve relative URLs within the document.

geturl()

Return current URL.

Return

gettitle()

Return the title of document.

Return

setuseragent(useragent)

Change browser's user agent.

On Windows, due to Internet Explorer's limitations, calling SetUserAgent would change all web pages' user agents in current process.

This API is not supported on Windows with WebView2 backend.

Parameters

• string useragent

ismagnifiable() macOS

Return whether page's magnification can be changed with gestures.

Return

setmagnifiable(magnifiable) macOS

Set whether page's magnification can be changed with gestures.

Parameters

• boolean magnifiable

executejavascript(code, callback)

Evaluate code in browser and get the evaluated result.

The callback will be called with callback(success, result), the result argument is a generic value that created from the result of code.

Note that due to limitations of system toolkits, the execution may fail if the result of execution of code can not be fully converted to JSON.

On Windows with WebView2 backend, the success may be true even when exception is threw in the executed code.

On Windows with IE backend, the code is executed synchronously and the callback is called before this API returns.

Parameters

• string code
• function callback

getcookiesforurl(url, callback)

Receive cookies under url.

This API will include HTTP only cookies.

This API is not implemented on Windows with IE backend.

Parameters

• string url
• function callback

goback()

Navigate to the back item in the back-forward list.

cangoback()

Return whether there is a back item in the back-forward list that can be navigated to.

Return

goforward()

Navigate to the forward item in the back-forward list.

cangoforward()

Return whether there is a forward item in the back-forward list that can be navigated to.

Return

reload()

Reload current page.

stop()

Stop loading all resources on the current page.

isloading()

Return whether current page is loading content.

Return

setbindingname(name)

Set the name of object which would have the native bindings.

By default native bindings are added to the window object, by calling this API, native bindings will be added to the window[name] object.

Parameters

• string name

addbinding(name, func)

Add a native binding to web page with name.

The func will be called with automatically converted arguments.

Parameters

• string name
• function func

addrawbinding(name, func)

Add a raw handler to web page with name.

The func will be called with a list of arguments passed from JavaScript.

Parameters

• string name
• function func

removebinding(name)

Remove the native binding with name.

Parameters

• string name

beginaddingbindings()

Buffer following calls of addbinding until endaddingbindings is called.

Adding a native binding is an expensive operation, if you are adding a lot of bindings, it is recommended to wrap the addbinding calls between a pair of beginaddingbindings and endaddingbindings which will buffer the bindings and reduce the cost to minimal.

endaddingbindings()

Consolidate bindings added.

Events

onclose(self)

Emitted when the web page requests to close.

Parameters

• Browser self

Preventable

onupdatecommand(self)

Emitted when the back-forward list has changed.

Parameters

• Browser self

Preventable

onchangeloading(self)

Emitted when the browser starts or stops loading content.

Parameters

• Browser self

Preventable

onupdatetitle(self, title)

Emitted when document's title is changed.

Parameters

• Browser self
• string title

Preventable

onstartnavigation(self, url)

Emitted when the browser begins provisional navigation.

Parameters

• Browser self
• string url

Preventable

oncommitnavigation(self, url)

Emitted when the browser begins to receive web content.

Parameters

• Browser self
• string url

Preventable

onfinishnavigation(self, url)

Emitted when the navigation is complete.

Parameters

• Browser self
• string url

Preventable

onfailnavigation(self, url, code)

Emitted when the navigation fails.

Parameters

• Browser self
• string url
• integer code

Preventable

Langauge:

Version:

Formats:

Class methods:

• create(options)
• registerprotocol(scheme, handler)
• unregisterprotocol(scheme)

Methods:

• loadurl(url)
• loadhtml(html, baseurl)
• geturl()
• gettitle()
• setuseragent(useragent)
• ismagnifiable()
• setmagnifiable(magnifiable)
• executejavascript(code, callback)
• getcookiesforurl(url, callback)
• goback()
• cangoback()
• goforward()
• cangoforward()
• reload()
• stop()
• isloading()
• setbindingname(name)
• addbinding(name, func)
• addrawbinding(name, func)
• removebinding(name)
• beginaddingbindings()
• endaddingbindings()

Events:

• onclose(self)
• onupdatecommand(self)
• onchangeloading(self)
• onupdatetitle(self, title)
• onstartnavigation(self, url)
• oncommitnavigation(self, url)
• onfinishnavigation(self, url)
• onfailnavigation(self, url, code)

Components:

• AbstractTableModel
• App
• Appearance
• AttributedText
• Browser
• Button
• Canvas
• Clipboard
• Color
• ComboBox
• Container
• Cursor
• DatePicker
• Entry
• FileDialog
• FileOpenDialog
• FileSaveDialog
• Font
• GifPlayer
• GlobalShortcut
• Group
• Image
• Label
• Lifetime
• Locale
• Menu
• MenuBar
• MenuBase
• MenuItem
• MessageLoop
• MessageBox
• Notification
• NotificationCenter
• Painter
• Picker
• ProgressBar
• ProtocolAsarJob
• ProtocolFileJob
• ProtocolJob
• ProtocolStringJob
• Responder
• Screen
• Scroll
• Separator
• SimpleTableModel
• Slider
• Tab
• Table
• TableModel
• TextEdit
• Toolbar
• Tray
• Vibrant
• View
• Window