Struct tauri::SystemTray

source ·
#[non_exhaustive]
pub struct SystemTray { pub id: String, pub icon: Option<Icon>, pub menu: Option<SystemTrayMenu>, /* private fields */ }
Available on crate feature system-tray only.
Expand description

Represents a System Tray instance.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§id: String

The tray identifier. Defaults to a random string.

§icon: Option<Icon>

The tray icon.

§menu: Option<SystemTrayMenu>

The tray menu.

Implementations§

Creates a new system tray that only renders an icon.

Examples
use tauri::SystemTray;

tauri::Builder::default()
  .setup(|app| {
    let tray_handle = SystemTray::new().build(app)?;
    Ok(())
  });

Sets the tray identifier, used to retrieve its handle and to identify a tray event source.

Examples
use tauri::SystemTray;

tauri::Builder::default()
  .setup(|app| {
    let tray_handle = SystemTray::new()
      .with_id("tray-id")
      .build(app)?;
    Ok(())
  });

Sets the tray Icon.

Examples
use tauri::{Icon, SystemTray};

tauri::Builder::default()
  .setup(|app| {
    let tray_handle = SystemTray::new()
      // dummy and invalid Rgba icon; see the Icon documentation for more information
      .with_icon(Icon::Rgba { rgba: Vec::new(), width: 0, height: 0 })
      .build(app)?;
    Ok(())
  });

Sets the event listener for this system tray.

Examples
use tauri::{Icon, Manager, SystemTray, SystemTrayEvent};

tauri::Builder::default()
  .setup(|app| {
    let handle = app.handle();
    let id = "tray-id";
    SystemTray::new()
      .with_id(id)
      .on_event(move |event| {
        let tray_handle = handle.tray_handle_by_id(id).unwrap();
        match event {
          // show window with id "main" when the tray is left clicked
          SystemTrayEvent::LeftClick { .. } => {
            let window = handle.get_window("main").unwrap();
            window.show().unwrap();
            window.set_focus().unwrap();
          }
          _ => {}
        }
      })
      .build(app)?;
    Ok(())
  });

Sets the menu to show when the system tray is right clicked.

Examples
use tauri::{CustomMenuItem, SystemTray, SystemTrayMenu};

tauri::Builder::default()
  .setup(|app| {
    let tray_handle = SystemTray::new()
      .with_menu(
        SystemTrayMenu::new()
          .add_item(CustomMenuItem::new("quit", "Quit"))
          .add_item(CustomMenuItem::new("open", "Open"))
      )
      .build(app)?;
    Ok(())
  });

Builds and shows the system tray.

Examples
use tauri::{CustomMenuItem, SystemTray, SystemTrayMenu};

tauri::Builder::default()
  .setup(|app| {
    let tray_handle = SystemTray::new()
      .with_menu(
        SystemTrayMenu::new()
          .add_item(CustomMenuItem::new("quit", "Quit"))
          .add_item(CustomMenuItem::new("open", "Open"))
      )
      .build(app)?;

      tray_handle.get_item("quit").set_enabled(false);
    Ok(())
  });

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more