Opener

GitHub npm crates.io

API 参考

此插件允许你在指定的或默认的应用程序中打开文件和 URL。它还支持在系统的文件资源管理器中“显示”文件。

支持的平台

此插件需要至少 1.77.2 版本的 Rust

平台	级别	注释
windows
linux
macos
android		仅允许通过 open 打开 URL
ios		仅允许通过 open 打开 URL

设置

安装 opener 插件以开始使用。

自动

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

npm

npm run tauri add opener

yarn

yarn run tauri add opener

pnpm

pnpm tauri add opener

deno

deno task tauri add opener

bun

bun tauri add opener

cargo

cargo tauri add opener

手动

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

   cargo add tauri-plugin-opener

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

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .plugin(tauri_plugin_opener::init())
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. 使用你首选的 JavaScript 包管理器安装 JavaScript Guest 绑定

   npm

   npm install @tauri-apps/plugin-opener

   yarn

   yarn add @tauri-apps/plugin-opener

   pnpm

   pnpm add @tauri-apps/plugin-opener

   deno

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

   bun

   bun add @tauri-apps/plugin-opener

用法

opener 插件在 JavaScript 和 Rust 中均可用。

JavaScript

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

// opens a file using the default program:
await openPath('/path/to/file');
// opens a file using `vlc` command on Windows:
await openPath('C:/path/to/file', 'vlc');

Rust

请注意，app 是 App 或 AppHandle 的实例。

use tauri_plugin_opener::OpenerExt;

// opens a file using the default program:
app.opener().open_path("/path/to/file", None::<&str>);
// opens a file using `vlc` command on Windows:
app.opener().open_path("C:/path/to/file", Some("vlc"));

权限

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

有关更多信息，请参阅 能力概述，并参阅 使用插件权限的分步指南。

src-tauri/capabilities/default.json

{
  "$schema": "../gen/schemas/desktop-schema.json",
  "identifier": "main-capability",
  "description": "Capability for the main window",
  "windows": ["main"],
  "permissions": [
    {
      "identifier": "opener:allow-open-path",
      "allow": [
        {
          "path": "/path/to/file"
        }
      ]
    }
  ]
}

默认权限

此权限集允许使用默认应用程序打开 mailto:、tel:、https:// 和 http:// URL，以及使用默认文件资源管理器显示目录中的文件

此默认权限集包括以下内容

• allow-open-url
• allow-reveal-item-in-dir
• allow-default-urls

权限表

标识符	描述
opener:allow-default-urls	这允许使用默认应用程序打开 mailto:、tel:、https:// 和 http:// URL。
opener:allow-open-path	启用 open_path 命令，无需任何预配置的作用域。
opener:deny-open-path	拒绝 open_path 命令，无需任何预配置的作用域。
opener:allow-open-url	启用 open_url 命令，无需任何预配置的作用域。
opener:deny-open-url	拒绝 open_url 命令，无需任何预配置的作用域。
opener:allow-reveal-item-in-dir	启用 reveal_item_in_dir 命令，无需任何预配置的作用域。
opener:deny-reveal-item-in-dir	拒绝 reveal_item_in_dir 命令，无需任何预配置的作用域。