snapshot of https://github.com/tauri-apps/tauri.git (dev, 2026-09-23; blobs > 131072B omitted)

examples/file-associations/README.md

@@ -0,0 +1,19 @@
+# File Associations Example
+
+This example demonstrates how to make associations between the application and certain file types.
+
+This feature is commonly used for functionality such as previewing or editing files.
+
+## Running the example
+
+1. Run the following inside `examples/file-associations/src-tauri`
+
+   ```
+   cargo build --features tauri/protocol-asset
+   ```
+
+## Associations
+
+This example creates associations with PNG, JPG, JPEG and GIF files.
+
+Additionally, it defines two new extensions - `taurid` (derives from a raw data file) and `taurijson` (derives from JSON). They have special treatment on macOS (see `exportedType` in `src-tauri/tauri.conf.json`).

examples/file-associations/index.html

@@ -0,0 +1,19 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>File Associations</title>
+  </head>
+
+  <body>
+    <h1>File Associations</h1>
+    <pre id="files"></pre>
+
+    <script>
+      const filesView = document.getElementById('files')
+      filesView.textContent = window.openedFiles.join('\n')
+    </script>
+  </body>
+</html>

examples/file-associations/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "file-associations",
+  "version": "1.0.0",
+  "pkg": {
+    "assets": [
+      "src/**/*"
+    ]
+  },
+  "scripts": {
+    "tauri": "node ../../packages/cli/tauri.js"
+  },
+  "devDependencies": {}
+}

examples/file-associations/src-tauri/.license_template

@@ -0,0 +1,3 @@
+// Copyright {20\d{2}(-20\d{2})?} Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT

examples/file-associations/src-tauri/Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "tauri-file-associations-demo"
+version = "0.1.0"
+description = "A Tauri application that associate file types"
+edition = "2024"
+rust-version = "1.90"
+
+[build-dependencies]
+tauri-build = { workspace = true, default-features = true, features = [
+  "codegen",
+] }
+
+[dependencies]
+serde_json = "1"
+serde = { version = "1", features = ["derive"] }
+tauri = { workspace = true, default-features = true, features = [
+  "protocol-asset",
+] }
+url = "2"

examples/file-associations/src-tauri/Info.plist

@@ -0,0 +1,21 @@
+<!-- Add this file next to your tauri.conf.json file -->
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+    <dict>
+        <key>CFBundleURLTypes</key>
+        <array>
+            <dict>
+                <key>CFBundleURLName</key>
+                <!-- Obviously needs to be replaced with your app's bundle identifier -->
+                <string>com.tauri.dev-file-associations-demo</string>
+                <key>CFBundleURLSchemes</key>
+                <array>
+                    <!-- register the myapp:// and myscheme:// schemes -->
+                    <string>myapp</string>
+                    <string>myscheme</string>
+                </array>
+            </dict>
+        </array>
+    </dict>
+</plist>

examples/file-associations/src-tauri/build.rs

@@ -0,0 +1,7 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+fn main() {
+  tauri_build::build()
+}

examples/file-associations/src-tauri/src/main.rs

