Struct WebView 

pub struct WebView { /* private fields */ }

Available on crate feature webview only.

Embeds a native WebView pointing to a given URL as a regular element in your UI.

Requirements

The WebViewPlugin must be registered in your LaunchConfig for this component to work, otherwise it will panic:

launch(
    LaunchConfig::new()
        .with_plugin(WebViewPlugin::new())
        .with_window(WindowConfig::new(app)),
);

WebViews are not supported on every platform, see the crate-level docs for details.

Example

fn app() -> impl IntoElement {
    WebView::new("https://example.com").expanded()
}

Implementations

impl WebView

pub fn new(url: impl Into<String>) -> WebView

pub fn url(self, url: impl Into<String>) -> WebView

Set the URL the WebView will load.

pub fn id(self, id: WebViewId) -> WebView

Set a custom WebViewId so the WebView can be referenced later, e.g. with WebViewManager::close.

pub fn close_on_drop(self, close: bool) -> WebView

If you decide to not close the webview on drop you will need to manually close it with WebViewManager::close.

pub fn on_created( self, on_created: impl Fn(WebViewBuilder<'_>) -> WebViewBuilder<'_> + Send + 'static, ) -> WebView

Customize the underlying [wry::WebViewBuilder] right before the WebView is built, for example to set a custom user agent or inject initialization scripts.

Trait Implementations

impl Clone for WebView

fn clone(&self) -> WebView

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for WebView

fn render(&self) -> impl IntoElement

fn render_key(&self) -> DiffKey

impl ContainerExt for WebView

fn position(self, position: impl Into<Position>) -> Self

Set how the element is placed relative to its parent or the window. See Position.

fn padding(self, padding: impl Into<Gaps>) -> Self

Set the inner spacing between the element’s edges and its content. See Gaps.

fn margin(self, margin: impl Into<Gaps>) -> Self

Set the outer spacing between the element’s edges and its surroundings. See Gaps.

fn min_width(self, minimum_width: impl Into<Size>) -> Self

Set the minimum width the element can shrink to. See Size.

fn min_height(self, minimum_height: impl Into<Size>) -> Self

Set the minimum height the element can shrink to. See Size.

fn max_width(self, maximum_width: impl Into<Size>) -> Self

Set the maximum width the element can grow to. See Size.

fn max_height(self, maximum_height: impl Into<Size>) -> Self

Set the maximum height the element can grow to. See Size.

fn visible_width(self, visible_width: impl Into<VisibleSize>) -> Self

Set how much of the measured width is actually used in layout. See VisibleSize.

fn visible_height(self, visible_height: impl Into<VisibleSize>) -> Self

Set how much of the measured height is actually used in layout. See VisibleSize.

impl LayoutExt for WebView

fn get_layout(&mut self) -> &mut LayoutData

Returns a mutable reference to the element’s layout data.

fn layout(self, layout: LayoutData) -> Self

Replace all of the element’s layout data at once. See LayoutData.

impl PartialEq for WebView

fn eq(&self, other: &WebView) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.