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: Adapt readmes to next branch

Browse Source
pull/335/head
FabianLars 2 years ago
parent b1b6c34b9c
commit 59cb08e902
No known key found for this signature in database
GPG Key ID: 3B12BC1DEBF61125
21 changed files with 116 additions and 136 deletions
Show Stats Download Patch File Download Diff File

32
plugins/authenticator/README.md
Unescape View File

@ -20,7 +20,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
[dependencies] [dependencies]
tauri-plugin-authenticator = "0.1" tauri-plugin-authenticator = "0.1"
# or through git # or through git
tauri-plugin-authenticator = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-authenticator = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -28,11 +28,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add https://github.com/tauri-apps/tauri-plugin-authenticator pnpm add https://github.com/tauri-apps/tauri-plugin-authenticator#next
# or # or
npm add https://github.com/tauri-apps/tauri-plugin-authenticator npm add https://github.com/tauri-apps/tauri-plugin-authenticator#next
# or # or
yarn add https://github.com/tauri-apps/tauri-plugin-authenticator yarn add https://github.com/tauri-apps/tauri-plugin-authenticator#next
``` ```
## Usage ## Usage
@ -53,7 +53,7 @@ fn main() {
Afterwards all the plugin's APIs are available through the JavaScript guest bindings: Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
```javascript ```javascript
import { Authenticator } from "tauri-plugin-authenticator-api"; import { Authenticator } from 'tauri-plugin-authenticator-api';
const auth = new Authenticator(); const auth = new Authenticator();
auth.init(); // initialize transports auth.init(); // initialize transports
@ -63,21 +63,16 @@ const arr = new Uint32Array(32);
window.crypto.getRandomValues(arr); window.crypto.getRandomValues(arr);
const b64 = btoa(String.fromCharCode.apply(null, arr)); const b64 = btoa(String.fromCharCode.apply(null, arr));
// web-safe base64 // web-safe base64
const challenge = b64.replace(/\+/g, "-").replace(/\//g, "_"); const challenge = b64.replace(/\+/g, '-').replace(/\//g, '_');
const domain = "https://tauri.app"; const domain = 'https://tauri.app';
// attempt to register with the security key // attempt to register with the security key
const json = await auth.register(challenge, domain); const json = await auth.register(challenge, domain);
const registerResult = JSON.parse(json); const registerResult = JSON.parse(json);
// verify te registration was successfull // verify te registration was successfull
const r2 = await auth.verifyRegistration( const r2 = await auth.verifyRegistration(challenge, app, registerResult.registerData, registerResult.clientData);
challenge,
app,
registerResult.registerData,
registerResult.clientData
);
const j2 = JSON.parse(r2); const j2 = JSON.parse(r2);
// sign some data // sign some data
@ -85,17 +80,10 @@ const json = await auth.sign(challenge, app, keyHandle);
const signData = JSON.parse(json); const signData = JSON.parse(json);
// verify the signature again // verify the signature again
const counter = await auth.verifySignature( const counter = await auth.verifySignature(challenge, app, signData.signData, clientData, keyHandle, pubkey);
challenge,
app,
signData.signData,
clientData,
keyHandle,
pubkey
);
if (counter && counter > 0) { if (counter && counter > 0) {
console.log("SUCCESS!"); console.log('SUCCESS!');
} }
``` ```

10
plugins/autostart/README.md
Unescape View File

@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
tauri-plugin-autostart = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-autostart = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add https://github.com/tauri-apps/tauri-plugin-autostart pnpm add https://github.com/tauri-apps/tauri-plugin-autostart#next
# or # or
npm add https://github.com/tauri-apps/tauri-plugin-autostart npm add https://github.com/tauri-apps/tauri-plugin-autostart#next
# or # or
yarn add https://github.com/tauri-apps/tauri-plugin-autostart yarn add https://github.com/tauri-apps/tauri-plugin-autostart#next
``` ```
## Usage ## Usage
@ -53,7 +53,7 @@ fn main() {
Afterwards all the plugin's APIs are available through the JavaScript guest bindings: Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
```javascript ```javascript
import { enable, isEnabled, disable } from "tauri-plugin-autostart-api"; import { enable, isEnabled, disable } from 'tauri-plugin-autostart-api';
await enable(); await enable();

12
plugins/cli/README.md
Unescape View File

@ -1,4 +1,4 @@
![{{plugin name}}](banner.jpg) ![plugin-cli](banner.jpg)
<!-- description --> <!-- description -->
@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
<!-- plugin here --> = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-cli = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add <!-- plugin here --> pnpm add https://github.com/tauri-apps/tauri-plugin-cli#next
# or # or
npm add <!-- plugin here --> npm add https://github.com/tauri-apps/tauri-plugin-cli#next
# or # or
yarn add <!-- plugin here --> yarn add https://github.com/tauri-apps/tauri-plugin-cli#next
``` ```
## Usage ## Usage
@ -42,7 +42,7 @@ First you need to register the core plugin with Tauri:
```rust ```rust
fn main() { fn main() {
tauri::Builder::default() tauri::Builder::default()
.plugin(<!-- plugin here -->) .plugin(tauri_plugin_cli::init())
.run(tauri::generate_context!()) .run(tauri::generate_context!())
.expect("error while running tauri application"); .expect("error while running tauri application");
} }

12
plugins/clipboard/README.md
Unescape View File

@ -1,4 +1,4 @@
![{{plugin name}}](banner.jpg) ![plugin-clipboard](banner.jpg)
<!-- description --> <!-- description -->
@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
<!-- plugin here --> = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-clipboard = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add <!-- plugin here --> pnpm add https://github.com/tauri-apps/tauri-plugin-clipboard#next
# or # or
npm add <!-- plugin here --> npm add https://github.com/tauri-apps/tauri-plugin-clipboard#next
# or # or
yarn add <!-- plugin here --> yarn add https://github.com/tauri-apps/tauri-plugin-clipboard#next
``` ```
## Usage ## Usage
@ -42,7 +42,7 @@ First you need to register the core plugin with Tauri:
```rust ```rust
fn main() { fn main() {
tauri::Builder::default() tauri::Builder::default()
.plugin(<!-- plugin here -->) .plugin(tauri_plugin_clipboard::init())
.run(tauri::generate_context!()) .run(tauri::generate_context!())
.expect("error while running tauri application"); .expect("error while running tauri application");
} }

2
plugins/dialog/README.md
Unescape View File

@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
tauri-plugin-dialog-api = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-dialog-api = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:

26
plugins/fs-watch/README.md
Unescape View File

@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
tauri-plugin-fs-watch = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-fs-watch = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add https://github.com/tauri-apps/tauri-plugin-fs-watch pnpm add https://github.com/tauri-apps/tauri-plugin-fs-watch#next
# or # or
npm add https://github.com/tauri-apps/tauri-plugin-fs-watch npm add https://github.com/tauri-apps/tauri-plugin-fs-watch#next
# or # or
yarn add https://github.com/tauri-apps/tauri-plugin-fs-watch yarn add https://github.com/tauri-apps/tauri-plugin-fs-watch#next
``` ```
## Usage ## Usage
@ -51,24 +51,16 @@ fn main() {
Afterwards all the plugin's APIs are available through the JavaScript guest bindings: Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
```javascript ```javascript
import { watch, watchImmediate } from "tauri-plugin-fs-watch-api"; import { watch, watchImmediate } from 'tauri-plugin-fs-watch-api';
// can also watch an array of paths // can also watch an array of paths
const stopWatching = await watch( const stopWatching = await watch('/path/to/something', { recursive: true }, (event) => {
"/path/to/something",
{ recursive: true },
(event) => {
const { type, payload } = event; const { type, payload } = event;
} });
);
const stopRawWatcher = await watchImmediate( const stopRawWatcher = await watchImmediate(['/path/a', '/path/b'], {}, (event) => {
["/path/a", "/path/b"],
{},
(event) => {
const { path, operation, cookie } = event; const { path, operation, cookie } = event;
} });
);
``` ```
## Contributing ## Contributing

12
plugins/fs/README.md
Unescape View File

@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
tauri-plugin-fs = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-fs = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add https://github.com/tauri-apps/tauri-plugin-fs pnpm add https://github.com/tauri-apps/tauri-plugin-fs#next
# or # or
npm add https://github.com/tauri-apps/tauri-plugin-fs npm add https://github.com/tauri-apps/tauri-plugin-fs#next
# or # or
yarn add https://github.com/tauri-apps/tauri-plugin-fs yarn add https://github.com/tauri-apps/tauri-plugin-fs#next
``` ```
## Usage ## Usage
@ -51,9 +51,9 @@ fn main() {
Afterwards all the plugin's APIs are available through the JavaScript guest bindings: Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
```javascript ```javascript
import { metadata } from "tauri-plugin-fs-api"; import { metadata } from 'tauri-plugin-fs-api';
await metadata("/path/to/file"); await metadata('/path/to/file');
``` ```
## Contributing ## Contributing

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

@ -1,4 +1,4 @@
![{{plugin name}}](banner.jpg) ![plugin-shortcut](banner.jpg)
<!-- description --> <!-- description -->
@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
<!-- plugin here --> = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-shortcut = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add <!-- plugin here --> pnpm add https://github.com/tauri-apps/tauri-plugin-shortcut#next
# or # or
npm add <!-- plugin here --> npm add https://github.com/tauri-apps/tauri-plugin-shortcut#next
# or # or
yarn add <!-- plugin here --> yarn add https://github.com/tauri-apps/tauri-plugin-shortcut#next
``` ```
## Usage ## Usage
@ -42,7 +42,7 @@ First you need to register the core plugin with Tauri:
```rust ```rust
fn main() { fn main() {
tauri::Builder::default() tauri::Builder::default()
.plugin(<!-- plugin here -->) .plugin(tauri_plugin_shortcut::init())
.run(tauri::generate_context!()) .run(tauri::generate_context!())
.expect("error while running tauri application"); .expect("error while running tauri application");
} }

12
plugins/http/README.md
Unescape View File

@ -1,4 +1,4 @@
![{{plugin name}}](banner.jpg) ![plugin-http](banner.jpg)
<!-- description --> <!-- description -->
@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
<!-- plugin here --> = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-http = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add <!-- plugin here --> pnpm add https://github.com/tauri-apps/tauri-plugin-http#next
# or # or
npm add <!-- plugin here --> npm add https://github.com/tauri-apps/tauri-plugin-http#next
# or # or
yarn add <!-- plugin here --> yarn add https://github.com/tauri-apps/tauri-plugin-http#next
``` ```
## Usage ## Usage
@ -42,7 +42,7 @@ First you need to register the core plugin with Tauri:
```rust ```rust
fn main() { fn main() {
tauri::Builder::default() tauri::Builder::default()
.plugin(<!-- plugin here -->) .plugin(tauri_plugin_http::init())
.run(tauri::generate_context!()) .run(tauri::generate_context!())
.expect("error while running tauri application"); .expect("error while running tauri application");
} }

2
plugins/localhost/README.md
Unescape View File

@ -20,7 +20,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
tauri-plugin-localhost = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-localhost = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
portpicker = "0.1" # used in the example to pick a random free port portpicker = "0.1" # used in the example to pick a random free port
``` ```

16
plugins/log/README.md
Unescape View File

@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
tauri-plugin-log = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-log = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add https://github.com/tauri-apps/tauri-plugin-log pnpm add https://github.com/tauri-apps/tauri-plugin-log#next
# or # or
npm add https://github.com/tauri-apps/tauri-plugin-log npm add https://github.com/tauri-apps/tauri-plugin-log#next
# or # or
yarn add https://github.com/tauri-apps/tauri-plugin-log yarn add https://github.com/tauri-apps/tauri-plugin-log#next
``` ```
## Usage ## Usage
@ -57,14 +57,14 @@ fn main() {
Afterwards all the plugin's APIs are available through the JavaScript guest bindings: Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
```javascript ```javascript
import { trace, info, error, attachConsole } from "tauri-plugin-log-api"; import { trace, info, error, attachConsole } from 'tauri-plugin-log-api';
// with LogTarget::Webview enabled this function will print logs to the browser console // with LogTarget::Webview enabled this function will print logs to the browser console
const detach = await attachConsole(); const detach = await attachConsole();
trace("Trace"); trace('Trace');
info("Info"); info('Info');
error("Error"); error('Error');
// detach the browser console from the log stream // detach the browser console from the log stream
detach(); detach();

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

@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
tauri-plugin-persisted-scope = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-persisted-scope = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
## Usage ## Usage

10
plugins/positioner/README.md
Unescape View File

@ -22,7 +22,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
[dependencies] [dependencies]
tauri-plugin-positioner = "1.0" tauri-plugin-positioner = "1.0"
# or through git # or through git
tauri-plugin-positioner = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-positioner = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -40,11 +40,11 @@ yarn add tauri-plugin-positioner
Or through git: Or through git:
```sh ```sh
pnpm add https://github.com/tauri-apps/tauri-plugin-positioner pnpm add https://github.com/tauri-apps/tauri-plugin-positioner#next
# or # or
npm add https://github.com/tauri-apps/tauri-plugin-positioner npm add https://github.com/tauri-apps/tauri-plugin-positioner#next
# or # or
yarn add https://github.com/tauri-apps/tauri-plugin-positioner yarn add https://github.com/tauri-apps/tauri-plugin-positioner#next
``` ```
## Usage ## Usage
@ -69,7 +69,7 @@ fn main() {
Afterwards all the plugin's APIs are available through the JavaScript guest bindings: Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
```javascript ```javascript
import { move_window, Position } from "tauri-plugin-positioner-api"; import { move_window, Position } from 'tauri-plugin-positioner-api';
move_window(Position.TopRight); move_window(Position.TopRight);
``` ```

12
plugins/shell/README.md
Unescape View File

@ -1,4 +1,4 @@
![{{plugin name}}](banner.jpg) ![plugin-shell](banner.jpg)
<!-- description --> <!-- description -->
@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
<!-- plugin here --> = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-shell = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add <!-- plugin here --> pnpm add https://github.com/tauri-apps/tauri-plugin-shell#next
# or # or
npm add <!-- plugin here --> npm add https://github.com/tauri-apps/tauri-plugin-shell#next
# or # or
yarn add <!-- plugin here --> yarn add https://github.com/tauri-apps/tauri-plugin-shell#next
``` ```
## Usage ## Usage
@ -42,7 +42,7 @@ First you need to register the core plugin with Tauri:
```rust ```rust
fn main() { fn main() {
tauri::Builder::default() tauri::Builder::default()
.plugin(<!-- plugin here -->) .plugin(tauri_plugin_shell::init())
.run(tauri::generate_context!()) .run(tauri::generate_context!())
.expect("error while running tauri application"); .expect("error while running tauri application");
} }

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

@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
tauri-plugin-single-instance = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-single-instance = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
## Usage ## Usage

18
plugins/sql/README.md
Unescape View File

@ -19,7 +19,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies.tauri-plugin-sql] [dependencies.tauri-plugin-sql]
git = "https://github.com/tauri-apps/plugins-workspace" git = "https://github.com/tauri-apps/plugins-workspace"
branch = "dev" branch = "next"
features = ["sqlite"] # or "postgres", or "mysql" features = ["sqlite"] # or "postgres", or "mysql"
``` ```
@ -28,11 +28,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add https://github.com/tauri-apps/tauri-plugin-sql pnpm add https://github.com/tauri-apps/tauri-plugin-sql#next
# or # or
npm add https://github.com/tauri-apps/tauri-plugin-sql npm add https://github.com/tauri-apps/tauri-plugin-sql#next
# or # or
yarn add https://github.com/tauri-apps/tauri-plugin-sql yarn add https://github.com/tauri-apps/tauri-plugin-sql#next
``` ```
## Usage ## Usage
@ -53,16 +53,16 @@ fn main() {
Afterwards all the plugin's APIs are available through the JavaScript guest bindings: Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
```javascript ```javascript
import Database from "tauri-plugin-sql-api"; import Database from 'tauri-plugin-sql-api';
// sqlite. The path is relative to `tauri::api::path::BaseDirectory::App`. // sqlite. The path is relative to `tauri::api::path::BaseDirectory::App`.
const db = await Database.load("sqlite:test.db"); const db = await Database.load('sqlite:test.db');
// mysql // mysql
const db = await Database.load("mysql://user:pass@host/database"); const db = await Database.load('mysql://user:pass@host/database');
// postgres // postgres
const db = await Database.load("postgres://postgres:password@localhost/test"); const db = await Database.load('postgres://postgres:password@localhost/test');
await db.execute("INSERT INTO ..."); await db.execute('INSERT INTO ...');
``` ```
## Contributing ## Contributing

16
plugins/store/README.md
Unescape View File

@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
tauri-plugin-store = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-store = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add https://github.com/tauri-apps/tauri-plugin-store pnpm add https://github.com/tauri-apps/tauri-plugin-store#next
# or # or
npm add https://github.com/tauri-apps/tauri-plugin-store npm add https://github.com/tauri-apps/tauri-plugin-store#next
# or # or
yarn add https://github.com/tauri-apps/tauri-plugin-store yarn add https://github.com/tauri-apps/tauri-plugin-store#next
``` ```
## Usage ## Usage
@ -51,13 +51,13 @@ fn main() {
Afterwards all the plugin's APIs are available through the JavaScript guest bindings: Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
```javascript ```javascript
import { Store } from "tauri-plugin-store-api"; import { Store } from 'tauri-plugin-store-api';
const store = new Store(".settings.dat"); const store = new Store('.settings.dat');
await store.set("some-key", { value: 5 }); await store.set('some-key', { value: 5 });
const val = await store.get("some-key"); const val = await store.get('some-key');
assert(val, { value: 5 }); assert(val, { value: 5 });
await store.save(); // this manually saves the store, otherwise the store is only saved when your app is closed await store.save(); // this manually saves the store, otherwise the store is only saved when your app is closed

10
plugins/stronghold/README.md
Unescape View File

@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
tauri-plugin-stronghold = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-stronghold = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add https://github.com/tauri-apps/tauri-plugin-stronghold pnpm add https://github.com/tauri-apps/tauri-plugin-stronghold#next
# or # or
npm add https://github.com/tauri-apps/tauri-plugin-stronghold npm add https://github.com/tauri-apps/tauri-plugin-stronghold#next
# or # or
yarn add https://github.com/tauri-apps/tauri-plugin-stronghold yarn add https://github.com/tauri-apps/tauri-plugin-stronghold#next
``` ```
## Usage ## Usage
@ -55,7 +55,7 @@ fn main() {
Afterwards all the plugin's APIs are available through the JavaScript guest bindings: Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
```javascript ```javascript
import { Stronghold, Location } from "tauri-plugin-stronghold-api"; import { Stronghold, Location } from 'tauri-plugin-stronghold-api';
// TODO // TODO
``` ```

8
plugins/upload/README.md
Unescape View File

@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
tauri-plugin-upload = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-upload = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add https://github.com/tauri-apps/tauri-plugin-upload pnpm add https://github.com/tauri-apps/tauri-plugin-upload#next
# or # or
npm add https://github.com/tauri-apps/tauri-plugin-upload npm add https://github.com/tauri-apps/tauri-plugin-upload#next
# or # or
yarn add https://github.com/tauri-apps/tauri-plugin-upload yarn add https://github.com/tauri-apps/tauri-plugin-upload#next
``` ```
## Usage ## Usage

14
plugins/websocket/README.md
Unescape View File

@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
tauri-plugin-websocket = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-websocket = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add https://github.com/tauri-apps/tauri-plugin-websocket pnpm add https://github.com/tauri-apps/tauri-plugin-websocket#next
# or # or
npm add https://github.com/tauri-apps/tauri-plugin-websocket npm add https://github.com/tauri-apps/tauri-plugin-websocket#next
# or # or
yarn add https://github.com/tauri-apps/tauri-plugin-websocket yarn add https://github.com/tauri-apps/tauri-plugin-websocket#next
``` ```
## Usage ## Usage
@ -51,11 +51,11 @@ fn main() {
Afterwards all the plugin's APIs are available through the JavaScript guest bindings: Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
```javascript ```javascript
import { WebSocket } from "tauri-plugin-websocket-api"; import { WebSocket } from 'tauri-plugin-websocket-api';
const ws = await WebSocket.connect("wss://example.com"); const ws = await WebSocket.connect('wss://example.com');
await ws.send("Hello World"); await ws.send('Hello World');
await ws.disconnect(); await ws.disconnect();
``` ```

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

@ -18,7 +18,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
```toml ```toml
[dependencies] [dependencies]
tauri-plugin-window-state = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" } tauri-plugin-window-state = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "next" }
``` ```
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
@ -26,11 +26,11 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
```sh ```sh
pnpm add https://github.com/tauri-apps/tauri-plugin-window-state pnpm add https://github.com/tauri-apps/tauri-plugin-window-state#next
# or # or
npm add https://github.com/tauri-apps/tauri-plugin-window-state npm add https://github.com/tauri-apps/tauri-plugin-window-state#next
# or # or
yarn add https://github.com/tauri-apps/tauri-plugin-window-state yarn add https://github.com/tauri-apps/tauri-plugin-window-state#next
``` ```
## Usage ## Usage
@ -62,7 +62,7 @@ app.save_window_state(StateFlags::all()); // will save the state of all open win
or through Javascript or through Javascript
```javascript ```javascript
import { saveWindowState, StateFlags } from "tauri-plugin-window-state-api"; import { saveWindowState, StateFlags } from 'tauri-plugin-window-state-api';
saveWindowState(StateFlags.ALL); saveWindowState(StateFlags.ALL);
``` ```
@ -79,7 +79,7 @@ window.restore_state(StateFlags::all()); // will restore the windows state from
or through Javascript or through Javascript
```javascript ```javascript
import { restoreStateCurrent, StateFlags } from "tauri-plugin-window-state-api"; import { restoreStateCurrent, StateFlags } from 'tauri-plugin-window-state-api';
restoreStateCurrent(StateFlags.ALL); restoreStateCurrent(StateFlags.ALL);
``` ```

Write Preview
Loading…
Cancel
Save