diff --git a/examples/api/vite.config.js b/examples/api/vite.config.js index 3b34cccd4b..f7d87db87d 100644 --- a/examples/api/vite.config.js +++ b/examples/api/vite.config.js @@ -26,13 +26,6 @@ export default defineConfig(async () => { host: host || false, port: 5173, strictPort: true, - hmr: host - ? { - protocol: 'ws', - host, - port: 5183 - } - : undefined, fs: { allow: ['.', '../../tooling/api/dist'] } diff --git a/plugins/autostart/README.md b/plugins/autostart/README.md index 5855c98927..93c74271c8 100644 --- a/plugins/autostart/README.md +++ b/plugins/autostart/README.md @@ -1,6 +1,14 @@ ![plugin-autostart](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/autostart/banner.png) -Automatically launch your application at startup. Supports Windows, Mac (via AppleScript or Launch Agent), and Linux. +Automatically launch your application at startup. + +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | x | +| iOS | x | ## Install diff --git a/plugins/barcode-scanner/README.md b/plugins/barcode-scanner/README.md index ee9831301a..aca340bc7d 100644 --- a/plugins/barcode-scanner/README.md +++ b/plugins/barcode-scanner/README.md @@ -2,6 +2,14 @@ Allows your mobile application to use the camera to scan QR codes, EAN-13 and other kinds of barcodes. +| Platform | Supported | +| -------- | --------- | +| Linux | x | +| Windows | x | +| macOS | x | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.64**_ diff --git a/plugins/biometric/README.md b/plugins/biometric/README.md index bc4708c31a..c97b8f9a65 100644 --- a/plugins/biometric/README.md +++ b/plugins/biometric/README.md @@ -2,6 +2,14 @@ Prompt the user for biometric authentication on Android and iOS. +| Platform | Supported | +| -------- | --------- | +| Linux | x | +| Windows | x | +| macOS | x | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.65**_ diff --git a/plugins/cli/README.md b/plugins/cli/README.md index 362597b507..8f0e0e6264 100644 --- a/plugins/cli/README.md +++ b/plugins/cli/README.md @@ -2,7 +2,13 @@ Parse arguments from your Command Line Interface. -- Supported platforms: Windows, Linux and macOS. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | x | +| iOS | x | ## Install diff --git a/plugins/clipboard-manager/README.md b/plugins/clipboard-manager/README.md index 98ee2da0b1..e22df0f6d8 100644 --- a/plugins/clipboard-manager/README.md +++ b/plugins/clipboard-manager/README.md @@ -2,6 +2,14 @@ Read and write to the system clipboard. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/clipboard-manager/guest-js/index.ts b/plugins/clipboard-manager/guest-js/index.ts index d39e2f8158..f7f31842a7 100644 --- a/plugins/clipboard-manager/guest-js/index.ts +++ b/plugins/clipboard-manager/guest-js/index.ts @@ -49,6 +49,11 @@ async function readText(): Promise { /** * Writes image buffer to the clipboard. + * + * #### Platform-specific + * + * - **Android / iOS:** Not supported. + * * @example * ```typescript * import { writeImage } from '@tauri-apps/plugin-clipboard-manager'; @@ -75,6 +80,11 @@ async function writeImage( /** * Gets the clipboard content as Uint8Array image. + * + * #### Platform-specific + * + * - **Android / iOS:** Not supported. + * * @example * ```typescript * import { readImage } from '@tauri-apps/plugin-clipboard-manager'; @@ -93,6 +103,11 @@ async function readImage(): Promise { /** * * Writes HTML or fallbacks to write provided plain text to the clipboard. + * + * #### Platform-specific + * + * - **Android / iOS:** Not supported. + * * @example * ```typescript * import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager'; diff --git a/plugins/deep-link/README.md b/plugins/deep-link/README.md index e761fa68f5..8ecdc8f04d 100644 --- a/plugins/deep-link/README.md +++ b/plugins/deep-link/README.md @@ -2,6 +2,14 @@ Set your Tauri application as the default handler for an URL. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/dialog/README.md b/plugins/dialog/README.md index 29c0a2c034..099e3939b1 100644 --- a/plugins/dialog/README.md +++ b/plugins/dialog/README.md @@ -2,6 +2,14 @@ Native system dialogs for opening and saving files along with message dialogs. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/fs/README.md b/plugins/fs/README.md index 8ced39c46f..187d7622ae 100644 --- a/plugins/fs/README.md +++ b/plugins/fs/README.md @@ -2,6 +2,14 @@ Access the file system. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/geolocation/README.md b/plugins/geolocation/README.md index 57de24dd80..1923727f95 100644 --- a/plugins/geolocation/README.md +++ b/plugins/geolocation/README.md @@ -2,6 +2,14 @@ This plugin provides APIs for getting and tracking the device's current position, including information about altitude, heading, and speed (if available). +| Platform | Supported | +| -------- | --------- | +| Linux | x | +| Windows | x | +| macOS | x | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/global-shortcut/README.md b/plugins/global-shortcut/README.md index 68ee4b53e1..5978cae303 100644 --- a/plugins/global-shortcut/README.md +++ b/plugins/global-shortcut/README.md @@ -2,7 +2,13 @@ Register global shortcuts. -- Supported platforms: Windows, Linux and macOS. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | x | +| iOS | x | ## Install diff --git a/plugins/haptics/README.md b/plugins/haptics/README.md index f29c8c32b0..42c9b455ad 100644 --- a/plugins/haptics/README.md +++ b/plugins/haptics/README.md @@ -4,6 +4,14 @@ Haptic feedback and vibrations on Android and iOS. There are no standards/requirements for vibration support on Android, so the `feedback` APIs may not work correctly on more affordable phones, including recently released ones. +| Platform | Supported | +| -------- | --------- | +| Linux | x | +| Windows | x | +| macOS | x | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/http/README.md b/plugins/http/README.md index d6c6a98003..b45f826816 100644 --- a/plugins/http/README.md +++ b/plugins/http/README.md @@ -2,6 +2,14 @@ Access the HTTP client written in Rust. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/localhost/README.md b/plugins/localhost/README.md index 21d7642927..b1e825dedf 100644 --- a/plugins/localhost/README.md +++ b/plugins/localhost/README.md @@ -2,6 +2,14 @@ Expose your apps assets through a localhost server instead of the default custom protocol. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + > Note: This plugins brings considerable security risks and you should only use it if you know what your are doing. If in doubt, use the default custom protocol implementation. ## Install diff --git a/plugins/log/README.md b/plugins/log/README.md index e1410ecf64..9362fa2526 100644 --- a/plugins/log/README.md +++ b/plugins/log/README.md @@ -2,6 +2,14 @@ Configurable logging for your Tauri app. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/nfc/README.md b/plugins/nfc/README.md index 7ad2213dfc..9427d7ca23 100644 --- a/plugins/nfc/README.md +++ b/plugins/nfc/README.md @@ -2,6 +2,14 @@ Read and write NFC tags on Android and iOS. +| Platform | Supported | +| -------- | --------- | +| Linux | x | +| Windows | x | +| macOS | x | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.65**_ diff --git a/plugins/notification/README.md b/plugins/notification/README.md index 65fd4852de..14977dbd5c 100644 --- a/plugins/notification/README.md +++ b/plugins/notification/README.md @@ -2,6 +2,14 @@ Send message notifications (brief auto-expiring OS window element) to your user. Can also be used with the Notification Web API. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/os/README.md b/plugins/os/README.md index 5d82e99724..f84d123a2c 100644 --- a/plugins/os/README.md +++ b/plugins/os/README.md @@ -2,6 +2,14 @@ Read information about the operating system. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/persisted-scope/Cargo.toml b/plugins/persisted-scope/Cargo.toml index caee352282..19acc56bb5 100644 --- a/plugins/persisted-scope/Cargo.toml +++ b/plugins/persisted-scope/Cargo.toml @@ -16,8 +16,8 @@ rustdoc-args = ["--cfg", "docsrs"] windows = { level = "full", notes = "" } linux = { level = "full", notes = "" } macos = { level = "full", notes = "" } -android = { level = "none", notes = "" } -ios = { level = "none", notes = "" } +android = { level = "full", notes = "" } +ios = { level = "full", notes = "" } [dependencies] serde = { workspace = true } diff --git a/plugins/persisted-scope/README.md b/plugins/persisted-scope/README.md index 8be89f690b..bf959443b6 100644 --- a/plugins/persisted-scope/README.md +++ b/plugins/persisted-scope/README.md @@ -2,6 +2,14 @@ Save filesystem and asset scopes and restore them when the app is reopened. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/positioner/README.md b/plugins/positioner/README.md index 3c8ac1d91a..3652c162e0 100644 --- a/plugins/positioner/README.md +++ b/plugins/positioner/README.md @@ -4,6 +4,14 @@ Position your windows at well-known locations. This plugin is a port of [electron-positioner](https://github.com/jenslind/electron-positioner) for Tauri. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | x | +| iOS | x | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/process/README.md b/plugins/process/README.md index 89c04d5a01..50c7634b0a 100644 --- a/plugins/process/README.md +++ b/plugins/process/README.md @@ -2,6 +2,14 @@ This plugin provides APIs to access the current process. To spawn child processes, see the [`shell`](https://github.com/tauri-apps/tauri-plugin-shell) plugin. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | x | +| iOS | x | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/shell/README.md b/plugins/shell/README.md index 25137648e6..c52b0eb4e1 100644 --- a/plugins/shell/README.md +++ b/plugins/shell/README.md @@ -2,6 +2,14 @@ Access the system shell. Allows you to spawn child processes and manage files and URLs using their default application. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/single-instance/README.md b/plugins/single-instance/README.md index bd761018b4..551ea72d96 100644 --- a/plugins/single-instance/README.md +++ b/plugins/single-instance/README.md @@ -2,6 +2,14 @@ Ensure a single instance of your tauri app is running. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | x | +| iOS | x | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/sql/README.md b/plugins/sql/README.md index 4813d327d2..3c9b5aa5de 100644 --- a/plugins/sql/README.md +++ b/plugins/sql/README.md @@ -2,6 +2,14 @@ Interface with SQL databases through [sqlx](https://github.com/launchbadge/sqlx). It supports the `sqlite`, `mysql` and `postgres` drivers, enabled by a Cargo feature. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | x | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/store/README.md b/plugins/store/README.md index f7d65a0f7c..5ba41c80f5 100644 --- a/plugins/store/README.md +++ b/plugins/store/README.md @@ -2,6 +2,14 @@ Simple, persistent key-value store. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/stronghold/Cargo.toml b/plugins/stronghold/Cargo.toml index 374134dc22..d979bb8605 100644 --- a/plugins/stronghold/Cargo.toml +++ b/plugins/stronghold/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "tauri-plugin-stronghold" version = "2.0.0-rc.1" -description = "Store secrets and keys using the IOTA Stronghold encrypted database." +description = "Store secrets and keys using the IOTA Stronghold secret management engine." authors = { workspace = true } license = { workspace = true } edition = { workspace = true } @@ -17,8 +17,8 @@ rustdoc-args = ["--cfg", "docsrs"] windows = { level = "full", notes = "" } linux = { level = "full", notes = "" } macos = { level = "full", notes = "" } -android = { level = "none", notes = "" } -ios = { level = "none", notes = "" } +android = { level = "full", notes = "" } +ios = { level = "full", notes = "" } [build-dependencies] tauri-plugin = { workspace = true, features = ["build"] } diff --git a/plugins/stronghold/README.md b/plugins/stronghold/README.md index fd1dae0144..17bd125baa 100644 --- a/plugins/stronghold/README.md +++ b/plugins/stronghold/README.md @@ -1,6 +1,14 @@ ![plugin-stronghold](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/stronghold/banner.png) -Store secrets and keys using the [IOTA Stronghold](https://github.com/iotaledger/stronghold.rs) encrypted database and secure runtime. +Store secrets and keys using the [IOTA Stronghold](https://github.com/iotaledger/stronghold.rs) secret management engine. + +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | ## Install diff --git a/plugins/updater/README.md b/plugins/updater/README.md index 836a63b12f..918e624f46 100644 --- a/plugins/updater/README.md +++ b/plugins/updater/README.md @@ -2,7 +2,13 @@ In-app updates for Tauri applications. -- Supported platforms: Windows, Linux and macOS. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | x | +| iOS | x | ## Install diff --git a/plugins/upload/Cargo.toml b/plugins/upload/Cargo.toml index d01f6bbee8..8e2db6bac0 100644 --- a/plugins/upload/Cargo.toml +++ b/plugins/upload/Cargo.toml @@ -17,8 +17,8 @@ rustdoc-args = ["--cfg", "docsrs"] windows = { level = "full", notes = "" } linux = { level = "full", notes = "" } macos = { level = "full", notes = "" } -android = { level = "none", notes = "" } -ios = { level = "none", notes = "" } +android = { level = "full", notes = "" } +ios = { level = "full", notes = "" } [build-dependencies] tauri-plugin = { workspace = true, features = ["build"] } diff --git a/plugins/upload/README.md b/plugins/upload/README.md index a675ad6a4f..bf6a734b18 100644 --- a/plugins/upload/README.md +++ b/plugins/upload/README.md @@ -3,6 +3,14 @@ Upload files from disk to a remote server over HTTP. Download files from a remote HTTP server to disk. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/websocket/Cargo.toml b/plugins/websocket/Cargo.toml index 67c4a9ae75..8fdb22b7ff 100644 --- a/plugins/websocket/Cargo.toml +++ b/plugins/websocket/Cargo.toml @@ -18,8 +18,8 @@ rustdoc-args = ["--cfg", "docsrs"] windows = { level = "full", notes = "" } linux = { level = "full", notes = "" } macos = { level = "full", notes = "" } -android = { level = "none", notes = "" } -ios = { level = "none", notes = "" } +android = { level = "full", notes = "" } +ios = { level = "full", notes = "" } [build-dependencies] tauri-plugin = { workspace = true, features = ["build"] } diff --git a/plugins/websocket/README.md b/plugins/websocket/README.md index db4d1ada62..09a0f55802 100644 --- a/plugins/websocket/README.md +++ b/plugins/websocket/README.md @@ -2,6 +2,14 @@ Expose a WebSocket server to your Tauri frontend. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/plugins/window-state/README.md b/plugins/window-state/README.md index 8781ea612b..96133e1551 100644 --- a/plugins/window-state/README.md +++ b/plugins/window-state/README.md @@ -2,6 +2,14 @@ Save window positions and sizes and restore them when the app is reopened. +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | x | +| iOS | x | + ## Install _This plugin requires a Rust version of at least **1.75**_ diff --git a/shared/template/README.md b/shared/template/README.md index 1dd0a09b36..4387ef3245 100644 --- a/shared/template/README.md +++ b/shared/template/README.md @@ -2,6 +2,14 @@ +| Platform | Supported | +| -------- | --------- | +| Linux | ✓ | +| Windows | ✓ | +| macOS | ✓ | +| Android | ✓ | +| iOS | ✓ | + ## Install _This plugin requires a Rust version of at least **1.75**_