定位器

GitHub npm crates.io

API Reference

将你的窗口放置在众所周知的位置。

🌐 Position your windows at well-known locations.

此插件是 electron-positioner 为 Tauri 的移植版本。

🌐 This plugin is a port of electron-positioner for Tauri.

支持的平台

🌐 Supported Platforms

This plugin requires a Rust version of at least 1.77.2

Platform	Level	Notes
windows
linux
macos
android
ios

设置

🌐 Setup

安装定位器插件即可开始使用。

🌐 Install the positioner plugin to get started.

Note

如果你只打算从 Rust 代码移动窗口，你只需要在 src-tauri/Cargo.toml 中添加依赖，如果你选择自动设置，可以从 lib.rs 中移除插件注册。

Automatic

使用项目的包管理器添加依赖：

npm

npm run tauri add positioner

yarn

yarn run tauri add positioner

pnpm

pnpm tauri add positioner

deno

deno task tauri add positioner

bun

bun tauri add positioner

cargo

cargo tauri add positioner

Manual

1. 在 src-tauri 文件夹中运行以下命令，将插件添加到 Cargo.toml 中的项目依赖：

   cargo add tauri-plugin-positioner --target 'cfg(any(target_os = "macos", windows, target_os = "linux"))'

2. 修改 lib.rs 以初始化插件：

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .setup(|app| {
               #[cfg(desktop)]
               app.handle().plugin(tauri_plugin_positioner::init());
               Ok(())
           })
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. 使用你偏好的 JavaScript 包管理器安装 JavaScript Guest 绑定：

   npm

   npm install @tauri-apps/plugin-positioner

   yarn

   yarn add @tauri-apps/plugin-positioner

   pnpm

   pnpm add @tauri-apps/plugin-positioner

   deno

   deno add npm:@tauri-apps/plugin-positioner

   bun

   bun add @tauri-apps/plugin-positioner

需要进行其他设置才能使托盘相对位置正常工作。

🌐 Additional setup is required to get tray-relative positions to work.

1. 将 tray-icon 功能添加到你的 Cargo.toml 文件中：

   src-tauri/Cargo.toml

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

2. 为定位器插件设置 on_tray_event：

   src-tauri/src/lib.rs

   pub fn run() {
     tauri::Builder::default()
       // This is required to get tray-relative positions to work
       .setup(|app| {
           #[cfg(desktop)]
           {
             app.handle().plugin(tauri_plugin_positioner::init());
               tauri::tray::TrayIconBuilder::new()
                 .on_tray_icon_event(|tray_handle, event| {
                   tauri_plugin_positioner::on_tray_event(tray_handle.app_handle(), &event);
                 })
                 .build(app)?;
           }
         Ok(())
       })
       .run(tauri::generate_context!())
       .expect("error while running tauri application");
   }

使用

🌐 Usage

插件的 API 可通过 JavaScript 来宾绑定获得：

🌐 The plugin’s APIs are available through the JavaScript guest bindings:

import { moveWindow, Position } from '@tauri-apps/plugin-positioner';
// when using `"withGlobalTauri": true`, you may use
// const { moveWindow, Position } = window.__TAURI__.positioner;

moveWindow(Position.TopRight);

你可以直接通过 Rust 导入和使用 Window trait 扩展：

🌐 You can import and use the Window trait extension directly through Rust:

use tauri_plugin_positioner::{WindowExt, Position};

let mut win = app.get_webview_window("main").unwrap();
let _ = win.as_ref().window().move_window(Position::TopRight);

权限

🌐 Permissions

默认情况下，所有潜在危险的插件命令和作用域都会被阻止，无法访问。你必须在 capabilities 配置中修改权限以启用这些功能。

🌐 By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your capabilities configuration to enable these.

有关更多信息，请参见功能概览，有关使用插件权限的分步指南，请参见分步指南。

🌐 See the Capabilities Overview for more information and the step by step guide to use plugin permissions.

src-tauri/capabilities/default.json

{
  "permissions": [
    ...,
    "positioner:default",
  ]
}

Default Permission

Allows the moveWindow and handleIconState APIs

This default permission set includes the following:

• allow-move-window
• allow-move-window-constrained
• allow-set-tray-icon-state

Permission Table

Identifier	Description
positioner:allow-move-window	Enables the move_window command without any pre-configured scope.
positioner:deny-move-window	Denies the move_window command without any pre-configured scope.
positioner:allow-move-window-constrained	Enables the move_window_constrained command without any pre-configured scope.
positioner:deny-move-window-constrained	Denies the move_window_constrained command without any pre-configured scope.
positioner:allow-set-tray-icon-state	Enables the set_tray_icon_state command without any pre-configured scope.
positioner:deny-set-tray-icon-state	Denies the set_tray_icon_state command without any pre-configured scope.