Struct egui::containers::panel::TopBottomPanel

pub struct TopBottomPanel { /* private fields */ }

A panel that covers the entire top or bottom of a Ui or screen.

The order in which you add panels matter! The first panel you add will always be the outermost, and the last you add will always be the innermost.

⚠ Always add any CentralPanel last.

See the module level docs for more details.

egui::TopBottomPanel::top("my_panel").show(ctx, |ui| {
   ui.label("Hello World!");
});

See also SidePanel.

Implementations

impl TopBottomPanel

pub fn top(id_source: impl Hash) -> Self

id_source: Something unique, e.g. "my_top_panel".

pub fn bottom(id_source: impl Hash) -> Self

id_source: Something unique, e.g. "my_bottom_panel".

pub fn new(side: TopBottomSide, id_source: impl Hash) -> Self

id_source: Something unique, e.g. "my_panel".

pub fn resizable(self, resizable: bool) -> Self

Can panel be resized by dragging the edge of it?

Default is false.

If you want your panel to be resizable you also need a widget in it that takes up more space as you resize it, such as:

• Wrapping text (Ui::horizontal_wrapped).
• A ScrollArea.
• A Separator.
• A TextEdit.
• …

pub fn default_height(self, default_height: f32) -> Self

The initial height of the SidePanel. Defaults to style::Spacing::interact_size.y.

pub fn min_height(self, min_height: f32) -> Self

pub fn max_height(self, max_height: f32) -> Self

pub fn height_range(self, height_range: RangeInclusive<f32>) -> Self

The allowable height range for resizable panels.

pub fn frame(self, frame: Frame) -> Self

Change the background color, margins, etc.

impl TopBottomPanel

pub fn show_inside<R>(
    self,
    ui: &mut Ui,
    add_contents: impl FnOnce(&mut Ui) -> R
) -> InnerResponse<R>

Show the panel inside a Ui.

pub fn show<R>(
    self,
    ctx: &Context,
    add_contents: impl FnOnce(&mut Ui) -> R
) -> InnerResponse<R>

Show the panel at the top level.