A Textual widget for a floating, draggable window and included window bar/manager system.
Project description
Textual-Window
Textual-Window is an extension library for Textual.
It provides a Window widget, along with an included WindowBar and WindowSwitcher, that makes it extremely easy to create a desktop GUI-like experience inside of a TUI built with Textual.
Window widgets are floating, draggable, resizable, snappable, closable, and you can even cycle through them in a manner similar to alt-tab. It's like a mini desktop inside of your terminal. (Is it ridiculous? Yes, yes it is. But is it awesome? Also yes.)
Features
- Drag, resize, and maximize windows. Close windows with ctrl+w.
- Windows can focus, and highlight to show which one is focused. Controls are passed from the highlighted window to its inner scrolling container.
- Included fully-automatic Window Bar (aka Task Bar). Don't worry about keeping track of the windows. Just compose and go. The library will track them for you.
- Included Window Switcher, to cycle window focus in a manner similar to alt-tab. The most recently focused window is always at the start (left side).
- Set the window's min and max size through Textual CSS as you normally would, and the window will respect those settings when resizing. Resizing can also be disabled per window.
- Windows snap to the terminal by default, toggle this on/off in real-time.
- WindowBar can toggle the dock between top and bottom of the screen in real-time.
- Window Bar has right-click context menus, one for each window, as well as a global context menu with options such as close/open all or snap/unsnap all.
- Set the window's starting location on the screen using plain descriptions (ie. right + bottom), as well as whether to initialize open or closed.
- An optional hamburger menu for custom callbacks - The window has a 'menu_options' argument. Pass in a dictionary of functions (label + callback) and these functions will appear in that window's hamburger menu. (If nothing is passed in, the menu is not shown).
- Smooth fade in/out animation adds a convincing touch.
- Create windows in all 3 ways textual supports - context manager, passing in a list of children, and custom Window objects.
- ...and many small QoL things too numerous to list here.
See the documentation for more details.
Demo App
If you have uv or Pipx, you can immediately try the demo app:
uvx textual-window
pipx textual-window
Documentation
Click here for documentation
Questions, issues, suggestions?
Feel free to post an issue.
Video
https://github.com/user-attachments/assets/3d0e21a6-bb95-4adf-afc9-6bb3792215a5
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file textual_window-0.3.1.tar.gz.
File metadata
- Download URL: textual_window-0.3.1.tar.gz
- Upload date:
- Size: 92.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dbe1ba2d2d181b71af3138e0008b74484d97d3c1f943a6b87ca554d7186d389d
|
|
| MD5 |
32c52b077f387bfbce01051d9201184d
|
|
| BLAKE2b-256 |
b0fcf593aa7242fea396d2a4ffd4c13608d58af7df4e97ad2b5f16486e0e9318
|
File details
Details for the file textual_window-0.3.1-py3-none-any.whl.
File metadata
- Download URL: textual_window-0.3.1-py3-none-any.whl
- Upload date:
- Size: 26.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d8d6b5a5e94db406d3487995eb054d9f45d74c223427f4fe28ffeca523ed002
|
|
| MD5 |
26a21d7900df718bf03407b47da8933b
|
|
| BLAKE2b-256 |
8deec5dba044a73725079a0d6c13b9bdf7ab62d9c8adcce7ba02ee10904dbb88
|