Skip to main content

Rail

Struct Rail 

Source
pub struct Rail { /* private fields */ }
Expand description

Rail — a compact, always-icon-only vertical navigation strip.

Where a collapsed Sidebar is a temporary icon view of a labelled panel, a Rail is a permanent slim bar (think a VS Code activity bar or a Material navigation rail). Labels always live in hover tooltips. Items added after footer are pinned to the bottom of the rail.

let clicked = sc::Rail::new("rail")
    .selected(self.page)
    .show(ui, |r| {
        r.item(sc::IconKind::Home, "Home");        // 0
        r.item(sc::IconKind::Search, "Explore");   // 1
        r.footer();                                // pin the rest to the bottom
        r.item(sc::IconKind::Settings, "Settings"); // 2
    });
if let Some(i) = clicked { self.page = i; }

Implementations§

Source§

impl Rail

Source

pub fn new(_id_salt: impl Hash) -> Self

Source

pub fn width(self, w: f32) -> Self

Source

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

Source

pub fn show(self, ui: &mut Ui, build: impl FnOnce(&mut RailUi)) -> Option<usize>

Trait Implementations§

Source§

impl Default for Rail

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Rail

§

impl RefUnwindSafe for Rail

§

impl Send for Rail

§

impl Sync for Rail

§

impl Unpin for Rail

§

impl UnsafeUnpin for Rail

§

impl UnwindSafe for Rail

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,