mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-04-21 11:26:15 +02:00
docs(opener): add basic usage guide to readme (#2167)
* docs(opener): add basic usage guide to readme * Add missing `Ok(())` and `?` * Register plugin first
This commit is contained in:
@@ -70,7 +70,42 @@ fn main() {
|
||||
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')
|
||||
```
|
||||
|
||||
### 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();
|
||||
opener.open_url("https://example.com", Some("firefox"))?;
|
||||
opener.open_path("/path/to/file", Some("firefox"))?;
|
||||
opener.reveal_item_in_dir("/path/to/file")?;
|
||||
Ok(())
|
||||
})
|
||||
.run(tauri::generate_context!())
|
||||
.expect("error while running tauri application");
|
||||
}
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
@@ -71,7 +71,7 @@ export async function openPath(path: string, openWith?: string): Promise<void> {
|
||||
}
|
||||
|
||||
/**
|
||||
* Reveal a path the system's default explorer.
|
||||
* Reveal a path with the system's default explorer.
|
||||
*
|
||||
* #### Platform-specific:
|
||||
*
|
||||
|
||||
@@ -128,6 +128,7 @@ fn main() {
|
||||
// Note that values must be serde_json::Value instances,
|
||||
// otherwise, they will not be compatible with the JavaScript bindings.
|
||||
store.set("a".to_string(), json!("b"));
|
||||
Ok(())
|
||||
})
|
||||
.run(tauri::generate_context!())
|
||||
.expect("error while running tauri application");
|
||||
|
||||
Reference in New Issue
Block a user