CalvinBackup/tauri-plugins-workspace
1
0
Fork 0
mirror of https://github.com/tauri-apps/plugins-workspace.git synced 2026-05-31 13:39:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: document supported platforms on README, clarify unsupported APIs (#1857)

Browse Source 
closes #1795
This commit is contained in:
Lucas Fernandes Nogueira
2024-10-02 08:27:27 -03:00
committed by GitHub
parent fb62d03f73
commit 58eab11faf
36 changed files with 263 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/api/vite.config.js
-7
View File
@@ -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']
}
plugins/autostart/README.md
+9 -1
View File
@@ -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
plugins/barcode-scanner/README.md
+8
View File
@@ -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**_
plugins/biometric/README.md
+8
View File
@@ -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**_
plugins/cli/README.md
+7 -1
View File
@@ -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
plugins/clipboard-manager/README.md
+8
View File
@@ -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**_
plugins/clipboard-manager/guest-js/index.ts
+15
View File
@@ -49,6 +49,11 @@ async function readText(): Promise<string> {
/**
* 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<Image> {
/**
* * 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';
plugins/deep-link/README.md
+8
View File
@@ -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**_
plugins/dialog/README.md
+8
View File
@@ -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**_
plugins/fs/README.md
+8
View File
@@ -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**_
plugins/geolocation/README.md
+8
View File
@@ -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**_
plugins/global-shortcut/README.md
+7 -1
View File
@@ -2,7 +2,13 @@
Register global shortcuts.
- Supported platforms: Windows, Linux and macOS.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | x |
| iOS | x |
## Install
plugins/haptics/README.md
+8
View File
@@ -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**_
plugins/http/README.md
+8
View File
@@ -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**_
plugins/localhost/README.md
+8
View File
@@ -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
plugins/log/README.md
+8
View File
@@ -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**_
plugins/nfc/README.md
+8
View File
@@ -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**_
plugins/notification/README.md
+8
View File
@@ -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**_
plugins/os/README.md
+8
View File
@@ -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**_
plugins/persisted-scope/Cargo.toml
+2 -2
View File
@@ -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 }
plugins/persisted-scope/README.md
+8
View File
@@ -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**_
plugins/positioner/README.md
+8
View File
@@ -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**_
plugins/process/README.md
+8
View File
@@ -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**_
plugins/shell/README.md
+8
View File
@@ -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**_
plugins/single-instance/README.md
+8
View File
@@ -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**_
plugins/sql/README.md
+8
View File
@@ -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**_
plugins/store/README.md
+8
View File
@@ -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**_
plugins/stronghold/Cargo.toml
+3 -3
View File
@@ -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"] }
plugins/stronghold/README.md
+9 -1
View File
@@ -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
plugins/updater/README.md
+7 -1
View File
@@ -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
plugins/upload/Cargo.toml
+2 -2
View File
@@ -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"] }
plugins/upload/README.md
+8
View File
@@ -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**_
plugins/websocket/Cargo.toml
+2 -2
View File
@@ -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"] }
plugins/websocket/README.md
+8
View File
@@ -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**_
plugins/window-state/README.md
+8
View File
@@ -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**_
shared/template/README.md
+8
View File
@@ -2,6 +2,14 @@
<!-- description -->
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | ✓ |
| iOS | ✓ |
## Install
_This plugin requires a Rust version of at least **1.75**_