djkato/egui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: explain auto-shrinking panels/windows and how to work around it

Browse source 
related to https://github.com/emilk/egui/issues/696
This commit is contained in:
Emil Ernerfeldt 2021-09-05 09:40:25 +02:00
parent 14c989fdfa
commit d9f3596475
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
egui/src/lib.rs
View file

@ -202,6 +202,31 @@
//! } //! }
//! ``` //! ```
//! //!
//! ## Auto-sizing panels and windows
//! In egui, all panels and windows auto-shrink to fit the content.
//! If the window or panel is also resizable, this can lead to a weird behavior
//! where you can drag the edge of the panel/window to make it larger, and
//! when you release the panel/window shrinks again.
//! This is an artifact of immediate mode, and here are some alternatives on how to avoid it:
//!
//! 1. Turn of resizing with [`Window::resizable`], [`SidePanel::resizable`], [`TopBottomPanel::resizable`].
//! 2. Wrap your panel contents in a [`ScrollArea`], or use [`Window::vscroll`] and [`Window::hscroll`].
//! 3. Use a justified layout:
//!
//! ``` rust
//! # let ui = &mut egui::Ui::__test();
//! ui.with_layout(egui::Layout::top_down_justified(egui::Align::Center), |ui| {
//! ui.button("I am becoming wider as needed");
//! });
//! ```
//!
//! 4. Fill in extra space with emptiness:
//!
//! ``` rust
//! # let ui = &mut egui::Ui::__test();
//! ui.allocate_space(ui.available_size()); // put this LAST in your panel/window code
//! ```
//!
//! ## Sizes //! ## Sizes
//! You can control the size of widgets using [`Ui::add_sized`]. //! You can control the size of widgets using [`Ui::add_sized`].
//! //!