@@ -0,0 +1,97 @@
+// Copyright 2019-2024 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+#![cfg_attr(
+  all(not(debug_assertions), target_os = "windows"),
+  windows_subsystem = "windows"
+)]
+
+use std::path::PathBuf;
+use tauri::{AppHandle, Manager};
+
+fn handle_file_associations(app: AppHandle, files: Vec<PathBuf>) {
+  // -- Scope handling start --
+
+  // You can remove this block if you only want to know about the paths, but not actually "use" them in the frontend.
+
+  // This requires the `fs` tauri plugin and is required to make the plugin's frontend work:
+  // use tauri_plugin_fs::FsExt;
+  // let fs_scope = app.fs_scope();
+
+  // This is for the `asset:` protocol to work:
+  let asset_protocol_scope = app.asset_protocol_scope();
+
+  for file in &files {
+    // This requires the `fs` plugin:
+    // let _ = fs_scope.allow_file(file);
+
+    // This is for the `asset:` protocol:
+    let _ = asset_protocol_scope.allow_file(file);
+  }
+
+  // -- Scope handling end --
+
+  let files = files
+    .into_iter()
+    .map(|f| {
+      let file = f.to_string_lossy().replace('\\', "\\\\"); // escape backslash
+      format!("\"{file}\"",) // wrap in quotes for JS array
+    })
+    .collect::<Vec<_>>()
+    .join(",");
+
+  tauri::WebviewWindowBuilder::new(&app, "main", Default::default())
+    .initialization_script(format!("window.openedFiles = [{files}]"))
+    .build()
+    .unwrap();
+}
+
+fn main() {
+  tauri::Builder::default()
+    .setup(|#[allow(unused_variables)] app| {
+      #[cfg(any(windows, target_os = "linux"))]
+      {
+        let mut files = Vec::new();
+
+        // NOTICE: `args` may include URL protocol (`your-app-protocol://`)
+        // or arguments (`--`) if your app supports them.
+        // files may also be passed as `file://path/to/file`
+        for maybe_file in std::env::args().skip(1) {
+          // skip flags like -f or --flag
+          if maybe_file.starts_with('-') {
+            continue;
+          }
+
+          // handle `file://` path urls and skip other urls
+          if let Ok(url) = url::Url::parse(&maybe_file) {
+            if let Ok(path) = url.to_file_path() {
+              files.push(path);
+            }
+          } else {
+            files.push(PathBuf::from(maybe_file))
+          }
+        }
+
+        handle_file_associations(app.handle().clone(), files);
+      }
+
+      Ok(())
+    })
+    .build(tauri::generate_context!())
+    .expect("error while running tauri application")
+    .run(
+      #[allow(unused_variables)]
+      |app, event| {
+        #[cfg(any(target_os = "macos", target_os = "ios", target_os = "android"))]
+        if let tauri::RunEvent::Opened { urls } = event {
+          let files = urls
+            .into_iter()
+            .filter_map(|url| url.to_file_path().ok())
+            .collect::<Vec<_>>();
+
+          handle_file_associations(app.clone(), files);
+        }
+      },
+    );
+}

examples/file-associations/src-tauri/tauri.conf.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "../../../crates/tauri-cli/config.schema.json",
+  "identifier": "com.tauri.dev-file-associations-demo",
+  "build": {
+    "frontendDist": ["../index.html"]
+  },
+  "app": {
+    "security": {
+      "csp": "default-src 'self'",
+      "assetProtocol": {
+        "enable": true
+      }
+    }
+  },
+  "bundle": {
+    "active": true,
+    "targets": "all",
+    "icon": [
+      "../../.icons/32x32.png",
+      "../../.icons/128x128.png",
+      "../../.icons/128x128@2x.png",
+      "../../.icons/icon.icns",
+      "../../.icons/icon.ico"
+    ],
+    "fileAssociations": [
+      {
+        "ext": ["png"],
+        "mimeType": "image/png",
+        "rank": "Default"
+      },
+      {
+        "ext": ["jpg", "jpeg"],
+        "mimeType": "image/jpeg",
+        "rank": "Alternate"
+      },
+      {
+        "ext": ["gif"],
+        "mimeType": "image/gif",
+        "rank": "Owner"
+      },
+      {
+        "ext": ["taurijson"],
+        "exportedType": {
+          "identifier": "com.tauri.dev-file-associations-demo.taurijson",
+          "conformsTo": ["public.json"]
+        }
+      },
+      {
+        "ext": ["taurid"],
+        "exportedType": {
+          "identifier": "com.tauri.dev-file-associations-demo.tauridata",
+          "conformsTo": ["public.data"]
+        }
+      }
+    ]
+  }
+}