max
/
tauri-plugins-workspace
mirror of https://github.com/tauri-apps/plugins-workspace
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
closes #1795
pull/1868/head
Lucas Fernandes Nogueira 8 months ago committed by GitHub
parent fb62d03f73
commit 58eab11faf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
36 changed files with 263 additions and 21 deletions
Show Stats Download Patch File Download Diff File

7
examples/api/vite.config.js
Unescape View File

@ -26,13 +26,6 @@ export default defineConfig(async () => {
host: host || false, host: host || false,
port: 5173, port: 5173,
strictPort: true, strictPort: true,
hmr: host
? {
protocol: 'ws',
host,
port: 5183
}
: undefined,
fs: { fs: {
allow: ['.', '../../tooling/api/dist'] allow: ['.', '../../tooling/api/dist']
} }

10
plugins/autostart/README.md
Unescape View File

@ -1,6 +1,14 @@
![plugin-autostart](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/autostart/banner.png) ![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 ## Install

8
plugins/barcode-scanner/README.md
Unescape 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. 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 ## Install
_This plugin requires a Rust version of at least **1.64**_ _This plugin requires a Rust version of at least **1.64**_

8
plugins/biometric/README.md
Unescape View File

@ -2,6 +2,14 @@
Prompt the user for biometric authentication on Android and iOS. Prompt the user for biometric authentication on Android and iOS.
| Platform | Supported |
| -------- | --------- |
| Linux | x |
| Windows | x |
| macOS | x |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.65**_ _This plugin requires a Rust version of at least **1.65**_

8
plugins/cli/README.md
Unescape View File

@ -2,7 +2,13 @@
Parse arguments from your Command Line Interface. Parse arguments from your Command Line Interface.
- Supported platforms: Windows, Linux and macOS. | Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | x |
| iOS | x |
## Install ## Install

8
plugins/clipboard-manager/README.md
Unescape View File

@ -2,6 +2,14 @@
Read and write to the system clipboard. Read and write to the system clipboard.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

15
plugins/clipboard-manager/guest-js/index.ts
Unescape View File

@ -49,6 +49,11 @@ async function readText(): Promise<string> {
/** /**
* Writes image buffer to the clipboard. * Writes image buffer to the clipboard.
*
* #### Platform-specific
*
* - **Android / iOS:** Not supported.
*
* @example * @example
* ```typescript * ```typescript
* import { writeImage } from '@tauri-apps/plugin-clipboard-manager'; * import { writeImage } from '@tauri-apps/plugin-clipboard-manager';
@ -75,6 +80,11 @@ async function writeImage(
/** /**
* Gets the clipboard content as Uint8Array image. * Gets the clipboard content as Uint8Array image.
*
* #### Platform-specific
*
* - **Android / iOS:** Not supported.
*
* @example * @example
* ```typescript * ```typescript
* import { readImage } from '@tauri-apps/plugin-clipboard-manager'; * 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. * * Writes HTML or fallbacks to write provided plain text to the clipboard.
*
* #### Platform-specific
*
* - **Android / iOS:** Not supported.
*
* @example * @example
* ```typescript * ```typescript
* import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager'; * import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager';

8
plugins/deep-link/README.md
Unescape View File

@ -2,6 +2,14 @@
Set your Tauri application as the default handler for an URL. Set your Tauri application as the default handler for an URL.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/dialog/README.md
Unescape View File

@ -2,6 +2,14 @@
Native system dialogs for opening and saving files along with message dialogs. Native system dialogs for opening and saving files along with message dialogs.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/fs/README.md
Unescape View File

@ -2,6 +2,14 @@
Access the file system. Access the file system.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/geolocation/README.md
Unescape 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). 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 ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/global-shortcut/README.md
Unescape View File

@ -2,7 +2,13 @@
Register global shortcuts. Register global shortcuts.
- Supported platforms: Windows, Linux and macOS. | Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | x |
| iOS | x |
## Install ## Install

8
plugins/haptics/README.md
Unescape 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. 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 ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/http/README.md
Unescape View File

@ -2,6 +2,14 @@
Access the HTTP client written in Rust. Access the HTTP client written in Rust.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/localhost/README.md
Unescape View File

@ -2,6 +2,14 @@
Expose your apps assets through a localhost server instead of the default custom protocol. 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. > 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 ## Install

8
plugins/log/README.md
Unescape View File

@ -2,6 +2,14 @@
Configurable logging for your Tauri app. Configurable logging for your Tauri app.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/nfc/README.md
Unescape View File

@ -2,6 +2,14 @@
Read and write NFC tags on Android and iOS. Read and write NFC tags on Android and iOS.
| Platform | Supported |
| -------- | --------- |
| Linux | x |
| Windows | x |
| macOS | x |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.65**_ _This plugin requires a Rust version of at least **1.65**_

8
plugins/notification/README.md
Unescape 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. 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 ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/os/README.md
Unescape View File

@ -2,6 +2,14 @@
Read information about the operating system. Read information about the operating system.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

4
plugins/persisted-scope/Cargo.toml
Unescape View File

@ -16,8 +16,8 @@ rustdoc-args = ["--cfg", "docsrs"]
windows = { level = "full", notes = "" } windows = { level = "full", notes = "" }
linux = { level = "full", notes = "" } linux = { level = "full", notes = "" }
macos = { level = "full", notes = "" } macos = { level = "full", notes = "" }
android = { level = "none", notes = "" } android = { level = "full", notes = "" }
ios = { level = "none", notes = "" } ios = { level = "full", notes = "" }
[dependencies] [dependencies]
serde = { workspace = true } serde = { workspace = true }

8
plugins/persisted-scope/README.md
Unescape View File

@ -2,6 +2,14 @@
Save filesystem and asset scopes and restore them when the app is reopened. Save filesystem and asset scopes and restore them when the app is reopened.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/positioner/README.md
Unescape 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. 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 ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/process/README.md
Unescape 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. 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 ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/shell/README.md
Unescape 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. 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 ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/single-instance/README.md
Unescape View File

@ -2,6 +2,14 @@
Ensure a single instance of your tauri app is running. Ensure a single instance of your tauri app is running.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | x |
| iOS | x |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/sql/README.md
Unescape 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. 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 ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/store/README.md
Unescape View File

@ -2,6 +2,14 @@
Simple, persistent key-value store. Simple, persistent key-value store.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

6
plugins/stronghold/Cargo.toml
Unescape View File

@ -1,7 +1,7 @@
[package] [package]
name = "tauri-plugin-stronghold" name = "tauri-plugin-stronghold"
version = "2.0.0-rc.1" 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 } authors = { workspace = true }
license = { workspace = true } license = { workspace = true }
edition = { workspace = true } edition = { workspace = true }
@ -17,8 +17,8 @@ rustdoc-args = ["--cfg", "docsrs"]
windows = { level = "full", notes = "" } windows = { level = "full", notes = "" }
linux = { level = "full", notes = "" } linux = { level = "full", notes = "" }
macos = { level = "full", notes = "" } macos = { level = "full", notes = "" }
android = { level = "none", notes = "" } android = { level = "full", notes = "" }
ios = { level = "none", notes = "" } ios = { level = "full", notes = "" }
[build-dependencies] [build-dependencies]
tauri-plugin = { workspace = true, features = ["build"] } tauri-plugin = { workspace = true, features = ["build"] }

10
plugins/stronghold/README.md
Unescape View File

@ -1,6 +1,14 @@
![plugin-stronghold](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/stronghold/banner.png) ![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 ## Install

8
plugins/updater/README.md
Unescape View File

@ -2,7 +2,13 @@
In-app updates for Tauri applications. In-app updates for Tauri applications.
- Supported platforms: Windows, Linux and macOS. | Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | x |
| iOS | x |
## Install ## Install

4
plugins/upload/Cargo.toml
Unescape View File

@ -17,8 +17,8 @@ rustdoc-args = ["--cfg", "docsrs"]
windows = { level = "full", notes = "" } windows = { level = "full", notes = "" }
linux = { level = "full", notes = "" } linux = { level = "full", notes = "" }
macos = { level = "full", notes = "" } macos = { level = "full", notes = "" }
android = { level = "none", notes = "" } android = { level = "full", notes = "" }
ios = { level = "none", notes = "" } ios = { level = "full", notes = "" }
[build-dependencies] [build-dependencies]
tauri-plugin = { workspace = true, features = ["build"] } tauri-plugin = { workspace = true, features = ["build"] }

8
plugins/upload/README.md
Unescape View File

@ -3,6 +3,14 @@
Upload files from disk to a remote server over HTTP. Upload files from disk to a remote server over HTTP.
Download files from a remote HTTP server to disk. Download files from a remote HTTP server to disk.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

4
plugins/websocket/Cargo.toml
Unescape View File

@ -18,8 +18,8 @@ rustdoc-args = ["--cfg", "docsrs"]
windows = { level = "full", notes = "" } windows = { level = "full", notes = "" }
linux = { level = "full", notes = "" } linux = { level = "full", notes = "" }
macos = { level = "full", notes = "" } macos = { level = "full", notes = "" }
android = { level = "none", notes = "" } android = { level = "full", notes = "" }
ios = { level = "none", notes = "" } ios = { level = "full", notes = "" }
[build-dependencies] [build-dependencies]
tauri-plugin = { workspace = true, features = ["build"] } tauri-plugin = { workspace = true, features = ["build"] }

8
plugins/websocket/README.md
Unescape View File

@ -2,6 +2,14 @@
Expose a WebSocket server to your Tauri frontend. Expose a WebSocket server to your Tauri frontend.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
plugins/window-state/README.md
Unescape View File

@ -2,6 +2,14 @@
Save window positions and sizes and restore them when the app is reopened. Save window positions and sizes and restore them when the app is reopened.
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | x |
| iOS | x |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

8
shared/template/README.md
Unescape View File

@ -2,6 +2,14 @@
<!-- description --> <!-- description -->
| Platform | Supported |
| -------- | --------- |
| Linux | ✓ |
| Windows | ✓ |
| macOS | ✓ |
| Android | ✓ |
| iOS | ✓ |
## Install ## Install
_This plugin requires a Rust version of at least **1.75**_ _This plugin requires a Rust version of at least **1.75**_

Write Preview
Loading…
Cancel
Save