Struct TabStrip

pub struct TabStrip<Msg: Clone> { /* private fields */ }

The open documents, as a strip on a desktop and a bar on a phone.

On a desktop, a strip of tabs with their icon, title and close button, sharing the width between a minimum and a part of the screen and scrolling sideways when even the minimum does not fit; buttons may go before the tabs, right after the last one and at the far right, and part of the width is always left clear. On a phone, a bar with the active tab and a counter that asks for the TabOverview, a grid of cards of every tab.

The widget is stateless but for its TabMotion, which the app keeps so tabs grow, shrink and slide as they open and close:

tab_strip( self.titles.iter().map( |( key, title )| tab( *key, title.clone() ).symbol( "features/console" ) ) )
    .selected( self.active )
    .on_select( Msg::Select )
    .on_close( Msg::Close )
    .on_overview( Msg::Overview )
    .layout( if self.phone { TabLayout::Mobile } else { TabLayout::Desktop } )
    .motion( &self.motion )
    .into()

Implementations

impl<Msg: Clone + 'static> TabStrip<Msg>

pub fn new(tabs: impl IntoIterator<Item = TabItem>) -> Self

pub fn selected(self, idx: usize) -> Self

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

Called with the index of the tab pressed.

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

Called with the index of the tab whose close button was pressed.

pub fn on_overview(self, msg: Msg) -> Self

The message the phone bar’s counter sends, to show the TabOverview. Without it the bar has no counter.

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

Whether the desktop strip’s tabs can be dragged into another order; the app forwards the drag to the TabMotion and moves the tab TabMotion::drag_end reports. Dragging a tab selects it. Default: false.

pub fn leading(self, button: impl Into<Element<Msg>>) -> Self

A button at the far left, before the tabs; also at the left of the phone bar.

pub fn after_tabs(self, button: impl Into<Element<Msg>>) -> Self

A button right after the last tab, such as a new tab button. Not on the phone bar: the overview’s header has those.

pub fn trailing(self, button: impl Into<Element<Msg>>) -> Self

A button at the far right; also at the right of the phone bar.

pub fn mobile_center(self, center: impl Into<Element<Msg>>) -> Self

What the phone bar shows in place of the active tab’s icon and title, such as an address field.

pub fn colors(self, colors: TabStripColors) -> Self

pub fn layout(self, layout: TabLayout) -> Self

pub fn motion(self, motion: &TabMotion) -> Self

The animation state the app keeps; without it the tabs do not animate.

pub fn build(self) -> Element<Msg>

Trait Implementations

impl<Msg: Clone + 'static> From<TabStrip<Msg>> for Element<Msg>

fn from(strip: TabStrip<Msg>) -> Self

Converts to this type from the input type.