diff --git a/plugins/opener/README.md b/plugins/opener/README.md index 82d0fea1..d95d6039 100644 --- a/plugins/opener/README.md +++ b/plugins/opener/README.md @@ -70,7 +70,41 @@ 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() + .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"); + }) + .plugin(tauri_plugin_opener::init()) + .run(tauri::generate_context!()) + .expect("error while running tauri application"); +} ``` ## Contributing diff --git a/plugins/opener/guest-js/index.ts b/plugins/opener/guest-js/index.ts index 0d92596b..ade956a6 100644 --- a/plugins/opener/guest-js/index.ts +++ b/plugins/opener/guest-js/index.ts @@ -71,7 +71,7 @@ export async function openPath(path: string, openWith?: string): Promise { } /** - * Reveal a path the system's default explorer. + * Reveal a path with the system's default explorer. * * #### Platform-specific: *