Opener

GitHubnpmcrates.io

Referencia de API

Este plugin te permite abrir archivos y URLs en una aplicación especificada, o la predeterminada. También admite "revelar" archivos en el explorador de archivos del sistema.

Plataformas Soportadas

Este plugin requiere una versión de Rust de al menos 1.77.2

Plataforma	Nivel	Notas
windows
linux
macos
android		Solo permite abrir URLs a través de open
ios		Solo permite abrir URLs a través de open

Configuración

Instala el plugin opener para comenzar.

Automático

Usa el gestor de paquetes de tu proyecto para agregar la dependencia:

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

Manual

1. Ejecuta el siguiente comando en la carpeta src-tauri para agregar el plugin a las dependencias del proyecto en Cargo.toml:

   cargo add tauri-plugin-opener

2. Modifica lib.rs para inicializar el plugin:

   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. Instala los bindings de JavaScript utilizando tu gestor de paquetes de JavaScript preferido:

   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

Uso

El plugin opener está disponible tanto en JavaScript como en Rust.

JavaScript

import { openPath, openUrl } 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');
// opens a URL using the default program:
await openUrl('https://tauri.app');

Rust

Ten en cuenta que app es una instancia de App o 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"));
// opens a URL using the default program:
app.opener().open_url("https://tauri.app", None::<&str>);

Permisos

De forma predeterminada, todos los comandos y alcances (scopes) potencialmente peligrosos del plugin están bloqueados y no se puede acceder a ellos. Debes modificar los permisos en tu configuración de capabilities para habilitarlos.

Consulta la Visión General de Capacidades para obtener más información y la guía paso a paso para usar permisos de plugins.

A continuación se muestran dos ejemplos de configuración de scope. Tanto path como url usan la sintaxis de patrones glob para definir las rutas de archivos y URLs permitidas.

Primero, un ejemplo sobre cómo añadir permisos a rutas específicas para la función openPath():

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"
        },
        {
          "path": "$APPDATA/file"
        }
      ]
    }
  ]
}

Por último, un ejemplo sobre cómo añadir permisos para la URL exacta https://tauri.app y todas las URLs en un protocolo personalizado (debe ser conocido por el SO) para la función openUrl():

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-url",
      "allow": [
        {
          "url": "https://tauri.app"
        },
        {
          "url": "custom:*"
        }
      ]
    }
  ]
}

Permiso Predeterminado

Este conjunto de permisos permite abrir URLs mailto:, tel:, https:// y http:// usando su aplicación por defecto, así como revelar archivos en directorios usando el explorador de archivos por defecto

Este conjunto de permisos predeterminado incluye lo siguiente:

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

Tabla de Permisos

Identificador	Descripción
opener:allow-default-urls	Esto permite abrir URLs mailto:, tel:, https:// y http:// usando su aplicación por defecto.
opener:allow-open-path	Habilita el comando open_path sin ningún scope preconfigurado.
opener:deny-open-path	Deniega el comando open_path sin ningún scope preconfigurado.
opener:allow-open-url	Habilita el comando open_url sin ningún scope preconfigurado.
opener:deny-open-url	Deniega el comando open_url sin ningún scope preconfigurado.
opener:allow-reveal-item-in-dir	Habilita el comando reveal_item_in_dir sin ningún scope preconfigurado.
opener:deny-reveal-item-in-dir	Deniega el comando reveal_item_in_dir sin ningún scope preconfigurado.