Struct WebView 

pub struct WebView { /* private fields */ }

A webview based on wry WebView.

With the gpui-fast feature, macOS and Linux host the native view in a window composition surface, so deferred GPUI overlays render above the page. Without it, the native view covers GPUI content in its bounds and extends past a container that clips it.

[experimental]

Implementations

impl WebView

pub fn new(webview: WebView, window: &mut Window, cx: &mut App) -> Self

Create a new WebView from a wry WebView.

pub fn build( builder: WebViewBuilder<'_>, window: &mut Window, cx: &mut App, ) -> Result<Self>

Build a webview as a child of window, performing the platform setup Wry requires.

On Linux the window must run on X11 or XWayland: start the application with gpui_kit::platform::linux(WindowingModes::X11). A Wayland window returns an error. This also initializes GTK and drives its main loop from GPUI. With the gpui-fast feature, the webview is built in a window composition surface so GPUI overlays can render above it.

pub fn set_bounds(&self, bounds: Rect) -> Result<()>

Set window-relative bounds, including offscreen loading bounds. With window composition, position the managed container and its child together.

pub fn set_geometry( &self, document: Bounds<Pixels>, clip: Bounds<Pixels>, ) -> Result<()>

Apply full document bounds and an inherited clip without changing the DOM viewport. Empty clips hide the native surface while preserving the loaded document. Partial clipping requires native window composition; without it, the native view takes the full document bounds and extends past the clip.

pub fn set_visible(&self, visible: bool) -> Result<()>

Set visibility and report native errors without discarding the loaded page.

pub fn show(&mut self)

Show the webview.

pub fn hide(&mut self)

Hide the webview.

pub fn visible(&self) -> bool

Get whether the webview is visible.

pub fn bounds(&self) -> Bounds<Pixels>

Get the current bounds of the webview.

pub fn back(&mut self) -> Result<()>

Go back in the webview history.

pub fn forward(&mut self) -> Result<()>

Go forward in the webview history.

pub fn load_url(&mut self, url: &str)

Load a URL in the webview.

pub fn set_theme(&self, theme: Theme) -> Result<()>

Set the colour scheme the page sees in prefers-color-scheme and draws its native controls in. Theme::Auto follows the system again.

On Linux this is GTK’s process-wide gtk-application-prefer-dark-theme, so it applies to every webview in the application.

pub fn set_zoom(&self, zoom: f64) -> Result<()>

Zoom the page, where 1.0 is its natural size. The engine scales the page itself, without the relayout and repaint a CSS zoom causes, and keeps the factor across navigations.

pub fn zoom(&self) -> f64

The page zoom last set with WebView::set_zoom.

pub fn raw(&self) -> &WebView

Get the raw wry webview.

pub fn handle(&self) -> WebViewHandle

Get an owned, UI-thread-local handle to the raw wry webview.

Methods from Deref<Target = WebView>

pub fn id(&self) -> &str

Returns the id of this webview.

pub fn url(&self) -> Result<String, Error>

Get the current url of the webview

pub fn evaluate_script(&self, js: &str) -> Result<(), Error>

Evaluate and run javascript code.

pub fn evaluate_script_with_callback( &self, js: &str, callback: impl Fn(String) + Send + 'static, ) -> Result<(), Error>

Evaluate and run javascript code with callback function. The evaluation result will be serialized into a JSON string and passed to the callback function.

Exception is ignored because of the limitation on windows. You can catch it yourself and return as string as a workaround.

• ** Android:** Not implemented yet.

pub fn print(&self) -> Result<(), Error>

Launch print modal for the webview content.

pub fn cookies_for_url(&self, url: &str) -> Result<Vec<Cookie<'static>>, Error>

Get a list of cookies for specific url.

pub fn cookies(&self) -> Result<Vec<Cookie<'static>>, Error>

Get the list of cookies.

Platform-specific

• Android: Unsupported, always returns an empty Vec.

pub fn set_cookie(&self, cookie: &Cookie<'_>) -> Result<(), Error>

Set a cookie for the webview.

Platform-specific

• Android: Not supported.

pub fn delete_cookie(&self, cookie: &Cookie<'_>) -> Result<(), Error>

Delete a cookie for the webview.

Platform-specific

• Android: Not supported.

pub fn open_devtools(&self)

Open the web inspector which is usually called dev tool.

Platform-specific

• Android / iOS: Not supported.

pub fn close_devtools(&self)

Close the web inspector which is usually called dev tool.

Platform-specific

• Windows / Android / iOS: Not supported.

pub fn is_devtools_open(&self) -> bool

Gets the devtool window’s current visibility state.

Platform-specific

• Windows / Android / iOS: Not supported.

pub fn zoom(&self, scale_factor: f64) -> Result<(), Error>

Set the webview zoom level

Platform-specific:

• Android: Not supported.
• macOS: available on macOS 11+ only.
• iOS: available on iOS 14+ only.

pub fn set_background_color( &self, background_color: (u8, u8, u8, u8), ) -> Result<(), Error>

Specify the webview background color.

The color uses the RGBA format.

Platfrom-specific:

• macOS: Not implemented.
• Windows:
  • On Windows 7, transparency is not supported and the alpha value will be ignored.
  • On Windows higher than 7: translucent colors are not supported so any alpha value other than 0 will be replaced by 255

pub fn load_url(&self, url: &str) -> Result<(), Error>

Navigate to the specified url

pub fn reload(&self) -> Result<(), Error>

Reloads the current page.

pub fn load_url_with_headers( &self, url: &str, headers: HeaderMap, ) -> Result<(), Error>

Navigate to the specified url using the specified headers

pub fn load_html(&self, html: &str) -> Result<(), Error>

Load html content into the webview

pub fn clear_all_browsing_data(&self) -> Result<(), Error>

Clear all browsing data

pub fn bounds(&self) -> Result<Rect, Error>

pub fn set_bounds(&self, bounds: Rect) -> Result<(), Error>

Set the webview bounds.

This is only effective if the webview was created as a child or created using [WebViewBuilderExtUnix::new_gtk] with gtk::Fixed.

pub fn set_visible(&self, visible: bool) -> Result<(), Error>

Shows or hides the webview.

pub fn focus(&self) -> Result<(), Error>

Try moving focus to the webview.

pub fn focus_parent(&self) -> Result<(), Error>

Try moving focus away from the webview back to the parent window.

Platform-specific:

• Android: Not implemented.

Trait Implementations

impl Deref for WebView

type Target = WebView

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for WebView

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl EventEmitter<DismissEvent> for WebView

impl Focusable for WebView

fn focus_handle(&self, _cx: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for WebView

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.