mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-04-21 11:26:15 +02:00
Petr
b8056f484c
* feature: reveal multiple items in dir * feature: reveal multiple items in dir * feature: reveal multiple items in dir * feature: reveal multiple items in dir * feature: reveal multiple items in dir * feature: reveal multiple items in dir * feature: reveal multiple items in dir * Support multiple roots on Windows * feature: reveal multiple items in dir * feature: reveal multiple items in dir * feature: reveal multiple items in dir * feature: reveal multiple items in dir --------- Co-authored-by: Tony <legendmastertony@gmail.com>
144 lines
4.1 KiB
Markdown
144 lines
4.1 KiB
Markdown
|
|
|
|
<!-- description -->
|
|
|
|
| Platform | Supported |
|
|
| -------- | --------- |
|
|
| Linux | ✓ |
|
|
| Windows | ✓ |
|
|
| macOS | ✓ |
|
|
| Android | ? |
|
|
| iOS | ? |
|
|
|
|
## Install
|
|
|
|
_This plugin requires a Rust version of at least **1.77.2**_
|
|
|
|
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-opener = "2.0.0"
|
|
# alternatively with Git:
|
|
tauri-plugin-opener = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
|
|
```
|
|
|
|
You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
|
|
|
|
<!-- Add the branch for installations using git! -->
|
|
|
|
```sh
|
|
pnpm add @tauri-apps/plugin-opener
|
|
# or
|
|
npm add @tauri-apps/plugin-opener
|
|
# or
|
|
yarn add @tauri-apps/plugin-opener
|
|
```
|
|
|
|
## Usage
|
|
|
|
First you need to register the core plugin with Tauri:
|
|
|
|
`src-tauri/src/lib.rs`
|
|
|
|
```rust
|
|
fn main() {
|
|
tauri::Builder::default()
|
|
.plugin(tauri_plugin_opener::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 { openUrl, openPath, revealItemInDir } from '@tauri-apps/plugin-opener'
|
|
|
|
// Opens the URL in the default browser
|
|
await openUrl('https://example.com')
|
|
// Or with a specific browser/app
|
|
await openUrl('https://example.com', 'firefox')
|
|
|
|
// Opens the path with the system's default app
|
|
await openPath('/path/to/file')
|
|
// Or with a specific app
|
|
await openPath('/path/to/file', 'firefox')
|
|
|
|
// Reveal a path with the system's default explorer
|
|
await revealItemInDir('/path/to/file')
|
|
|
|
// Reveal multiple paths with the system's default explorer
|
|
// Note: will be renamed to `revealItemsInDir` in the next major version
|
|
await revealItemInDir(['/path/to/file', '/path/to/another/file'])
|
|
```
|
|
|
|
### Usage from Rust
|
|
|
|
You can also use those APIs from Rust:
|
|
|
|
```rust
|
|
use tauri_plugin_opener::OpenerExt;
|
|
|
|
fn main() {
|
|
tauri::Builder::default()
|
|
.plugin(tauri_plugin_opener::init())
|
|
.setup(|app| {
|
|
let opener = app.opener();
|
|
|
|
// Opens the URL in the default browser
|
|
opener.open_url("https://example.com", None::<&str>)?;
|
|
// Or with a specific browser/app
|
|
opener.open_url("https://example.com", Some("firefox"))?;
|
|
|
|
// Opens the path with the system's default app
|
|
opener.open_path("/path/to/file", None::<&str>)?;
|
|
// Or with a specific app
|
|
opener.open_path("/path/to/file", Some("firefox"))?;
|
|
|
|
// Reveal a path with the system's default explorer
|
|
opener.reveal_item_in_dir("/path/to/file")?;
|
|
|
|
// Reveal multiple paths with the system's default explorer
|
|
opener.reveal_items_in_dir(["/path/to/file"])?;
|
|
Ok(())
|
|
})
|
|
.run(tauri::generate_context!())
|
|
.expect("error while running tauri application");
|
|
}
|
|
```
|
|
|
|
## 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/v2/.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.
|