egui_tool_windows 0.1.0

Floating tool windows for egui that can be used in containers, like resize, scroll-area, frame, etc.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

<div align="center">

[![Build Status](https://github.com/makerpnp/egui_tool_windows/workflows/Rust/badge.svg)](https://github.com/makerpnp/egui_tool_windows/actions/workflows/rust.yml)
[![Discord](https://img.shields.io/discord/1255867192503832688?label=MakerPnP%20discord&color=%2332c955)](https://discord.gg/ffwj5rKZuf)
[![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UClzmlBRrChCJCXkY2h9GhBQ?style=flat&color=%2332c955)](https://www.youtube.com/channel/UClzmlBRrChCJCXkY2h9GhBQ?sub_confirmation=1)
[![MakerPnP GitHub Organization's stars](https://img.shields.io/github/stars/makerpnp?style=flat&color=%2332c955)](https://github.com/MakerPnP)
[![Donate via Ko-Fi](https://img.shields.io/badge/Ko--Fi-Donate-green?style=flat&color=%2332c955&logo=ko-fi)](https://ko-fi.com/dominicclifton)
[![Subscribe on Patreon](https://img.shields.io/badge/Patreon-Subscribe-green?style=flat&color=%2332c955&logo=patreon)](https://www.patreon.com/MakerPnP)

</div>

# egui_tool_windows


Floating tool windows for egui that can be used in containers, like resize, scroll-area, frame, etc.

* Simple API for adding multiple windows inside a container.
* Independent z-ordering, when clicked they are sent to the front.
* Collapsible.
* Resizable.
* Draggable.
* Floats on top of content.
* Constrained to the container.
* Clipped to the container.
* Tool windows are moved if the container is resized too small.

Regular egui::Window and egui::Area instances can be placed above them, they do no clash.

## Basic API usage


```rust
egui::ScrollArea::both()
    .auto_shrink([false, false])
    .scroll_bar_visibility(ScrollBarVisibility::AlwaysVisible)
    .show(ui, |ui|{

        ui.strong("Content inside a frame");
        
        ToolWindows::new()
            .windows(ui, |builder|{
                builder
                    .add_window("id_salt_1")
                    .show("Title 1".to_string(), |ui| {
                        ui.label("Tool window 1");
                    });

                builder
                    .add_window("id_salt_2")
                    .show("Title 2".to_string(), {
                        ui.label("Tool window 2");
                    });
            });
    });
```

You can call `ToolWindows::new()` as many times as you like, e.g. if you have multiple containers that each need their
own tool windows. 

## Status


This crate is work-in-progress, but usable, see below.

## Limitations


* The goal is to allow them to be used *inside* `egui::Area` and `egui::Window` instances, and by extension, with `egui_dock`
  windows that but this doesn't work, yet.  The content is present, but obscured.
* If one window obscures another, hovering of elements in the obscured window 'bleeds-though'.  e.g. if there's a table 
 with resizable columns obscured by another tool window, when you hover over the obscured column divider the mouse
 pointer changes and allows obscured columns to be resized, when it should not.

So currently, if what you want to put in tool windows isn't affected by the current limitations, then this is usable
right now for you.

Once the above issues are solved more attention will be given to additional planned features such as:
* additional API methods. 
* persistence.

## Demos


The crate contains 2 demos.

* `simple` - shows the current state and behavior of the tool windows when used in a container.
* `inside_windows` - attempts to use the tool windows inside `egui::Window` instances - doesn't currently work correctly.

Refer to the `demos` folder.

## Screenshot


Here's a recent screenshot of the `simple` demo:

[<img src="assets/screenshots/screenshot_2025-06-27_195402.png" width="800" alt="egui_tool_windows">](assets/screenshots/screenshot_2025-06-27_195402.png)

## License


Available under APACHE *or* MIT licenses.

* [APACHE](LICENSE-APACHE)
* [MIT](LICENSE-MIT)

## Authors


* Dominic Clifton - Project founder and primary maintainer.

## Timeline


2025/06/27 - Crate created!

## Links


* Patreon: https://www.patreon.com/MakerPnP
* Github: https://github.com/MakerPnP
* Discord: https://discord.gg/ffwj5rKZuf
* YouTube: https://www.youtube.com/@MakerPnP
* X/Twitter: https://x.com/MakerPicknPlace

## Contributing


If you'd like to contribute, please raise an issue or a PR on the github issue tracker, work-in-progress PRs are fine
to let us know you're working on something, and/or visit the discord server.  See the ![Links](#links) section above.