Struct PaneScaffold 

pub struct PaneScaffold<K: Clone + PartialEq + 'static> { /* private fields */ }

A list-detail or supporting pane layout around caller-owned panes.

Panes adapt to the scaffold’s own width, so a layout inside a navigation suite adapts to the room it has. Give it a definite height. Each pane scrolls on its own, and focus follows the destination and returns on back.

The navigator is controlled: call its navigate_to and navigate_back in your handlers, and notify its entity.

Implementations

impl<K: Clone + PartialEq + 'static> PaneScaffold<K>

pub fn list_detail( id: impl Into<ElementId>, navigator: &Entity<PaneNavigator<K>>, ) -> Self

A list-detail layout: list, detail, then the optional extra pane.

pub fn supporting_pane( id: impl Into<ElementId>, navigator: &Entity<PaneNavigator<K>>, ) -> Self

A supporting pane layout: main, supporting, then the optional extra pane.

pub fn pane( self, role: PaneRole, label: impl Into<SharedString>, content: impl IntoElement, ) -> Self

Supply a pane; label names its region for assistive technology.

pub fn rule(self, rule: PaneRule) -> Self

How many panes may sit side by side.

pub fn size_class(self, size_class: Option<WindowSizeClass>) -> Self

Classify this size instead of the scaffold’s own, for a layout shown smaller than the window it stands for, as previews are. None reads the scaffold’s width.

pub fn preferred_width(self, role: PaneRole, width: f32) -> Self

A pane’s preferred width in dp, overriding the directive’s.

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

Mirror the pane order for a right-to-left language.

pub fn drag_handle(self, label: impl Into<SharedString>) -> Self

Show a drag handle between two panes; label is its accessible name. It takes a drag, the arrows, Home, End, and Enter for the next anchor.

pub fn anchors(self, anchors: impl IntoIterator<Item = PaneAnchor>) -> Self

The positions the handle settles at.

Trait Implementations

impl<K: Clone + PartialEq + 'static> IntoElement for PaneScaffold<K>

type Element = ViewElement<PaneScaffold<K>>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements [Element].

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed [AnyElement].

impl<K: Clone + PartialEq + 'static> RenderOnce for PaneScaffold<K>

fn render(self, _: &mut Window, _: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to [Render::render()] method which takes a mutable reference.