Release 0.17 (#281)

* Updates to `TabViewer::{is_closable,on_close}`.

* Update crate version

* feat: add on_rect_changed callback and example for dock state (#265)

* feat: add on_rect_changed callback to TabViewer

This commit introduces the `on_rect_changed` callback to the `TabViewer` trait.

This callback is triggered whenever the rectangle of a tab's content changes, allowing tabs to adjust their content based on the available space. This is particularly useful when the window is resized, panels are docked or undocked, or when the dock area layout changes.

* feat: add example for saving and loading dock state

This commit adds a new example that demonstrates how to save and load the dock state to a JSON file.

This allows users to persist their preferred layout across sessions.

* Make sure `TabViewer::on_close` is always called when the user tries to close the tab (#266)

* Use close_tab_bg_fill for close buttons (#268)

* Add more QOL methods to ``DockState``, and change the structure of ``Node`` (#272)

* new concrete types for ``Node``

created ``LeafNode`` and ``SplitNode`` types.

* add documentation, get rid of errors

* adding ``iter_leaves``, ``iter_leaves_mut``, and cleaning up some code

* cargo fmt

* implement ``Index<NodeIndex>`` for ``Surface``

* fixed tests, overall improved docs

* added ``is_empty`` method to ``LeafNode`` in accordance with clippy tests

* run ``cargo fmt``

* Update CHANGELOG.md

* A few minor stylistic changes

* Test fix #1

---------

Co-authored-by: Adanos020 <adanos020@gmail.com>

* Prevent `DockState::retain_tabs` from deleting main surface (#277)

* Add another failing unit test

* Don't delete the main surface

* Just-in-time patching of surfaces

* Update changelog for #277

* Add inner_margin and spacing to tab bar style (#270)

* Add inner_margin to TabBarStyle

* Add tab_spacing to TabStyle

* Update changelog following #270

* Fix `retain_tabs` behavior with `Empty` nodes in the list (#275)

* Add failing unit test

* Add two fixes

* Update to egui 0.32 (#280)

* Update popup.rs

update to egui main

* Remove deprecated calls, and call `Memory::keep_popup_open`

* Update to egui 0.32

- this does *not* update to use the new Popup API

* Fix compiler errors and Clippy warnings. Retire widgets/popup.rs as it's now entirely replaced by `egui::Popup`.

---------

Co-authored-by: Adam Gąsior <adanos020@gmail.com>

* Update changelog following #275

* Update readme

---------

Co-authored-by: DEV×PAIN <170700110+devxpain@users.noreply.github.com>
Co-authored-by: Avarel <antranprm@gmail.com>
Co-authored-by: Vikrinox <51887867+Vickerinox@users.noreply.github.com>
Co-authored-by: Matt Keeter <matt.j.keeter@gmail.com>
Co-authored-by: Jengamon <bob.hostern@gmail.com>

Author: 6 people

CHANGELOG.md

@@ -1,5 +1,59 @@
 # egui_dock changelog
 
+## egui_dock 0.17.0 - 2025/07/13
+
+### Breaking changes
+
+- From ([#272](https://github.com/Adanos020/egui_dock/pull/272)):
+    - `Node`s underlying data has been split up into the `LeafNode` and `SplitNode` types, meaning that any match
+      statements carried out on a node now needs to account for this.
+- Upgraded to egui 0.32 ([#280](https://github.com/Adanos020/egui_dock/pull/280/))
+
+### Changed
+
+- From ([#272](https://github.com/Adanos020/egui_dock/pull/272)):
+    - `Tree::set_active_tab` now takes `impl Into<NodeIndex>` and `impl Into<TabIndex>` to make use slightly easier.
+    - `Surface` now implements `Index<NodeIndex>`/`IndexMut<NodeIndex>` which tries to access the surfaces node tree and
+      the node at the index. This will always panic when used on an empty surface as they do not have a node tree nor
+      nodes.
+
+### Added
+
+- From ([#272](https://github.com/Adanos020/egui_dock/pull/272)):
+    - `DockState::iter_leaves` and `DockState::iter_leaves_mut` - can be used to more efficiently iterate over leaf
+      nodes without needing to "unwrap" them from the `Node` enum.
+    - `DockState::find_tab_from`/`Tree::find_tab_from` - a more generalized version of the existing `find_tab` methods
+      which doesn't require the tab type to implement `PartialEq`.
+    - New type `LeafNode` which contains leaf node data and has the following methods:
+        * `new`,
+        * `set_active_tab`,
+        * `set_rect`,
+        * `rect`,
+        * `len`,
+        * `is_empty`,
+        * `tabs`,
+        * `tabs_mut`,
+        * `append_tab`,
+        * `insert_tab`,
+        * `remove_tab`,
+        * `retain_tabs`,
+        * `active_focused`.
+    - New type `SplitNode` which contains data about node splits and has the following methods:
+        * `new`,
+        * `set_rect`,
+        * `rect`.
+    - `Node::get_leaf`/`Node::get_leaf_mut` - an alternative way of trying to access leaf data in a node.
+- `TabBarStyle` now has two new fields: `inner_margin` and
+  `spacing`. ([#270](https://github.com/Adanos020/egui_dock/pull/270))
+
+### Fixed
+
+- `DockState::retain_tabs` no longer deletes the main surface if it ends up
+  empty ([#277](https://github.com/Adanos020/egui_dock/pull/277)).
+- From [#275](https://github.com/Adanos020/egui_dock/pull/275):
+    - `{DockState,Tree}::remove_leaf` now removes unused empty node`s at the back of the tree.
+    - `{DockState,Tree}::retain_tabs` no longer deletes leaf nodes it shouldn't delete.
+
 ## egui_dock 0.16.0 - 2025-02-07
 
 ### Breaking changes

Cargo.toml

@@ -2,9 +2,9 @@
 name = "egui_dock"
 description = "Docking system for egui - an immediate-mode GUI library for Rust"
 authors = ["lain-dono", "Adam Gąsior (Adanos020)"]
-version = "0.16.0"
+version = "0.17.0"
 edition = "2021"
-rust-version = "1.81"
+rust-version = "1.85"
 license = "MIT"
 readme = "README.md"
 repository = "https://github.com/Adanos020/egui_dock"
@@ -18,15 +18,20 @@ default = []
 serde = ["dep:serde", "egui/serde"]
 
 [dependencies]
-egui = { version = "0.31", default-features = false }
+egui = { version = "0.32", default-features = false }
 serde = { version = "1", optional = true, features = ["derive"] }
 
 duplicate = "2.0"
 paste = "1.0"
 
 [dev-dependencies]
-eframe = { version = "0.31", default-features = false, features = [
+eframe = { version = "0.32", default-features = false, features = [
     "default",
     "default_fonts",
     "glow",
 ] }
+serde_json = { version = "1" }
+
+[[example]]
+name = "save_load_dock_state"
+required-features = ["serde"]

README.md

@@ -3,7 +3,7 @@
 [![github](https://img.shields.io/badge/github-Adanos020/egui_dock-8da0cb?logo=github)](https://github.com/Adanos020/egui_dock)
 [![crates.io](https://img.shields.io/crates/v/egui_dock)](https://crates.io/crates/egui_dock)
 [![docs.rs](https://img.shields.io/docsrs/egui_dock)](https://docs.rs/egui_dock/)
-[![egui_version](https://img.shields.io/badge/egui-0.31-blue)](https://github.com/emilk/egui)
+[![egui_version](https://img.shields.io/badge/egui-0.32-blue)](https://github.com/emilk/egui)
 
 Originally created by [@lain-dono](https://github.com/lain-dono), this library provides a docking system for `egui`.
 
@@ -32,8 +32,8 @@ Add `egui` and `egui_dock` to your project's dependencies.
 
 ```toml
 [dependencies]
-egui = "0.31"
-egui_dock = "0.16"
+egui = "0.32"
+egui_dock = "0.17"
 ```
 
 Then proceed by setting up `egui`, following its [quick start guide](https://github.com/emilk/egui#quick-start).

examples/hello.rs

@@ -9,6 +9,7 @@ use egui::{
     WidgetText,
 };
 
+use egui_dock::tab_viewer::OnCloseResponse;
 use egui_dock::{
     AllowedSplits, DockArea, DockState, NodeIndex, OverlayType, Style, SurfaceIndex,
     TabInteractionStyle, TabViewer,
@@ -119,13 +120,13 @@ impl TabViewer for MyContext {
         }
     }
 
-    fn closeable(&mut self, tab: &mut Self::Tab) -> bool {
+    fn is_closeable(&self, tab: &Self::Tab) -> bool {
         ["Inspector", "Style Editor"].contains(&tab.as_str())
     }
 
-    fn on_close(&mut self, tab: &mut Self::Tab) -> bool {
+    fn on_close(&mut self, tab: &mut Self::Tab) -> OnCloseResponse {
         self.open_tabs.remove(tab);
-        true
+        OnCloseResponse::Close
     }
 }
 
@@ -277,7 +278,7 @@ impl MyContext {
                         ui.selectable_value(
                             &mut style.buttons.add_tab_align,
                             align,
-                            format!("{:?}", align),
+                            format!("{align:?}"),
                         );
                     }
                 });
@@ -580,7 +581,7 @@ impl Default for MyApp {
 impl eframe::App for MyApp {
     fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
         TopBottomPanel::top("egui_dock::MenuBar").show(ctx, |ui| {
-            egui::menu::bar(ui, |ui| {
+            egui::MenuBar::new().ui(ui, |ui| {
                 ui.menu_button("View", |ui| {
                     // allow certain tabs to be toggled
                     for tab in &["File Browser", "Asset Manager"] {
@@ -596,7 +597,7 @@ impl eframe::App for MyApp {
                                     .push_to_focused_leaf(tab.to_string());
                             }
 
-                            ui.close_menu();
+                            ui.close();
                         }
                     }
                 });

examples/save_load_dock_state.rs

@@ -0,0 +1,88 @@
+#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] // hide console window on Windows in release
+
+use eframe::{egui, NativeOptions};
+use egui_dock::{DockArea, DockState, NodeIndex, Style};
+use std::fs;
+
+const DOCK_STATE_FILE: &str = "target/dock_state.json";
+
+fn main() -> eframe::Result<()> {
+    let options = NativeOptions::default();
+    eframe::run_native(
+        "My egui App",
+        options,
+        Box::new(|_cc| Ok(Box::<MyApp>::default())),
+    )
+}
+
+struct TabViewer {
+    modified: bool,
+}
+
+impl egui_dock::TabViewer for TabViewer {
+    type Tab = String;
+
+    fn title(&mut self, tab: &mut Self::Tab) -> egui::WidgetText {
+        (&*tab).into()
+    }
+
+    fn ui(&mut self, ui: &mut egui::Ui, tab: &mut Self::Tab) {
+        ui.label(format!("Content of {tab}"));
+    }
+
+    fn on_rect_changed(&mut self, _tab: &mut Self::Tab) {
+        self.modified = true
+    }
+}
+
+struct MyApp {
+    tree: DockState<String>,
+}
+
+impl MyApp {
+    fn save_json(&self) {
+        if let Ok(json) = serde_json::to_string(&self.tree) {
+            let _ = fs::write(DOCK_STATE_FILE, json);
+        }
+    }
+
+    fn load_json() -> Option<Self> {
+        fs::read_to_string(DOCK_STATE_FILE)
+            .ok()
+            .and_then(|data| serde_json::from_str(&data).ok())
+            .map(|tree| Self { tree })
+    }
+}
+
+impl Default for MyApp {
+    fn default() -> Self {
+        // Try loading from file, fallback to default layout
+        Self::load_json().unwrap_or_else(|| {
+            let mut tree = DockState::new(vec!["tab1".to_owned(), "tab2".to_owned()]);
+
+            let [a, b] =
+                tree.main_surface_mut()
+                    .split_left(NodeIndex::root(), 0.3, vec!["tab3".to_owned()]);
+            let [_, _] = tree
+                .main_surface_mut()
+                .split_below(a, 0.7, vec!["tab4".to_owned()]);
+            let [_, _] = tree
+                .main_surface_mut()
+                .split_below(b, 0.5, vec!["tab5".to_owned()]);
+
+            Self { tree }
+        })
+    }
+}
+
+impl eframe::App for MyApp {
+    fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
+        let mut tab_viewer = TabViewer { modified: false };
+        DockArea::new(&mut self.tree)
+            .style(Style::from_egui(ctx.style().as_ref()))
+            .show(ctx, &mut tab_viewer);
+        if tab_viewer.modified {
+            self.save_json();
+        }
+    }
+}

examples/simple.rs

@@ -2,6 +2,7 @@
 
 use eframe::{egui, NativeOptions};
 
+use egui_dock::tab_viewer::OnCloseResponse;
 use egui_dock::{DockArea, DockState, NodeIndex, Style};
 
 fn main() -> eframe::Result<()> {
@@ -25,6 +26,11 @@ impl egui_dock::TabViewer for TabViewer {
     fn ui(&mut self, ui: &mut egui::Ui, tab: &mut Self::Tab) {
         ui.label(format!("Content of {tab}"));
     }
+
+    fn on_close(&mut self, _tab: &mut Self::Tab) -> OnCloseResponse {
+        println!("Closed tab: {_tab}");
+        OnCloseResponse::Close
+    }
 }
 
 struct MyApp {