Struct WebView 

pub struct WebView { /* private fields */ }

A webview showing one page.

The page is built after the first time the view is painted, in the window it is painted in, and shows from the paint after that; until then its place is empty. It moves to each other window the view is painted in. It sits at the element’s bounds in every frame the element is painted and is parked in every frame it is not. A parked page stays loaded. A view painted in two windows in turn moves its page on every paint.

The page takes keys while the view’s focus handle is focused, and a press in the page focuses the handle. On macOS, a press on gpui’s view outside the page takes the keys back, whether or not the handle loses focus, and key equivalents (cmd or ctrl held) reach gpui’s key dispatch before the page sees them. On Windows, a key with ctrl or alt held, or a function key, goes to gpui’s key dispatch in place of the page when the keymap binds it in the view’s key context.

gpui elements behind the page are not hovered, and gpui’s cursor over the page is the arrow. On macOS the page sets the cursor over itself.

In a frame where a ui::cover recorded after the view overlaps it, the page is parked. On macOS a still of the page, taken while it is still up, is painted in its place; until the still arrives the page stays over the cover. Elsewhere the place is left empty.

Paints nothing off macOS and Windows.

Implementations

impl WebView

pub fn new( url: impl Into<String>, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

pub fn location(&self) -> Option<&str>

The URL the page last reported; None before its first report.

pub fn title(&self) -> &str

pub fn can_go_back(&self) -> bool

Whether Self::back would move the page, as of its last load or history move. false before the first paint.

pub fn can_go_forward(&self) -> bool

Whether Self::forward would move the page, as of its last load or history move. false before the first paint.

pub fn is_loading(&self) -> bool

pub fn with_user_agent(self, user_agent: impl Into<String>) -> Self

The user agent the page is built with, in place of the platform’s. Read at the first paint. On macOS the default is Safari’s, with the installed Safari’s version.

pub fn with_console(self) -> Self

Reports the page’s console as WebViewEvent::Console. Read at the first paint. Engine messages such as failed loads are not console calls and are not reported. In the inspector, every console message is attributed to the script that reports it.

pub fn with_data_store(self, store: DataStore) -> Self

The store the page is built with, in place of the platform’s default. Read at the first paint. A page keeps the store it was built with: a different store takes a new WebView.

pub fn load(&mut self, url: impl Into<String>)

Before the first paint, replaces the URL the page is built with. After it, navigates the page.

pub fn release_keys(&self)

Takes the keys back from the page if it holds them, whatever gpui’s focus is.

pub fn back(&mut self)

pub fn forward(&mut self)

pub fn reload(&mut self)

pub fn reload_bypassing_cache(&mut self)

Reloads from the network, past the cache.

pub fn eval<T: DeserializeOwned + 'static>( &self, script: &str, timeout: Duration, cx: &App, ) -> Task<Result<T, EvalError>>

Evaluates script, a JavaScript expression, in the page’s main frame and decodes its value from JSON. undefined decodes as null; a promise is not awaited.

Trait Implementations

impl EventEmitter<WebViewEvent> 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.