Struct tauri_runtime::webview::WebviewAttributes

pub struct WebviewAttributes {
    pub url: WindowUrl,
    pub initialization_scripts: Vec<String>,
    pub data_directory: Option<PathBuf>,
    pub uri_scheme_protocols: HashMap<String, Box<dyn Fn(&str) -> Result<Vec<u8>, Box<dyn Error>> + Send + Sync + 'static>>,
    pub file_drop_handler_enabled: bool,
}

The attributes used to create an webview.

Fields

url: WindowUrl

initialization_scripts: Vec<String>

data_directory: Option<PathBuf>

uri_scheme_protocols: HashMap<String, Box<dyn Fn(&str) -> Result<Vec<u8>, Box<dyn Error>> + Send + Sync + 'static>>

file_drop_handler_enabled: bool

Implementations

impl WebviewAttributes

pub fn new(url: WindowUrl) -> Self

Initializes the default attributes for a webview.

pub fn initialization_script(self, script: &str) -> Self

Sets the init script.

pub fn data_directory(self, data_directory: PathBuf) -> Self

Data directory for the webview.

pub fn has_uri_scheme_protocol(&self, name: &str) -> bool

Whether the webview URI scheme protocol is defined or not.

pub fn register_uri_scheme_protocol<N: Into<String>, H: Fn(&str) -> Result<Vec<u8>, Box<dyn Error>> + Send + Sync + 'static>(
    self,
    uri_scheme: N,
    protocol: H
) -> Self

Registers a webview protocol handler. Leverages setURLSchemeHandler on macOS, AddWebResourceRequestedFilter on Windows and webkit-web-context-register-uri-scheme on Linux.

Arguments

• uri_scheme The URI scheme to register, such as example.
• protocol the protocol associated with the given URI scheme. It’s a function that takes an URL such as example://localhost/asset.css.

pub fn disable_file_drop_handler(self) -> Self

Disables the file drop handler. This is required to use drag and drop APIs on the front end on Windows.

Trait Implementations

impl Debug for WebviewAttributes

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.