自動啟動

GitHub npm crates.io

API 參考

在系統啟動時自動啟動您的應用程式。

支援平台

此外掛程式需要至少 1.77.2 版本的 Rust

平台	層級	備註
windows
linux
macos
android
ios

設定

安裝 autostart 外掛程式以開始使用。

自動

使用專案的套件管理器新增依賴項

npm

npm run tauri add autostart

yarn

yarn run tauri add autostart

pnpm

pnpm tauri add autostart

deno

deno task tauri add autostart

bun

bun tauri add autostart

cargo

cargo tauri add autostart

手動

1. 在 src-tauri 資料夾中執行以下命令，將此外掛程式新增至 Cargo.toml 專案的依賴項中

   cargo add tauri-plugin-autostart --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_autostart::init(tauri_plugin_autostart::MacosLauncher::LaunchAgent, Some(vec!["--flag1", "--flag2"]) /* arbitrary number of args to pass to your app */));
               Ok(())
           })
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. 您可以使用偏好的 JavaScript 套件管理器安裝 JavaScript Guest 綁定

   npm

   npm install @tauri-apps/plugin-autostart

   yarn

   yarn add @tauri-apps/plugin-autostart

   pnpm

   pnpm add @tauri-apps/plugin-autostart

   deno

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

   bun

   bun add @tauri-apps/plugin-autostart

用法

autostart 外掛程式同時提供 JavaScript 和 Rust 版本。

JavaScript

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

// Enable autostart
await enable();
// Check enable state
console.log(`registered for autostart? ${await isEnabled()}`);
// Disable autostart
disable();

Rust

#[cfg_attr(mobile, tauri::mobile_entry_point)]
pub fn run() {
    tauri::Builder::default()
        .setup(|app| {
            #[cfg(desktop)]
            {
                use tauri_plugin_autostart::MacosLauncher;
                use tauri_plugin_autostart::ManagerExt;

                app.handle().plugin(tauri_plugin_autostart::init(
                    MacosLauncher::LaunchAgent,
                    Some(vec!["--flag1", "--flag2"]),
                ));

                // Get the autostart manager
                let autostart_manager = app.autolaunch();
                // Enable autostart
                let _ = autostart_manager.enable();
                // Check enable state
                println!("registered for autostart? {}", autostart_manager.is_enabled().unwrap());
                // Disable autostart
                let _ = autostart_manager.disable();
            }
            Ok(())
        })
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

權限

預設情況下，所有潛在危險的外掛程式命令和作用域都被封鎖且無法存取。您必須修改 capabilities 設定中的權限才能啟用這些。

請參閱能力總覽以取得更多資訊，以及逐步指南以了解如何使用外掛程式權限。

src-tauri/capabilities/default.json

{
  "permissions": [
    ...,
    "autostart:allow-enable",
    "autostart:allow-disable",
    "autostart:allow-is-enabled"
  ]
}

預設權限

此權限設定配置您的應用程式是否可以啟用或停用在啟動時自動啟動應用程式。

授權權限

它允許所有人檢查、啟用和停用在啟動時自動啟動。

• allow-enable
• allow-disable
• allow-is-enabled

權限表

識別符	描述
autostart:allow-disable	啟用停用命令，無需任何預先配置的作用域。
autostart:deny-disable	拒絕停用命令，無需任何預先配置的作用域。
autostart:allow-enable	啟用啟用命令，無需任何預先配置的作用域。
autostart:deny-enable	拒絕啟用命令，無需任何預先配置的作用域。
autostart:allow-is-enabled	啟用 is_enabled 命令，無需任何預先配置的作用域。
autostart:deny-is-enabled	拒絕 is_enabled 命令，無需任何預先配置的作用域。