Struct DockRail 

pub struct DockRail { /* private fields */ }

App-facing configuration for a side’s activity rail (Rail presentation).

Pass to DockingLayout::rail. All knobs are optional; an unconfigured rail uses IconButtonSize::Large items, no slots, and no overflow affordance (items just clip if the side is too short).

Implementations

impl DockRail

pub fn new(side: DockSide) -> Self

Configure the rail for side.

pub fn size(self, size: IconButtonSize) -> Self

Pick one size for every rail item (IconButtonSize::Compact … Hero). Default IconButtonSize::Large.

pub fn background(self, color: impl Into<ColorProp>) -> Self

Override the rail strip’s background. Accepts Color, a [SurfaceRole], or a Signal<Color>. Default (unset) is SurfaceRole::Sunken.

pub fn divider(self) -> Self

Draw a 1 dp divider line between the rail and the side’s content, on the rail’s content-facing edge (RTL-aware). Uses BorderRole::Divider. Off by default. See divider_color for a custom colour.

pub fn divider_color(self, color: impl Into<ColorProp>) -> Self

Like divider, but with an explicit colour. Accepts Color, a [BorderRole], or a Signal<Color>.

pub fn top_slot<W: Widget + 'static>(self, f: impl Fn() -> W + 'static) -> Self

Widget pinned above the items (e.g. a logo / hamburger). To track the rail’s item size, bind DockingModel::rail_size_mode_signal inside the factory.

pub fn bottom_slot<W: Widget + 'static>( self, f: impl Fn() -> W + 'static, ) -> Self

Widget pinned at the bottom of the rail (e.g. settings / account). To track the rail’s item size, bind DockingModel::rail_size_mode_signal inside the factory.

pub fn leading_slot<W: Widget + 'static>( self, f: impl Fn() -> W + 'static, ) -> Self

Widget pinned at the start of this side’s Strip-presentation tab bar (via TabWidget::bar_leading_slot). The Rail-presentation counterpart is top_slot.

Weaker contract than top_slot. top_slot/bottom_slot sit on the DockActivityBar, which is built whenever the side has a rail — they survive the side being collapsed. leading_slot/trailing_slot sit inside the side’s TabWidget, which lives within the collapsing SideClipPane, so they disappear with the content when the side is hidden. If your content must survive a hidden side, use Rail presentation, or host it outside the docking system.

pub fn trailing_slot<W: Widget + 'static>( self, f: impl Fn() -> W + 'static, ) -> Self

Widget pinned at the end of this side’s Strip-presentation tab bar. Composed before the side’s own “hidden activities” hamburger when both are present, so neither is dropped. See leading_slot for the visibility contract.

pub fn action(self, action: DockAction) -> Self

Append a dockless command button to this side’s rail. Declaration order is render order within a placement. See DockAction.

Rail presentation only. A side in TabPresentation::Strip renders no actions at all — and set_side_rail can flip presentation at runtime, so a side that flips Rail → Strip drops its whole action cluster. If that is reachable in your app, mirror the cluster with trailing_slot, which the same DockRail can carry alongside its actions.

pub fn overflow_icon(self, f: impl Fn() -> IconWidget + 'static) -> Self

Choose the glyph for the overflow trigger — the item shown (in place of the surplus items) when they don’t all fit. Tapping it opens a popover list of the overflowed entries.

Trait Implementations

impl Clone for DockRail

fn clone(&self) -> DockRail

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DockRail

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.