feat(examples): add splashscreen example (#1685)

Cargo.toml

@@ -12,6 +12,7 @@ members = [
   "examples/helloworld/src-tauri",
   "examples/multiwindow/src-tauri",
   "examples/commands/src-tauri",
+  "examples/splashscreen/src-tauri/",
   # used to build updater artifacts
   "examples/updater/src-tauri",
 ]

core/tauri/Cargo.toml

@@ -24,7 +24,7 @@ thiserror = "1.0.24"
 once_cell = "1.7.2"
 tauri-macros = { version = "1.0.0-beta-rc.1", path = "../tauri-macros" }
 tauri-utils = { version = "1.0.0-beta-rc.1", path = "../tauri-utils" }
-wry = "0.9"
+wry = { git = "https://github.com/tauri-apps/wry", rev = "483bad0fc7e7564500f7183547c15604fa387258" }
 rand = "0.8"
 reqwest = { version = "0.11", features = [ "json", "multipart" ] }
 tempfile = "3"

core/tauri/src/runtime/flavors/wry.rs

@@ -607,7 +607,7 @@ impl Runtime for Wry {
                   window.set_window_icon(Some(icon));
                 }
                 WindowMessage::DragWindow => {
-                  window.drag_window();
+                  let _ = window.drag_window();
                 }
               }
             }

examples/api/src-tauri/build.rs

@@ -2,6 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
+use tauri_build::{try_build, Attributes, WindowsAttributes};
+
 fn main() {
-  tauri_build::build()
+  if let Err(error) = try_build(
+    Attributes::new()
+      .windows_attributes(WindowsAttributes::new().window_icon_path("../../.icons/icon.ico")),
+  ) {
+    panic!("error found during tauri-build: {}", error);
+  }
 }

examples/api/src-tauri/tauri.conf.json

