Skip to content

Commit

Permalink
chore: document supported platforms on README, clarify unsupported AP…
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasfernog authored and Sir-Thom committed Oct 22, 2024
1 parent 9ddcb28 commit 133a43a
Show file tree
Hide file tree
Showing 36 changed files with 263 additions and 21 deletions.
7 changes: 0 additions & 7 deletions examples/api/vite.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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']
}
Expand Down
10 changes: 9 additions & 1 deletion plugins/autostart/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
8 changes: 8 additions & 0 deletions plugins/barcode-scanner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 8 additions & 0 deletions plugins/biometric/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 7 additions & 1 deletion plugins/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 8 additions & 0 deletions plugins/clipboard-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
15 changes: 15 additions & 0 deletions plugins/clipboard-manager/guest-js/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand All @@ -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';
Expand All @@ -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';
Expand Down
8 changes: 8 additions & 0 deletions plugins/deep-link/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 8 additions & 0 deletions plugins/dialog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 8 additions & 0 deletions plugins/fs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 8 additions & 0 deletions plugins/geolocation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 7 additions & 1 deletion plugins/global-shortcut/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

Register global shortcuts.

- Supported platforms: Windows, Linux and macOS.
| Platform | Supported |
| -------- | --------- |
| Linux ||
| Windows ||
| macOS ||
| Android | x |
| iOS | x |

## Install

Expand Down
8 changes: 8 additions & 0 deletions plugins/haptics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 8 additions & 0 deletions plugins/http/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 8 additions & 0 deletions plugins/localhost/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions plugins/log/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 8 additions & 0 deletions plugins/nfc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 8 additions & 0 deletions plugins/notification/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 8 additions & 0 deletions plugins/os/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
4 changes: 2 additions & 2 deletions plugins/persisted-scope/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }
Expand Down
8 changes: 8 additions & 0 deletions plugins/persisted-scope/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 8 additions & 0 deletions plugins/positioner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 8 additions & 0 deletions plugins/process/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 8 additions & 0 deletions plugins/shell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
8 changes: 8 additions & 0 deletions plugins/single-instance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**_
Expand Down
Loading

0 comments on commit 133a43a

Please sign in to comment.