Struct egui::containers::panel::SidePanel

pub struct SidePanel { /* private fields */ }

A panel that covers the entire left or right side 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::SidePanel::left("my_left_panel").show(ctx, |ui| {
   ui.label("Hello World!");
});

See also TopBottomPanel.

Implementations

impl SidePanel

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

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

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

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

pub fn new(side: Side, 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 true.

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_width(self, default_width: f32) -> Self

The initial wrapping width of the SidePanel.

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

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

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

The allowable width range for resizable panels.

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

Change the background color, margins, etc.

impl SidePanel

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.