Trait tauri::plugin::Plugin

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

    fn initialize(&mut self, app: &AppHandle<R>, config: JsonValue) -> Result<()> { ... }
    fn initialization_script(&self) -> Option<String> { ... }
    fn created(&mut self, window: Window<R>) { ... }
    fn on_page_load(&mut self, window: Window<R>, payload: PageLoadPayload) { ... }
    fn on_event(&mut self, app: &AppHandle<R>, event: &RunEvent) { ... }
    fn extend_api(&mut self, invoke: Invoke<R>) { ... }
}

The plugin interface.

Required Methods

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

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

Provided Methods

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

Initializes the plugin.

Examples found in repository

src/plugin.rs (lines 533-536)

  pub(crate) fn initialize(
    &mut self,
    app: &AppHandle<R>,
    config: &PluginConfig,
  ) -> crate::Result<()> {
    self.store.values_mut().try_for_each(|plugin| {
      plugin
        .initialize(
          app,
          config.0.get(plugin.name()).cloned().unwrap_or_default(),
        )
        .map_err(|e| crate::Error::PluginInitialization(plugin.name().to_string(), e.to_string()))
    })
  }

src/app.rs (lines 427-436)

  pub fn plugin<P: Plugin<R> + 'static>(&self, mut plugin: P) -> crate::Result<()> {
    plugin
      .initialize(
        self,
        self
          .config()
          .plugins
          .0
          .get(plugin.name())
          .cloned()
          .unwrap_or_default(),
      )
      .map_err(|e| crate::Error::PluginInitialization(plugin.name().to_string(), e.to_string()))?;
    self
      .manager()
      .inner
      .plugins
      .lock()
      .unwrap()
      .register(plugin);
    Ok(())
  }

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.

Since it runs on all top-level document and child frame page navigations, it’s recommended to check the window.location to guard your script from running on unexpected origins.

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

Examples found in repository

src/plugin.rs (line 546)

  pub(crate) fn initialization_script(&self) -> String {
    self
      .store
      .values()
      .filter_map(|p| p.initialization_script())
      .fold(String::new(), |acc, script| {
        format!("{}\n(function () {{ {} }})();", acc, script)
      })
  }

fn created(&mut self, window: Window<R>)

Callback invoked when the webview is created.

Examples found in repository

src/plugin.rs (line 557)

  pub(crate) fn created(&mut self, window: Window<R>) {
    self
      .store
      .values_mut()
      .for_each(|plugin| plugin.created(window.clone()))
  }

fn on_page_load(&mut self, window: Window<R>, payload: PageLoadPayload)

Callback invoked when the webview performs a navigation to a page.

Examples found in repository

src/plugin.rs (line 565)

  pub(crate) fn on_page_load(&mut self, window: Window<R>, payload: PageLoadPayload) {
    self
      .store
      .values_mut()
      .for_each(|plugin| plugin.on_page_load(window.clone(), payload.clone()))
  }

fn on_event(&mut self, app: &AppHandle<R>, event: &RunEvent)

Callback invoked when the event loop receives a new event.

Examples found in repository

src/plugin.rs (line 573)

  pub(crate) fn on_event(&mut self, app: &AppHandle<R>, event: &RunEvent) {
    self
      .store
      .values_mut()
      .for_each(|plugin| plugin.on_event(app, event))
  }

fn extend_api(&mut self, invoke: Invoke<R>)

Extend commands to crate::Builder::invoke_handler.

Examples found in repository

src/plugin.rs (line 587)

  pub(crate) fn extend_api(&mut self, mut invoke: Invoke<R>) {
    let command = invoke.message.command.replace("plugin:", "");
    let mut tokens = command.split('|');
    // safe to unwrap: split always has a least one item
    let target = tokens.next().unwrap();

    if let Some(plugin) = self.store.get_mut(target) {
      invoke.message.command = tokens
        .next()
        .map(|c| c.to_string())
        .unwrap_or_else(String::new);
      plugin.extend_api(invoke);
    } else {
      invoke
        .resolver
        .reject(format!("plugin {} not found", target));
    }
  }

Implementors

impl<R: Runtime, C: DeserializeOwned> Plugin<R> for TauriPlugin<R, C>