@@ -54,11 +54,11 @@
       "active": true,
       "identifier": "com.tauri.api",
       "icon": [
-        "icons/32x32.png",
-        "icons/128x128.png",
-        "icons/128x128@2x.png",
-        "icons/icon.icns",
-        "icons/icon.ico"
+        "../../.icons/32x32.png",
+        "../../.icons/128x128.png",
+        "../../.icons/128x128@2x.png",
+        "../../.icons/icon.icns",
+        "../../.icons/icon.ico"
       ]
     },
     "updater": {

examples/commands/src-tauri/Cargo.toml

@@ -5,12 +5,12 @@ description = "A simple Tauri Application showcasing the commands API"
 edition = "2018"
 
 [build-dependencies]
-tauri-build = { path = "../../../core/tauri-build", features = [ "codegen" ]}
+tauri-build = { path = "../../../core/tauri-build", features = [ "codegen" ] }
 
 [dependencies]
 serde_json = "1.0"
 serde = { version = "1.0", features = [ "derive" ] }
-tauri = { path = "../../../core/tauri", features =["api-all"]}
+tauri = { path = "../../../core/tauri", features = ["api-all"] }
 
 [features]
 default = [ "custom-protocol" ]

examples/commands/src-tauri/build.rs

@@ -2,6 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
+use tauri_build::{try_build, Attributes, WindowsAttributes};
+
 fn main() {
-  tauri_build::build();
+  if let Err(error) = try_build(
+    Attributes::new()
+      .windows_attributes(WindowsAttributes::new().window_icon_path("../../.icons/icon.ico")),
+  ) {
+    panic!("error found during tauri-build: {}", error);
+  }
 }

examples/commands/src-tauri/tauri.conf.json

@@ -11,11 +11,11 @@
       "targets": "all",
       "identifier": "com.tauri.dev",
       "icon": [
-        "icons/32x32.png",
-        "icons/128x128.png",
-        "icons/128x128@2x.png",
-        "icons/icon.icns",
-        "icons/icon.ico"
+        "../../.icons/32x32.png",
+        "../../.icons/128x128.png",
+        "../../.icons/128x128@2x.png",
+        "../../.icons/icon.icns",
+        "../../.icons/icon.ico"
       ],
       "resources": [],
       "externalBin": [],

examples/helloworld/src-tauri/build.rs

@@ -2,6 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
+use tauri_build::{try_build, Attributes, WindowsAttributes};
+
 fn main() {
-  tauri_build::build();
+  if let Err(error) = try_build(
+    Attributes::new()
+      .windows_attributes(WindowsAttributes::new().window_icon_path("../../.icons/icon.ico")),
+  ) {
+    panic!("error found during tauri-build: {}", error);
+  }
 }

examples/helloworld/src-tauri/tauri.conf.json

@@ -11,11 +11,11 @@
       "targets": "all",
       "identifier": "com.tauri.dev",
       "icon": [
-        "icons/32x32.png",
-        "icons/128x128.png",
-        "icons/128x128@2x.png",
-        "icons/icon.icns",
-        "icons/icon.ico"
+        "../../.icons/32x32.png",
+        "../../.icons/128x128.png",
+        "../../.icons/128x128@2x.png",
+        "../../.icons/icon.icns",
+        "../../.icons/icon.ico"
       ],
       "resources": [],
       "externalBin": [],

examples/multiwindow/src-tauri/build.rs

@@ -2,6 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
+use tauri_build::{try_build, Attributes, WindowsAttributes};
+
 fn main() {
-  tauri_build::build();
+  if let Err(error) = try_build(
+    Attributes::new()
+      .windows_attributes(WindowsAttributes::new().window_icon_path("../../.icons/icon.ico")),
+  ) {
+    panic!("error found during tauri-build: {}", error);
+  }
 }

examples/multiwindow/src-tauri/tauri.conf.json

@@ -10,11 +10,11 @@
       "targets": "all",
       "identifier": "com.tauri.dev",
       "icon": [
-        "icons/32x32.png",
-        "icons/128x128.png",
-        "icons/128x128@2x.png",
-        "icons/icon.icns",
-        "icons/icon.ico"
+        "../../.icons/32x32.png",
+        "../../.icons/128x128.png",
+        "../../.icons/128x128@2x.png",
+        "../../.icons/icon.icns",
+        "../../.icons/icon.ico"
       ],
       "resources": [],
       "externalBin": [],

examples/splashscreen/README.md

@@ -0,0 +1,14 @@
+# Splashscreen example
+
+This example demonstrates how a splashscreen can be implemented when waiting on an initialization code on Rust or on the UI.
+
+## Running the example
+
+Run the following scripts on the root directory of the repository:
+
+```bash
+# runs the example that wait on a Rust initialization script to show the main window
+$ cargo run --bin splashscreen
+# runs the example that wait on the UI to load to show the main window
+$ cargo run --bin splashscreen --features ui
+```

examples/splashscreen/dist/index.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+
+<body>
+  <h1>This is the main window!</h1>
+  <script>
+    document.addEventListener('DOMContentLoaded', () => {
+      // we delay here just so we can see the splashscreen for a while
+      setTimeout(() => {
+        window.__TAURI__.invoke('close_splashscreen')
+      }, 2000)
+    })
+  </script>
+</body>
+
+</html>

examples/splashscreen/dist/splashscreen.html

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <title>Splashscreen</title>
+  <style>
+    body {
+      margin: 0;
+    }
+
+    .splashscreen-image {
+      background-color: #444;
+      background-image: url('icon.png');
+      background-position: center;
+      background-repeat: no-repeat;
+      background-size: 50%;
+      width: 100vw !important;
+      height: 100vh !important;
+      overflow: hidden;
+    }
+  </style>
+</head>
+
+<body>
+  <div class="splashscreen-image" />
+</body>
+
+</html>

examples/splashscreen/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "splashscreen-example",
+  "version": "1.0.0",
+  "description": "A Tauri example showcasing Tauri's multiwindow ability with a splashscreen",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "tauri": "node ../../tooling/cli.js/bin/tauri"
+  },
+  "private": true
+}

examples/splashscreen/src-tauri/.gitignore

@@ -0,0 +1,10 @@
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+WixTools
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+config.json
+bundle.json

examples/splashscreen/src-tauri/.license_template

@@ -0,0 +1 @@
+../../../.license_template

examples/splashscreen/src-tauri/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "splashscreen"
+version = "0.1.0"
+description = "An example Tauri Application with a splashscreen"
+edition = "2018"
+license = "Apache-2.0 OR MIT"
+
+[build-dependencies]
+tauri-build = { path = "../../../core/tauri-build" }
+
+[dependencies]
+tauri = { path = "../../../core/tauri", features = ["api-all"] }
+
+[features]
+default = [ "custom-protocol" ]
+custom-protocol = [ "tauri/custom-protocol" ]
+ui = []

examples/splashscreen/src-tauri/build.rs

@@ -0,0 +1,14 @@
+// Copyright 2019-2021 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+use tauri_build::{try_build, Attributes, WindowsAttributes};
+
+fn main() {
+  if let Err(error) = try_build(
+    Attributes::new()
+      .windows_attributes(WindowsAttributes::new().window_icon_path("../../.icons/icon.ico")),
+  ) {
+    panic!("error found during tauri-build: {}", error);
+  }
+}

examples/splashscreen/src-tauri/src/main.rs

