Struct TrayIconConfig

pub struct TrayIconConfig {
    pub id: Option<String>,
    pub icon_path: PathBuf,
    pub icon_as_template: bool,
    pub menu_on_left_click: bool,
    pub title: Option<String>,
    pub tooltip: Option<String>,
}

Configuration for application tray icon.

See more: https://v2.tauri.app/reference/config/#trayiconconfig

Fields

id: Option<String>

Set an id for this tray icon so you can reference it later, defaults to main.

icon_path: PathBuf

Path to the default icon to use for the tray icon.

Note: this stores the image in raw pixels to the final binary, so keep the icon size (width and height) small or else it’s going to bloat your final executable

icon_as_template: bool

A Boolean value that determines whether the image represents a template image on macOS.

menu_on_left_click: bool

A Boolean value that determines whether the menu should appear when the tray icon receives a left click on macOS.

title: Option<String>

Title for MacOS tray

tooltip: Option<String>

Tray icon tooltip on Windows and macOS

Trait Implementations

impl Clone for TrayIconConfig

fn clone(&self) -> TrayIconConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrayIconConfig

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

Formats the value using the given formatter.

impl Default for TrayIconConfig

fn default() -> TrayIconConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TrayIconConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TrayIconConfig

fn eq(&self, other: &TrayIconConfig) -> 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.

impl Serialize for TrayIconConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TrayIconConfig

impl StructuralPartialEq for TrayIconConfig