Struct WidgetDock 

pub struct WidgetDock<Msg> { /* private fields */ }

A vertical stack of titled widgets filling the area it is given, like the side panel of an IDE: each widget opens and closes, and open widgets share the height between them.

Add one child per widget with View::add_with, in the order they are shown. A widget that wants less than its share keeps its natural height; a taller one, such as a List, gets an even share of what is left and scrolls inside it. The application owns the order and the open state, so both can be saved and restored: WidgetDock::on_toggle and WidgetDock::on_move report changes.

With on_move, dragging a title picks the widget up: its title follows the pointer as a ghost and a tinted row shows where it will land. Keys while focused: ↑/↓, Home/End move between titles, Enter or Space opens or closes, Ctrl+Shift+↑/↓ moves the widget.

Style keys are those of Accordion plus section-title.ghost for the dragged title, section-drop (bg) for the landing row and section-empty (fg).

Implementations

impl<Msg: 'static> WidgetDock<Msg>

pub fn new(sections: impl IntoIterator<Item = impl Into<Section>>) -> Self

A dock of sections in this order, all closed.

pub fn open(self, open: impl IntoIterator<Item = bool>) -> Self

Which widgets are open; open[i] for widget i, missing entries are closed.

pub fn on_toggle(self, message: impl Fn(usize, bool) -> Msg + 'static) -> Self

Message for opening (true) or closing (false) widget index.

pub fn on_move(self, message: impl Fn(usize, usize) -> Msg + 'static) -> Self

Lets the user reorder widgets. The message carries the widget’s index and the index it should have afterwards: remove it at from, then insert it at to.

pub fn empty_text(self, text: impl Into<String>) -> Self

Text shown when the dock has no widgets.

Trait Implementations

impl<Msg: 'static> Container<Msg> for WidgetDock<Msg>

fn set_children(&mut self, children: Vec<Node<Msg>>)

Receives the children built for this widget.

impl<Msg: 'static> Widget<Msg> for WidgetDock<Msg>

fn measure(&self, cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.