Trait Plugin

Source

pub trait Plugin<R: Runtime>: Send {
    // Required method
    fn name(&self) -> &'static str;

    // Provided methods
    fn initialize(
        &mut self,
        app: &AppHandle<R>,
        config: JsonValue,
    ) -> Result<(), Box<dyn Error>> { ... }
    fn initialization_script(&self) -> Option<String> { ... }
    fn initialization_script_2(&self) -> Option<InitializationScript> { ... }
    fn window_created(&mut self, window: Window<R>) { ... }
    fn webview_created(&mut self, webview: Webview<R>) { ... }
    fn on_navigation(&mut self, webview: &Webview<R>, url: &Url) -> bool { ... }
    fn on_page_load(
        &mut self,
        webview: &Webview<R>,
        payload: &PageLoadPayload<'_>,
    ) { ... }
    fn on_event(&mut self, app: &AppHandle<R>, event: &RunEvent) { ... }
    fn extend_api(&mut self, invoke: Invoke<R>) -> bool { ... }
}

Expand description

The plugin interface.

Required Methods§

Source

fn name(&self) -> &'static str

The plugin name. Used as key on the plugin config object.

Provided Methods§

Source

fn initialize( &mut self, app: &AppHandle<R>, config: JsonValue, ) -> Result<(), Box<dyn Error>>

Initializes the plugin.

Source

fn initialization_script(&self) -> Option<String>

Add the provided JavaScript to a list of scripts that should be run after the global object has been created, but before the HTML document has been parsed and before any other script included by the HTML document is run.

The script is wrapped into its own context with (function () { /* your script here */ })();, so global variables must be assigned to window instead of implicitly declared.

This is executed only on the main frame. If you only want to run it in all frames, use Plugin::initialization_script_2 to set that to false.

§Platform-specific

Windows: scripts are always added to subframes.
Android: When addDocumentStartJavaScript is not supported, we prepend initialization scripts to each HTML head (implementation only supported on custom protocol URLs). For remote URLs, we use onPageStarted which is not guaranteed to run before other scripts.

Source