mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-04-21 11:26:15 +02:00
Fabian-Lars
8c9ff2a2a9
* chore: Add sponsors section to readme * which link style works in nested folders? * add sponsors to plugin readmes * use https links as src * double test it with the pr branch * revert last commit * fmt
101 lines
3.2 KiB
Markdown
101 lines
3.2 KiB
Markdown
|
|
|
|
Upload files from disk to a remote server over HTTP.
|
|
Download files from a remote HTTP server to disk.
|
|
|
|
## Install
|
|
|
|
_This plugin requires a Rust version of at least **1.64**_
|
|
|
|
There are three general methods of installation that we can recommend.
|
|
|
|
1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
|
|
2. Pull sources directly from Github using git tags / revision hashes (most secure)
|
|
3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
|
|
|
|
Install the Core plugin by adding the following to your `Cargo.toml` file:
|
|
|
|
`src-tauri/Cargo.toml`
|
|
|
|
```toml
|
|
[dependencies]
|
|
tauri-plugin-upload = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v1" }
|
|
```
|
|
|
|
You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
|
|
|
|
> 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
|
|
pnpm add https://github.com/tauri-apps/tauri-plugin-upload#v1
|
|
# or
|
|
npm add https://github.com/tauri-apps/tauri-plugin-upload#v1
|
|
# or
|
|
yarn add https://github.com/tauri-apps/tauri-plugin-upload#v1
|
|
```
|
|
|
|
## Usage
|
|
|
|
First you need to register the core plugin with Tauri:
|
|
|
|
`src-tauri/src/main.rs`
|
|
|
|
```rust
|
|
fn main() {
|
|
tauri::Builder::default()
|
|
.plugin(tauri_plugin_upload::init())
|
|
.run(tauri::generate_context!())
|
|
.expect("error while running tauri application");
|
|
}
|
|
```
|
|
|
|
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
|
|
|
|
```javascript
|
|
import { upload } from "tauri-plugin-upload-api";
|
|
|
|
upload(
|
|
"https://example.com/file-upload",
|
|
"./path/to/my/file.txt",
|
|
(progress, total) => console.log(`Uploaded ${progress} of ${total} bytes`), // a callback that will be called with the upload progress
|
|
{ "Content-Type": "text/plain" }, // optional headers to send with the request
|
|
);
|
|
```
|
|
|
|
```javascript
|
|
import { download } from "tauri-plugin-upload-api";
|
|
|
|
download(
|
|
"https://example.com/file-download-link",
|
|
"./path/to/save/my/file.txt",
|
|
(progress, total) => console.log(`Downloaded ${progress} of ${total} bytes`), // a callback that will be called with the download progress
|
|
{ "Content-Type": "text/plain" }, // optional headers to send with the request
|
|
);
|
|
```
|
|
|
|
## Contributing
|
|
|
|
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
|
|
|
|
## Partners
|
|
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center" valign="middle">
|
|
<a href="https://crabnebula.dev" target="_blank">
|
|
<img src="https://github.com/tauri-apps/plugins-workspace/raw/v1/.github/sponsors/crabnebula.svg" alt="CrabNebula" width="283">
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
For the complete list of sponsors please visit our [website](https://tauri.app#sponsors) and [Open Collective](https://opencollective.com/tauri).
|
|
|
|
## License
|
|
|
|
Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
|
|
|
|
MIT or MIT/Apache 2.0 where applicable.
|