Skip to content

Latest commit

 

History

History
127 lines (86 loc) · 3.86 KB

README.md

File metadata and controls

127 lines (86 loc) · 3.86 KB
Raw

Convert a Tauri WebviewWindow (NSWindow) to panel (NSPanel)

Install

There are three general methods of installation that we can recommend.

  • Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
  • Pull sources directly from Github using git tags / revision hashes (most secure)
  • 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 plugin by adding the following to your Cargo.toml file:

[dependencies]
tauri-nspanel = { git = "https://github.com/ahkohd/tauri-nspanel", branch = "v2" }

Usage

  1. First you need to register the core plugin with Tauri:

src-tauri/src/main.rs

fn main() {
    tauri::Builder::default()
        .plugin(tauri_nspanel::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}
  1. To swizzle a window's NSWindow to NSPanel, use the to_panel() method:
use tauri_nspanel::WebviewWindowExt;

// ...
let panel = window.to_panel().unwrap();

The window will be swizzled to NSPanel.

Only call the to_panel() method once on a webview window.

  1. To access your panels, use the app_handle.get_webview_panel("label"):
use tauri_nspanel::ManagerExt;

// ...

let my_panel = app_handle.get_webview_panel("main");
  1. To respond to panel events, such as resizing, moving, exposing, and minimizing (See the exhaustive list), you need to setup a NSWindowDelegate for your panel.

Use the panel_delegate!() macro to do this:

use tauri::Wry;
use tauri_nspanel::{objc_id::Id, panel_delegate, ManagerExt, Panel, WindowExt};

// ...
// Use the `panel_delegate!()` macro to create your custom delegate

// Specify your handlers
// See, https://developer.apple.com/documentation/appkit/nswindowdelegate?language=objc
// for an exhaustive list of handlers.
//
// Example: to respond to windowDidBecomeKey:
// specify in snake case: window_did_become_key

let delegate = panel_delegate!(MyPanelDelegate {
  window_did_become_key,
  window_did_resign_key
});

// Listen to when a delegate is called
delegate.set_listener(Box::new(|delegate_name: String| {
    println!("{} was called!", delegate_name);
}));

// Set your panel's delegate
panel.set_delegate(delegate);
  1. Simply calling the .close() method on your NSPanel instance may not be sufficient to fully release its resources. This is because, by default, NSPanels are not released when they are closed. This is because NSPanels are often lightweight and designed for reuse.

To ensure that your NSPanel is fully released:

// ...

panel.released_when_closed(true);
panel.close();
  1. For more information on panel methods, please refer to the documentation page.

Related

The following are projects related to this plugin:

Showcase

Here are some projects using tauri-nspanel

Contributing

PRs accepted. Please make sure to read the Contributing Guide before making a pull request.

License

MIT or MIT/Apache 2.0 where applicable.