Swizzle Tauri's NSWindow to 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" }
Usage
- 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");
}
- To swizzle a window's
NSWindowtoNSPanel, use theto_panel()method:
use tauri_nspanel::WindowExt;
// ...
let panel = window.to_panel().unwrap();
The window will be swizzled to NSPanel.
Only call the
to_panel()method once on a window.
- To access your panels, use the
app_handle.get_panel("label"):
use tauri_nspanel::ManagerExt;
// ...
let my_panel = app_handle.get_panel("main");
- To respond to panel events, such as resizing, moving, exposing, and minimizing (See the exhaustive list), you need to setup a
NSWindowDelegatefor your panel.
Use the panel_delegate!() macro to do this:
use tauri::Wry;
use tauri_nspanel::{objc_id::Id, panel_delegate, ManagerExt, Panel, WindowExt};
// ...
// Define your handlers
// See, https://developer.apple.com/documentation/appkit/nswindowdelegate?language=objc
// for an exhaustive list of handlers.
//
// Example: to respond to windowWillBeginSheet:
// declare the function in snake case:
// fn window_will_begin_sheet(_: Panel<Wry>) { }
fn window_did_become_key(panel: Panel<Wry>) {
let app_name = panel.app_handle().unwrap().package_info().name.to_owned();
println!("[info]: {:?} panel becomes key window!", app_name);
}
fn window_did_resign_key(_: Panel<Wry>) {
println!("[info]: panel resigned from key window!");
}
// Use the `panel_delegate!()` macro to create your custom delegate
let delegate = panel_delegate!(MyPanelDelegate<Wry> {
window_did_become_key,
window_did_resign_key
});
// Give the delegate a reference to your panel
delegate.set_panel(panel.to_owned());
// Set your panel's delegate
panel.set_delegate(delegate);
- Simply calling the
.close()method on your NSPanel instance may not be sufficient to fully release its resources. This is because, by default,NSPanelsare 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();
- For more information on panel methods, please refer to the documentation page.
Related
The following are projects related to this plugin:
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.
25 Jan 9, 2023
5 Dec 6, 2022
8 Dec 19, 2022
732 Jan 5, 2023
12 Jan 25, 2023
5 Feb 28, 2023
6 Apr 5, 2023
13 Apr 1, 2023
22 Mar 19, 2023
899 Jan 1, 2023
4 Nov 21, 2021
42 Jan 5, 2023
94 Jan 2, 2023
28 Dec 7, 2022
54 Dec 23, 2022
14 Oct 25, 2022
6 Oct 27, 2022