Merge pull request #1 from jojobyte/feature/emit-event-example

feat: Add example with an `emit_all` event
3 years ago · 1e244bc73c
parent b0052d2da4 e825e10165
commit 1e244bc73c
18 changed files with 4577 additions and 0 deletions
--- a/examples/emit-event/.gitignore
+++ b/examples/emit-event/.gitignore
@ -0,0 +1 @@
+node_modules/
--- a/examples/emit-event/README.md
+++ b/examples/emit-event/README.md
@ -0,0 +1,25 @@
+# Tauri Plugin single-instance
+## Emit Event Example
+
+To build and test in development mode run the following:
+
+```sh
+# change to this example directory
+npm install
+npm run tauri dev
+
+# or if tauri is installed globally
+
+cargo tauri dev
+```
+
+While the above is running, in a separate terminal window execute the debug target app
+
+```sh
+# on linux
+./src-tauri/target/debug/emit-event-app cyan # any css background color should work
+./src-tauri/target/debug/emit-event-app "#888" # including hex
+
+# on windows
+.\src-tauri\target\debug\emit-event-app.exe cyan
+```
--- a/examples/emit-event/package-lock.json
+++ b/examples/emit-event/package-lock.json
@ -0,0 +1,269 @@
+{
+  "name": "emit-event",
+  "version": "0.0.1",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "emit-event",
+      "version": "0.0.1",
+      "license": "MIT",
+      "devDependencies": {
+        "@tauri-apps/cli": "1.0.0"
+      }
+    },
+    "node_modules/@tauri-apps/cli": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli/-/cli-1.0.0.tgz",
+      "integrity": "sha512-4eHnk3p0xnCXd9Zel3kLvdiiSURnN98GMFvWUAdirm5AjyOjcx8TIET/jqRYmYKE5yd+LMQqYMUfHRwA6JJUkg==",
+      "dev": true,
+      "bin": {
+        "tauri": "tauri.js"
+      },
+      "engines": {
+        "node": ">= 10"
+      },
+      "funding": {
+        "type": "opencollective",
+        "url": "https://opencollective.com/tauri"
+      },
+      "optionalDependencies": {
+        "@tauri-apps/cli-darwin-arm64": "1.0.0",
+        "@tauri-apps/cli-darwin-x64": "1.0.0",
+        "@tauri-apps/cli-linux-arm-gnueabihf": "1.0.0",
+        "@tauri-apps/cli-linux-arm64-gnu": "1.0.0",
+        "@tauri-apps/cli-linux-arm64-musl": "1.0.0",
+        "@tauri-apps/cli-linux-x64-gnu": "1.0.0",
+        "@tauri-apps/cli-linux-x64-musl": "1.0.0",
+        "@tauri-apps/cli-win32-ia32-msvc": "1.0.0",
+        "@tauri-apps/cli-win32-x64-msvc": "1.0.0"
+      }
+    },
+    "node_modules/@tauri-apps/cli-darwin-arm64": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-darwin-arm64/-/cli-darwin-arm64-1.0.0.tgz",
+      "integrity": "sha512-0ryomgLjdpylXypMPVXLU3PZCde3Sw5nwN4coUhBcHPBLFRb8QPet+nweVK/HiZ3mxg8WeIazvpx2s8hS0l2GQ==",
+      "cpu": [
+        "arm64"
+      ],
+      "dev": true,
+      "optional": true,
+      "os": [
+        "darwin"
+      ],
+      "engines": {
+        "node": ">= 10"
+      }
+    },
+    "node_modules/@tauri-apps/cli-darwin-x64": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-darwin-x64/-/cli-darwin-x64-1.0.0.tgz",
+      "integrity": "sha512-oejvYUT4dEfzBi+FWMj+CMz4cZ6C2gEFHrUtKVLdTXr8Flj5UTwdB1YPGQjiOqk73LOI7cB/vXxb9DZT+Lrxgg==",
+      "cpu": [
+        "x64"
+      ],
+      "dev": true,
+      "optional": true,
+      "os": [
+        "darwin"
+      ],
+      "engines": {
+        "node": ">= 10"
+      }
+    },
+    "node_modules/@tauri-apps/cli-linux-arm-gnueabihf": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-linux-arm-gnueabihf/-/cli-linux-arm-gnueabihf-1.0.0.tgz",
+      "integrity": "sha512-yAu78v8TeXNx/ETS5F2G2Uw/HX+LQvZkX94zNiqFsAj7snfWI/IqSUM52OBrdh/D0EC9NCdjUJ7Vuo32uxf7tg==",
+      "cpu": [
+        "arm"
+      ],
+      "dev": true,
+      "optional": true,
+      "os": [
+        "linux"
+      ],
+      "engines": {
+        "node": ">= 10"
+      }
+    },
+    "node_modules/@tauri-apps/cli-linux-arm64-gnu": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-linux-arm64-gnu/-/cli-linux-arm64-gnu-1.0.0.tgz",
+      "integrity": "sha512-YFUN/S58AN317njAynzcQ+EHhRsCDXqmp5g9Oiqmcdg1vU7fPWZivVLc1WHz+0037C7JnsX5PtKpNYewP/+Oqw==",
+      "cpu": [
+        "arm64"
+      ],
+      "dev": true,
+      "optional": true,
+      "os": [
+        "linux"
+      ],
+      "engines": {
+        "node": ">= 10"
+      }
+    },
+    "node_modules/@tauri-apps/cli-linux-arm64-musl": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-linux-arm64-musl/-/cli-linux-arm64-musl-1.0.0.tgz",
+      "integrity": "sha512-al+TxMGoNVikEvRQfMyYE/mdjUcUNMo5brkCIAb+fL4rWQlAhAnYVzmg/rM8N4nhdXm1MOaYAagQmxr8898dNA==",
+      "cpu": [
+        "arm64"
+      ],
+      "dev": true,
+      "optional": true,
+      "os": [
+        "linux"
+      ],
+      "engines": {
+        "node": ">= 10"
+      }
+    },
+    "node_modules/@tauri-apps/cli-linux-x64-gnu": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-linux-x64-gnu/-/cli-linux-x64-gnu-1.0.0.tgz",
+      "integrity": "sha512-KQmYlYyGpn6/2kSl9QivWG6EIepm6PJd57e6IKmYwAyNhLr2XfGl1CLuocUQQgO+jprjT70HXp+MXD0tcB0+Sw==",
+      "cpu": [
+        "x64"
+      ],
+      "dev": true,
+      "optional": true,
+      "os": [
+        "linux"
+      ],
+      "engines": {
+        "node": ">= 10"
+      }
+    },
+    "node_modules/@tauri-apps/cli-linux-x64-musl": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-linux-x64-musl/-/cli-linux-x64-musl-1.0.0.tgz",
+      "integrity": "sha512-Qpaq5lZz569Aea6jfrRchgfEJaOrfLpCRBATcF8CJFFwVKmfCUcoV+MxbCIW30Zqw5Y06njC/ffa3261AV/ZIQ==",
+      "cpu": [
+        "x64"
+      ],
+      "dev": true,
+      "optional": true,
+      "os": [
+        "linux"
+      ],
+      "engines": {
+        "node": ">= 10"
+      }
+    },
+    "node_modules/@tauri-apps/cli-win32-ia32-msvc": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-win32-ia32-msvc/-/cli-win32-ia32-msvc-1.0.0.tgz",
+      "integrity": "sha512-e2DzFqEMI+s+gv14UupdI91gPxTbUJTbbfQlTHdQlOsTk4HEZTsh+ibAYBcCLAaMRW38NEsFlAUe1lQA0iRu/w==",
+      "cpu": [
+        "ia32"
+      ],
+      "dev": true,
+      "optional": true,
+      "os": [
+        "win32"
+      ],
+      "engines": {
+        "node": ">= 10"
+      }
+    },
+    "node_modules/@tauri-apps/cli-win32-x64-msvc": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-win32-x64-msvc/-/cli-win32-x64-msvc-1.0.0.tgz",
+      "integrity": "sha512-lWSs90pJeQX+L31IqIzmRhwLayEeyTh7mga0AxX8G868hvdLtcXCQA/rKoFtGdVLuHAx4+M+CBF5SMYb76xGYA==",
+      "cpu": [
+        "x64"
+      ],
+      "dev": true,
+      "optional": true,
+      "os": [
+        "win32"
+      ],
+      "engines": {
+        "node": ">= 10"
+      }
+    }
+  },
+  "dependencies": {
+    "@tauri-apps/cli": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli/-/cli-1.0.0.tgz",
+      "integrity": "sha512-4eHnk3p0xnCXd9Zel3kLvdiiSURnN98GMFvWUAdirm5AjyOjcx8TIET/jqRYmYKE5yd+LMQqYMUfHRwA6JJUkg==",
+      "dev": true,
+      "requires": {
+        "@tauri-apps/cli-darwin-arm64": "1.0.0",
+        "@tauri-apps/cli-darwin-x64": "1.0.0",
+        "@tauri-apps/cli-linux-arm-gnueabihf": "1.0.0",
+        "@tauri-apps/cli-linux-arm64-gnu": "1.0.0",
+        "@tauri-apps/cli-linux-arm64-musl": "1.0.0",
+        "@tauri-apps/cli-linux-x64-gnu": "1.0.0",
+        "@tauri-apps/cli-linux-x64-musl": "1.0.0",
+        "@tauri-apps/cli-win32-ia32-msvc": "1.0.0",
+        "@tauri-apps/cli-win32-x64-msvc": "1.0.0"
+      }
+    },
+    "@tauri-apps/cli-darwin-arm64": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-darwin-arm64/-/cli-darwin-arm64-1.0.0.tgz",
+      "integrity": "sha512-0ryomgLjdpylXypMPVXLU3PZCde3Sw5nwN4coUhBcHPBLFRb8QPet+nweVK/HiZ3mxg8WeIazvpx2s8hS0l2GQ==",
+      "dev": true,
+      "optional": true
+    },
+    "@tauri-apps/cli-darwin-x64": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-darwin-x64/-/cli-darwin-x64-1.0.0.tgz",
+      "integrity": "sha512-oejvYUT4dEfzBi+FWMj+CMz4cZ6C2gEFHrUtKVLdTXr8Flj5UTwdB1YPGQjiOqk73LOI7cB/vXxb9DZT+Lrxgg==",
+      "dev": true,
+      "optional": true
+    },
+    "@tauri-apps/cli-linux-arm-gnueabihf": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-linux-arm-gnueabihf/-/cli-linux-arm-gnueabihf-1.0.0.tgz",
+      "integrity": "sha512-yAu78v8TeXNx/ETS5F2G2Uw/HX+LQvZkX94zNiqFsAj7snfWI/IqSUM52OBrdh/D0EC9NCdjUJ7Vuo32uxf7tg==",
+      "dev": true,
+      "optional": true
+    },
+    "@tauri-apps/cli-linux-arm64-gnu": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-linux-arm64-gnu/-/cli-linux-arm64-gnu-1.0.0.tgz",
+      "integrity": "sha512-YFUN/S58AN317njAynzcQ+EHhRsCDXqmp5g9Oiqmcdg1vU7fPWZivVLc1WHz+0037C7JnsX5PtKpNYewP/+Oqw==",
+      "dev": true,
+      "optional": true
+    },
+    "@tauri-apps/cli-linux-arm64-musl": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-linux-arm64-musl/-/cli-linux-arm64-musl-1.0.0.tgz",
+      "integrity": "sha512-al+TxMGoNVikEvRQfMyYE/mdjUcUNMo5brkCIAb+fL4rWQlAhAnYVzmg/rM8N4nhdXm1MOaYAagQmxr8898dNA==",
+      "dev": true,
+      "optional": true
+    },
+    "@tauri-apps/cli-linux-x64-gnu": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-linux-x64-gnu/-/cli-linux-x64-gnu-1.0.0.tgz",
+      "integrity": "sha512-KQmYlYyGpn6/2kSl9QivWG6EIepm6PJd57e6IKmYwAyNhLr2XfGl1CLuocUQQgO+jprjT70HXp+MXD0tcB0+Sw==",
+      "dev": true,
+      "optional": true
+    },
+    "@tauri-apps/cli-linux-x64-musl": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-linux-x64-musl/-/cli-linux-x64-musl-1.0.0.tgz",
+      "integrity": "sha512-Qpaq5lZz569Aea6jfrRchgfEJaOrfLpCRBATcF8CJFFwVKmfCUcoV+MxbCIW30Zqw5Y06njC/ffa3261AV/ZIQ==",
+      "dev": true,
+      "optional": true
+    },
+    "@tauri-apps/cli-win32-ia32-msvc": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-win32-ia32-msvc/-/cli-win32-ia32-msvc-1.0.0.tgz",
+      "integrity": "sha512-e2DzFqEMI+s+gv14UupdI91gPxTbUJTbbfQlTHdQlOsTk4HEZTsh+ibAYBcCLAaMRW38NEsFlAUe1lQA0iRu/w==",
+      "dev": true,
+      "optional": true
+    },
+    "@tauri-apps/cli-win32-x64-msvc": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/@tauri-apps/cli-win32-x64-msvc/-/cli-win32-x64-msvc-1.0.0.tgz",
+      "integrity": "sha512-lWSs90pJeQX+L31IqIzmRhwLayEeyTh7mga0AxX8G868hvdLtcXCQA/rKoFtGdVLuHAx4+M+CBF5SMYb76xGYA==",
+      "dev": true,
+      "optional": true
+    }
+  }
+}
--- a/examples/emit-event/package.json
+++ b/examples/emit-event/package.json
@ -0,0 +1,14 @@
+{
+  "name": "emit-event",
+  "version": "0.0.1",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "tauri": "tauri"
+  },
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@tauri-apps/cli": "1.0.0"
+  }
+}
--- a/examples/emit-event/public/index.html
+++ b/examples/emit-event/public/index.html
@ -0,0 +1,35 @@
+<html>
+  <body>
+    <div>Plugin example</div>
+    <pre id="args"></pre>
+    <script type="module">
+      var argsEl = document.getElementById('args')
+
+      function cliProtocolVal({ args: { color: { value }}}) {
+        argsEl.innerHTML = value
+        document.body.style.backgroundColor = value
+      }
+      function cliProtocolErr (err) {
+        argsEl.innerHTML = JSON.stringify(err)
+      }
+
+      window.__TAURI__.cli.getMatches()
+        .then(cliProtocolVal)
+        .catch(cliProtocolErr);
+
+      await window.__TAURI__.event.listen(
+        'single-instance',
+        ({event, ...eventObj}) => {
+          console.log(event, eventObj)
+          let args = eventObj.payload?.args
+
+          if (args?.length > 1) {
+            let color = args[1]
+            argsEl.innerHTML = color
+            document.body.style.backgroundColor = color
+          }
+        }
+      )
+    </script>
+  </body>
+</html>
--- a/examples/emit-event/src-tauri/.gitignore
+++ b/examples/emit-event/src-tauri/.gitignore
@ -0,0 +1,4 @@
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+WixTools
--- a/examples/emit-event/src-tauri/Cargo.lock
+++ b/examples/emit-event/src-tauri/Cargo.lock
--- a/examples/emit-event/src-tauri/Cargo.toml
+++ b/examples/emit-event/src-tauri/Cargo.toml
@ -0,0 +1,21 @@
+[package]
+name = "emit-event-app"
+version = "0.1.0"
+description = "A Tauri App"
+authors = [ "You" ]
+repository = ""
+edition = "2021"
+rust-version = "1.57"
+
+[dependencies]
+serde_json = "1.0"
+serde = { version = "1.0", features = [ "derive" ] }
+tauri = { version = "1.0.0", features = ["api-all", "cli"] }
+tauri-plugin-single-instance = { path = "../../../" }
+
+[build-dependencies]
+tauri-build = { version = "1.0.0", features = [] }
+
+[features]
+default = [ "custom-protocol" ]
+custom-protocol = [ "tauri/custom-protocol" ]
--- a/examples/emit-event/src-tauri/build.rs
+++ b/examples/emit-event/src-tauri/build.rs
@ -0,0 +1,3 @@
+fn main() {
+  tauri_build::build()
+}
--- a/examples/emit-event/src-tauri/icons/128x128.png
+++ b/examples/emit-event/src-tauri/icons/128x128.png
--- a/examples/emit-event/src-tauri/icons/128x128@2x.png
+++ b/examples/emit-event/src-tauri/icons/128x128@2x.png
--- a/examples/emit-event/src-tauri/icons/32x32.png
+++ b/examples/emit-event/src-tauri/icons/32x32.png
--- a/examples/emit-event/src-tauri/icons/icon.icns
+++ b/examples/emit-event/src-tauri/icons/icon.icns
--- a/examples/emit-event/src-tauri/icons/icon.ico
+++ b/examples/emit-event/src-tauri/icons/icon.ico
--- a/examples/emit-event/src-tauri/icons/icon.png
+++ b/examples/emit-event/src-tauri/icons/icon.png
--- a/examples/emit-event/src-tauri/rustfmt.toml
+++ b/examples/emit-event/src-tauri/rustfmt.toml
@ -0,0 +1,14 @@
+max_width = 100
+hard_tabs = false
+tab_spaces = 2
+newline_style = "Auto"
+use_small_heuristics = "Default"
+reorder_imports = true
+reorder_modules = true
+remove_nested_parens = true
+edition = "2021"
+merge_derives = true
+use_try_shorthand = false
+use_field_init_shorthand = false
+force_explicit_abi = true
+imports_granularity = "Crate"
--- a/examples/emit-event/src-tauri/src/main.rs
+++ b/examples/emit-event/src-tauri/src/main.rs
@ -0,0 +1,22 @@
+#![cfg_attr(
+  all(not(debug_assertions), target_os = "windows"),
+  windows_subsystem = "windows"
+)]
+
+use tauri::{Manager};
+
+#[derive(Clone, serde::Serialize)]
+struct Payload {
+  args: Vec<String>,
+  cwd: String,
+}
+
+fn main() {
+  tauri::Builder::default()
+    .plugin(tauri_plugin_single_instance::init(|app, argv, cwd| {
+      println!("{}, {argv:?}, {cwd}", app.package_info().name);
+      app.emit_all("single-instance", Payload { args: argv, cwd }).unwrap();
+    }))
+    .run(tauri::generate_context!())
+    .expect("error while running tauri application");
+}
--- a/examples/emit-event/src-tauri/tauri.conf.json
+++ b/examples/emit-event/src-tauri/tauri.conf.json
@ -0,0 +1,76 @@
+{
+  "package": {
+    "productName": "emitEventApp",
+    "version": "0.1.0"
+  },
+  "build": {
+    "distDir": "../public",
+    "devPath": "../public",
+    "withGlobalTauri": true
+  },
+  "tauri": {
+    "bundle": {
+      "active": true,
+      "targets": "all",
+      "identifier": "com.tauri.single-instance-emit",
+      "icon": [
+        "icons/32x32.png",
+        "icons/128x128.png",
+        "icons/128x128@2x.png",
+        "icons/icon.icns",
+        "icons/icon.ico"
+      ],
+      "resources": [],
+      "externalBin": [],
+      "copyright": "",
+      "category": "DeveloperTool",
+      "shortDescription": "",
+      "longDescription": "",
+      "deb": {
+        "depends": []
+      },
+      "macOS": {
+        "frameworks": [],
+        "exceptionDomain": "",
+        "signingIdentity": null,
+        "entitlements": null
+      },
+      "windows": {
+        "certificateThumbprint": null,
+        "digestAlgorithm": "sha256",
+        "timestampUrl": ""
+      }
+    },
+    "cli": {
+      "description": "Tauri API example",
+      "args": [
+        {
+          "name": "color",
+          "description": "Background Color",
+          "index": 1,
+          "takesValue": true
+        }
+      ],
+      "subcommands": {
+      }
+    },
+    "updater": {
+      "active": false
+    },
+    "allowlist": {
+      "all": true
+    },
+    "windows": [
+      {
+        "title": "Emit Event App",
+        "width": 800,
+        "height": 600,
+        "resizable": true,
+        "fullscreen": false
+      }
+    ],
+    "security": {
+      "csp": "default-src blob: data: filesystem: ws: wss: http: https: tauri: 'unsafe-eval' 'unsafe-inline' 'self' img-src: 'self'"
+    }
+  }
+}