Struct WebView 

pub struct WebView { /* private fields */ }

Implementations

impl WebView

pub fn renderer( self, renderer: WebRenderer, ) -> Result<Self, RendererUnavailable>

Select an engine for this context, failing instead of falling back silently. Rebuild the piece at its current URL to switch an existing page’s renderer.

pub fn profile(self, profile: WebProfile) -> Self

Share cookies, local storage, cache and engine site data with other views using this profile.

pub fn url_binding(self, url: impl Binding<String>) -> Self

Bind the actual page URL, including native navigation reports, to application state. Useful for an address bar on bundled/resource views. Notify .go() to load the value.

pub fn on_load(self, callback: impl Fn() + 'static) -> Self

Called on the UI thread after the backend reports a completed navigation. Useful for applying the latest presentation state through JsHandle, including same-URL reloads. Available on native backends that report navigation; not on emulated iframe hosts.

pub fn go(self, trigger: Trigger) -> Self

Load the current value of the bound url whenever trigger fires.

pub fn back(self, trigger: Trigger) -> Self

Navigate back in history whenever trigger fires.

pub fn forward(self, trigger: Trigger) -> Self

Navigate forward in history whenever trigger fires.

pub fn stop(self, trigger: Trigger) -> Self

Stop the current load whenever trigger fires.

pub fn reload(self, trigger: Trigger) -> Self

Reload the current page whenever trigger fires.

pub fn force_reload(self, trigger: Trigger) -> Self

Reload from the server, bypassing cached resources. Check force_reload_support.

pub fn js(self, handle: JsHandle) -> Self

Bind a JsHandle so handle.eval(…) runs in this view (docs/webview-eval.md).

pub fn session(self, session: WebSession) -> Self

Show a retained WebSession, so the loaded page survives navigating away and back.

pub fn start_page(self, page: impl Into<String>) -> Self

Inline mode only: the page within the site to open first, instead of index.html. A query or fragment is part of the page ("player.html?src=hello"), and the site reads it back through location.search / location.hash as it would on a server.

pub fn app_assets(self) -> Self

Inline mode only: let the site read the app’s whole resource/assets/ tree, not just its own directory.

A self-contained site needs nothing here. Ask for it when the page’s job is to show the app’s own files — a player, a viewer, a renderer — because those files live in the app’s asset namespace and the site’s relative URLs have to reach them (day-piece-lottie’s player is this: one page, any of the app’s animations).

pub fn transparent(self) -> Self

Draw no background of the view’s own: where the page’s own background is transparent, the app shows through, the way an image with an alpha channel sits on whatever is behind it.

What a web view is for here is content that belongs to the app’s own surface (an animation player, a rendered diagram, a badge), where the view’s usual white sheet reads as a hole in the window. A page that sets a background of its own still draws it. Every arm honors it (docs/webview.md “A transparent view”).

pub fn on_new_tab<M1, M2>( self, foreground_label: impl IntoText<M1>, background_label: impl IntoText<M2>, f: impl Fn(&NewTabRequest) + 'static, ) -> Self

Decide what happens to a navigation that leaves an inline/resource site. On Apple backends, also opts ordinary documents into reporting user-activated links and new windows; initial loads, subframes and same-document fragments stay in view. Runs on the main thread with the target URL; without it every external link is LinkPolicy::OpenSystem. The closure may do arbitrary in-app work (navigate the day app, log) and return LinkPolicy::Ignore. Handle a request for a separate tab without replacing the source document. Labels must be localized by the application. Background requests preserve focus.

pub fn on_external_link(self, f: impl Fn(&str) -> LinkPolicy + 'static) -> Self

Trait Implementations

impl Piece for WebView

fn build(self, cx: &mut BuildCx) -> RNode

impl WebViewBuilder for WebView

fn profile(self, profile: WebProfile) -> Self

Share cookies, local storage, cache and engine site data with other views using this profile.

fn url_binding(self, url: impl Binding<String>) -> Self

Bind the actual page URL, including native navigation reports, to application state. Useful for an address bar on bundled/resource views. Notify .go() to load the value.

fn on_load(self, callback: impl Fn() + 'static) -> Self

Called on the UI thread after the backend reports a completed navigation. Useful for applying the latest presentation state through JsHandle, including same-URL reloads. Available on native backends that report navigation; not on emulated iframe hosts.

fn go(self, trigger: Trigger) -> Self

Load the current value of the bound url whenever trigger fires.

fn back(self, trigger: Trigger) -> Self

Navigate back in history whenever trigger fires.

fn forward(self, trigger: Trigger) -> Self

Navigate forward in history whenever trigger fires.

fn stop(self, trigger: Trigger) -> Self

Stop the current load whenever trigger fires.

fn reload(self, trigger: Trigger) -> Self

Reload the current page whenever trigger fires.

fn force_reload(self, trigger: Trigger) -> Self

Reload from the server, bypassing cached resources. Check force_reload_support.

fn js(self, handle: JsHandle) -> Self

Bind a JsHandle so handle.eval(…) runs in this view (docs/webview-eval.md).

fn session(self, session: WebSession) -> Self

Show a retained WebSession, so the loaded page survives navigating away and back.

fn start_page(self, page: impl Into<String>) -> Self

Inline mode only: the page within the site to open first, instead of index.html. A query or fragment is part of the page ("player.html?src=hello"), and the site reads it back through location.search / location.hash as it would on a server.

fn app_assets(self) -> Self

Inline mode only: let the site read the app’s whole resource/assets/ tree, not just its own directory.

fn transparent(self) -> Self

Draw no background of the view’s own: where the page’s own background is transparent, the app shows through, the way an image with an alpha channel sits on whatever is behind it.

fn on_new_tab<M1, M2>( self, foreground_label: impl IntoText<M1>, background_label: impl IntoText<M2>, f: impl Fn(&NewTabRequest) + 'static, ) -> Self

Decide what happens to a navigation that leaves an inline/resource site. On Apple backends, also opts ordinary documents into reporting user-activated links and new windows; initial loads, subframes and same-document fragments stay in view. Runs on the main thread with the target URL; without it every external link is LinkPolicy::OpenSystem. The closure may do arbitrary in-app work (navigate the day app, log) and return LinkPolicy::Ignore. Handle a request for a separate tab without replacing the source document. Labels must be localized by the application. Background requests preserve focus.

fn on_external_link(self, f: impl Fn(&str) -> LinkPolicy + 'static) -> Self