系统托盘

Tauri 允许你为你的应用创建和自定义系统托盘。这可以通过提供对常用操作的快速访问来增强用户体验。

🌐 Tauri allows you to create and customize a system tray for your application. This can enhance the user experience by providing quick access to common actions.

配置

🌐 Configuration

首先，更新你的 Cargo.toml 以包含系统托盘所需的功能。

🌐 First of all, update your Cargo.toml to include the necessary feature for the system tray.

src-tauri/Cargo.toml

tauri = { version = "2.0.0", features = [ "tray-icon" ] }

使用

🌐 Usage

托盘 API 在 JavaScript 和 Rust 中均可用。

🌐 The tray API is available in both JavaScript and Rust.

创建托盘图标

🌐 Create a Tray Icon

JavaScript

使用 TrayIcon.new 静态函数创建一个新的托盘图标：

import { TrayIcon } from '@tauri-apps/api/tray';

const options = {
  // here you can add a tray menu, title, tooltip, event handler, etc
};

const tray = await TrayIcon.new(options);

有关自定义选项的更多信息，请参见 TrayIconOptions。

🌐 See TrayIconOptions for more information on the customization options.

Rust

use tauri::tray::TrayIconBuilder;

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

有关自定义选项的更多信息，请参阅 TrayIconBuilder。

🌐 See TrayIconBuilder for more information on customization options.

更改托盘图标

🌐 Change the Tray Icon

创建托盘时，你可以使用应用图标作为托盘图标：

🌐 When creating the tray you can use the application icon as the tray icon:

JavaScript

import { TrayIcon } from '@tauri-apps/api/tray';
import { defaultWindowIcon } from '@tauri-apps/api/app';

const options = {
  icon: await defaultWindowIcon(),
};

const tray = await TrayIcon.new(options);

Rust

let tray = TrayIconBuilder::new()
  .icon(app.default_window_icon().unwrap().clone())
  .build(app)?;

添加菜单

🌐 Add a Menu

要附加在点击托盘时显示的菜单，可以使用 menu 选项。

🌐 To attach a menu that is displayed when the tray is clicked, you can use the menu option.

Note

默认情况下，菜单在左键和右键单击时都会显示。

要防止在左键点击时弹出菜单，请调用 show_menu_on_left_click(false) Rust 函数，或者将 menuOnLeftClick JavaScript 选项设置为 false。

🌐 To prevent the menu from popping up on left click, call the show_menu_on_left_click(false) Rust function or set the menuOnLeftClick JavaScript option to false. :::

JavaScript

import { TrayIcon } from '@tauri-apps/api/tray';
import { Menu } from '@tauri-apps/api/menu';

const menu = await Menu.new({
  items: [
    {
      id: 'quit',
      text: 'Quit',
    },
  ],
});

const options = {
  menu,
  menuOnLeftClick: true,
};

const tray = await TrayIcon.new(options);

Rust

use tauri::{
  menu::{Menu, MenuItem},
  tray::TrayIconBuilder,
};

let quit_i = MenuItem::with_id(app, "quit", "Quit", true, None::<&str>)?;
let menu = Menu::with_items(app, &[&quit_i])?;

let tray = TrayIconBuilder::new()
  .menu(&menu)
  .show_menu_on_left_click(true)
  .build(app)?;

监听菜单事件

🌐 Listen to Menu Events

JavaScript

在 JavaScript 中，你可以直接将菜单点击事件监听器附加到菜单项上：

• 使用共享菜单点击处理程序

  import { Menu } from '@tauri-apps/api/menu';
  
  function onTrayMenuClick(itemId) {
    // itemId === 'quit'
  }
  
  const menu = await Menu.new({
    items: [
      {
        id: 'quit',
        text: 'Quit',
        action: onTrayMenuClick,
      },
    ],
  });

• 使用专用菜单点击处理程序

  import { Menu } from '@tauri-apps/api/menu';
  
  const menu = await Menu.new({
    items: [
      {
        id: 'quit',
        text: 'Quit',
        action: () => {
          console.log('quit pressed');
        },
      },
    ],
  });

Rust

使用 TrayIconBuilder::on_menu_event 方法附加托盘菜单点击事件监听器：

use tauri::tray::TrayIconBuilder;

TrayIconBuilder::new()
  .on_menu_event(|app, event| match event.id.as_ref() {
    "quit" => {
      println!("quit menu item was clicked");
      app.exit(0);
    }
    _ => {
      println!("menu item {:?} not handled", event.id);
    }
  })

监听托盘事件

🌐 Listen to Tray Events

托盘图标会触发以下鼠标事件的事件：

🌐 The tray icon emits events for the following mouse events:

• 点击：当光标收到单次左键、右键或中键点击时触发，包括点击是否已释放的信息
• 双击：当光标接收到左键、右键或中键的双击时触发
• 进入：当光标进入托盘图标区域时触发
• 移动：当光标在托盘图标区域周围移动时触发
• 离开：当光标离开托盘图标区域时触发

Note

Linux：不支持。即使图标显示，该事件也不会被触发，并且右键单击时仍然会显示上下文菜单。

JavaScript

import { TrayIcon } from '@tauri-apps/api/tray';

const options = {
  action: (event) => {
    switch (event.type) {
      case 'Click':
        console.log(
          `mouse ${event.button} button pressed, state: ${event.buttonState}`
        );
        break;
      case 'DoubleClick':
        console.log(`mouse ${event.button} button pressed`);
        break;
      case 'Enter':
        console.log(
          `mouse hovered tray at ${event.rect.position.x}, ${event.rect.position.y}`
        );
        break;
      case 'Move':
        console.log(
          `mouse moved on tray at ${event.rect.position.x}, ${event.rect.position.y}`
        );
        break;
      case 'Leave':
        console.log(
          `mouse left tray at ${event.rect.position.x}, ${event.rect.position.y}`
        );
        break;
    }
  },
};

const tray = await TrayIcon.new(options);

有关事件有效载荷的更多信息，请参见 TrayIconEvent。

🌐 See TrayIconEvent for more information on the event payload.

Rust

use tauri::{
    Manager,
    tray::{MouseButton, MouseButtonState, TrayIconBuilder, TrayIconEvent}
};

TrayIconBuilder::new()
  .on_tray_icon_event(|tray, event| match event {
    TrayIconEvent::Click {
      button: MouseButton::Left,
      button_state: MouseButtonState::Up,
      ..
    } => {
      println!("left click pressed and released");
      // in this example, let's show and focus the main window when the tray is clicked
      let app = tray.app_handle();
      if let Some(window) = app.get_webview_window("main") {
        let _ = window.unminimize();
        let _ = window.show();
        let _ = window.set_focus();
      }
    }
    _ => {
      println!("unhandled event {event:?}");
    }
  })

有关事件类型的更多信息，请参见 TrayIconEvent。

🌐 See TrayIconEvent for more information on the event type.

有关创建菜单的详细信息，包括菜单项、子菜单和动态更新，请参阅 窗口菜单 文档。

🌐 For detailed information about creating menus, including menu items, submenus, and dynamic updates, see the Window Menu documentation.