@@ -0,0 +1,88 @@
+// Copyright 2019-2021 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"
+)]
+
+// Application code for a splashscreen system that waits on a Rust initialization script
+#[cfg(not(feature = "ui"))]
+mod rust {
+  use std::{thread::sleep, time::Duration};
+  use tauri::Manager;
+
+  // this command is here just so the example doesn't throw an error
+  #[tauri::command]
+  fn close_splashscreen() {}
+
+  pub fn main() {
+    tauri::Builder::default()
+      .setup(|app| {
+        let splashscreen_window = app.get_window("splashscreen").unwrap();
+        let main_window = app.get_window("main").unwrap();
+        // we perform the initialization code on a new task so the app doesn't freeze
+        tauri::async_runtime::spawn(async move {
+          println!("Initializing...");
+          sleep(Duration::from_secs(2));
+          println!("Done initializing.");
+
+          // After it's done, close the splashscreen and display the main window
+          splashscreen_window.close().unwrap();
+          main_window.show().unwrap();
+        });
+        Ok(())
+      })
+      .invoke_handler(tauri::generate_handler![close_splashscreen])
+      .run(tauri::generate_context!())
+      .expect("failed to run app");
+  }
+}
+
+// Application code for a splashscreen system that waits for the UI
+#[cfg(feature = "ui")]
+mod ui {
+  use std::sync::{Arc, Mutex};
+  use tauri::{Manager, Params, State, Window};
+
+  // wrappers around each Window
+  // we use a dedicated type because Tauri can only manage a single instance of a given type
+  struct SplashscreenWindow<P: Params>(Arc<Mutex<Window<P>>>);
+  struct MainWindow<P: Params>(Arc<Mutex<Window<P>>>);
+
+  #[tauri::command]
+  fn close_splashscreen<P: Params>(
+    splashscreen: State<'_, SplashscreenWindow<P>>,
+    main: State<'_, MainWindow<P>>,
+  ) {
+    // Close splashscreen
+    splashscreen.0.lock().unwrap().close().unwrap();
+    // Show main window
+    main.0.lock().unwrap().show().unwrap();
+  }
+
+  pub fn main() {
+    tauri::Builder::default()
+      .setup(|app| {
+        // set the splashscreen and main windows to be globally available with the tauri state API
+        app.manage(SplashscreenWindow(Arc::new(Mutex::new(
+          app.get_window("splashscreen").unwrap(),
+        ))));
+        app.manage(MainWindow(Arc::new(Mutex::new(
+          app.get_window("main").unwrap(),
+        ))));
+        Ok(())
+      })
+      .invoke_handler(tauri::generate_handler![close_splashscreen])
+      .run(tauri::generate_context!())
+      .expect("error while running tauri application");
+  }
+}
+
+fn main() {
+  #[cfg(feature = "ui")]
+  ui::main();
+  #[cfg(not(feature = "ui"))]
+  rust::main();
+}

examples/splashscreen/src-tauri/tauri.conf.json

@@ -0,0 +1,51 @@
+{
+  "build": {
+    "distDir": "../dist",
+    "devPath": "../dist",
+    "withGlobalTauri": true
+  },
+  "tauri": {
+    "bundle": {
+      "active": true,
+      "targets": "all",
+      "identifier": "com.tauri.dev",
+      "icon": [
+        "../../.icons/32x32.png",
+        "../../.icons/128x128.png",
+        "../../.icons/128x128@2x.png",
+        "../../.icons/icon.icns",
+        "../../.icons/icon.ico"
+      ],
+      "resources": [],
+      "externalBin": [],
+      "copyright": "",
+      "category": "DeveloperTool"
+    },
+    "allowlist": {
+      "all": true
+    },
+    "windows": [
+      {
+        "label": "main",
+        "title": "Tauri",
+        "width": 800,
+        "height": 600,
+        "visible": false
+      },
+      {
+        "label": "splashscreen",
+        "width": 400,
+        "height": 200,
+        "decorations": false,
+        "resizable": false,
+        "url": "splashscreen.html"
+      }
+    ],
+    "security": {
+      "csp": "default-src blob: data: filesystem: ws: http: https: 'unsafe-eval' 'unsafe-inline'"
+    },
+    "updater": {
+      "active": false
+    }
+  }
+}

examples/splashscreen/yarn.lock

@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+

examples/updater/src-tauri/build.rs

@@ -2,6 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
 
+use tauri_build::{try_build, Attributes, WindowsAttributes};
+
 fn main() {
-  tauri_build::build();
+  if let Err(error) = try_build(
+    Attributes::new()
+      .windows_attributes(WindowsAttributes::new().window_icon_path("../../.icons/icon.ico")),
+  ) {
+    panic!("error found during tauri-build: {}", error);
+  }
 }