Skip to content

Commit 58eab11

Browse files
lucasfernoglucasfernog
authored
chore: document supported platforms on README, clarify unsupported APIs (#1857)
closes #1795
1 parent fb62d03 commit 58eab11

File tree

36 files changed

+263
-21
lines changed

36 files changed

+263
-21
lines changed

‎examples/api/vite.config.js‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,6 @@ export default defineConfig(async () => {
2626
host: host || false,
2727
port: 5173,
2828
strictPort: true,
29-
hmr: host
30-
? {
31-
protocol: 'ws',
32-
host,
33-
port: 5183
34-
}
35-
: undefined,
3629
fs: {
3730
allow: ['.', '../../tooling/api/dist']
3831
}

‎plugins/autostart/README.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
![plugin-autostart](https://github.com/tauri-apps/plugins-workspace/raw/v2/plugins/autostart/banner.png)
22

3-
Automatically launch your application at startup. Supports Windows, Mac (via AppleScript or Launch Agent), and Linux.
3+
Automatically launch your application at startup.
4+
5+
| Platform | Supported |
6+
| -------- | --------- |
7+
| Linux | ✓ |
8+
| Windows | ✓ |
9+
| macOS | ✓ |
10+
| Android | x |
11+
| iOS | x |
412

513
## Install
614

‎plugins/barcode-scanner/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
Allows your mobile application to use the camera to scan QR codes, EAN-13 and other kinds of barcodes.
44

5+
| Platform | Supported |
6+
| -------- | --------- |
7+
| Linux | x |
8+
| Windows | x |
9+
| macOS | x |
10+
| Android | ✓ |
11+
| iOS | ✓ |
12+
513
## Install
614

715
_This plugin requires a Rust version of at least **1.64**_

‎plugins/biometric/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
Prompt the user for biometric authentication on Android and iOS.
44

5+
| Platform | Supported |
6+
| -------- | --------- |
7+
| Linux | x |
8+
| Windows | x |
9+
| macOS | x |
10+
| Android | ✓ |
11+
| iOS | ✓ |
12+
513
## Install
614

715
_This plugin requires a Rust version of at least **1.65**_

‎plugins/cli/README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
Parse arguments from your Command Line Interface.
44

5-
- Supported platforms: Windows, Linux and macOS.
5+
| Platform | Supported |
6+
| -------- | --------- |
7+
| Linux | ✓ |
8+
| Windows | ✓ |
9+
| macOS | ✓ |
10+
| Android | x |
11+
| iOS | x |
612

713
## Install
814

‎plugins/clipboard-manager/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
Read and write to the system clipboard.
44

5+
| Platform | Supported |
6+
| -------- | --------- |
7+
| Linux | ✓ |
8+
| Windows | ✓ |
9+
| macOS | ✓ |
10+
| Android | ✓ |
11+
| iOS | ✓ |
12+
513
## Install
614

715
_This plugin requires a Rust version of at least **1.75**_

‎plugins/clipboard-manager/guest-js/index.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ async function readText(): Promise<string> {
4949

5050
/**
5151
* Writes image buffer to the clipboard.
52+
*
53+
* #### Platform-specific
54+
*
55+
* - **Android / iOS:** Not supported.
56+
*
5257
* @example
5358
* ```typescript
5459
* import { writeImage } from '@tauri-apps/plugin-clipboard-manager';
@@ -75,6 +80,11 @@ async function writeImage(
7580

7681
/**
7782
* Gets the clipboard content as Uint8Array image.
83+
*
84+
* #### Platform-specific
85+
*
86+
* - **Android / iOS:** Not supported.
87+
*
7888
* @example
7989
* ```typescript
8090
* import { readImage } from '@tauri-apps/plugin-clipboard-manager';
@@ -93,6 +103,11 @@ async function readImage(): Promise<Image> {
93103

94104
/**
95105
* * Writes HTML or fallbacks to write provided plain text to the clipboard.
106+
*
107+
* #### Platform-specific
108+
*
109+
* - **Android / iOS:** Not supported.
110+
*
96111
* @example
97112
* ```typescript
98113
* import { writeHtml, readHtml } from '@tauri-apps/plugin-clipboard-manager';

‎plugins/deep-link/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
Set your Tauri application as the default handler for an URL.
44

5+
| Platform | Supported |
6+
| -------- | --------- |
7+
| Linux | ✓ |
8+
| Windows | ✓ |
9+
| macOS | ✓ |
10+
| Android | ✓ |
11+
| iOS | ✓ |
12+
513
## Install
614

715
_This plugin requires a Rust version of at least **1.75**_

‎plugins/dialog/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
Native system dialogs for opening and saving files along with message dialogs.
44

5+
| Platform | Supported |
6+
| -------- | --------- |
7+
| Linux | ✓ |
8+
| Windows | ✓ |
9+
| macOS | ✓ |
10+
| Android | ✓ |
11+
| iOS | ✓ |
12+
513
## Install
614

715
_This plugin requires a Rust version of at least **1.75**_

‎plugins/fs/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
Access the file system.
44

5+
| Platform | Supported |
6+
| -------- | --------- |
7+
| Linux | ✓ |
8+
| Windows | ✓ |
9+
| macOS | ✓ |
10+
| Android | ✓ |
11+
| iOS | ✓ |
12+
513
## Install
614

715
_This plugin requires a Rust version of at least **1.75**_

0 commit comments

Comments
 (0)