Skip to main content

AppBarView

Struct AppBarView 

Source
pub struct AppBarView<State: 'static> { /* private fields */ }
Expand description

A declarative M3 fixed top app bar. See the module docs.

Implementations§

Source§

impl<State: 'static> AppBarView<State>

Source

pub fn leading(self, leading: impl View<State>) -> Self

Attach a leading slot (typically a nav/back icon button), erased as an AnyView. Tint is the supplied view’s own responsibility — see super’s slot contract.

Source

pub fn actions<M>(self, actions: impl ViewSeq<State, M>) -> Self

Attach trailing action slots, in reading order (the last one sits closest to the trailing edge). Tint is each supplied view’s own responsibility.

Source

pub fn title_view(self, title: impl View<State>) -> Self

Replace the title string with a caller view — upstream’s title widget slot, which takes precedence over its titleText. The view is placed but never styled, and (unlike a string title) labels itself for accessibility.

Source

pub fn center_title(self, center: bool) -> Self

Center the title within the space left between the leading slot and the actions (centerTitle, default false).

Source

pub fn corner_shift(self, enabled: bool) -> Self

Shift the row out from under a protruding window-control corner (default true). Pass false for a bar that does not span the window’s top edge (detail pane, sheet, dialog, below other content): layout cannot see the bar’s window-space position and the corner value is never consumed, so such a bar would otherwise over-shift.

Source

pub fn density(self, density: AppBarDensity) -> Self

Set the vertical density — see super’s metrics table.

Source

pub fn shape_family(self, family: AppBarShapeFamily) -> Self

Set the container’s corner shape family (default AppBarShapeFamily::Square, upstream’s own M3EAppBar.top default).

Source

pub fn toolbar_height(self, height: f64) -> Self

Override the band height outright (toolbarHeight), bypassing the density table — the seam that reaches upstream’s own 72dp band, among anything else.

Source

pub fn background(self, color: Color) -> Self

Override the container fill (backgroundColor), winning over Self::container, the elevation surface role, the theme default and its fallback alike.

Source

pub fn container(self, role: AppBarContainer) -> Self

Fill the container with a theme color role (default AppBarContainer::Surface), resolved at paint time so it follows a brightness flip or theme swap. An explicit role also wins over the elevation surface role Self::elevation would otherwise pick, and a string title takes the role’s foreground (see AppBarContainer). Self::background still wins over it.

use frust_material::{AppBarContainer, app_bar};

// Flutter's counter-template bar: an inverse-primary fill, raised.
let bar = app_bar::<()>("Counter")
    .container(AppBarContainer::InversePrimary)
    .elevation(2);
Source

pub fn elevation(self, level: u8) -> Self

Raise the bar to M3 elevation level (0..=5, clamped; default 0), resolved at paint time against the theme’s elevation table: a level above 0 paints that level’s drop shadow beneath the container and, with no Self::container/Self::background set, fills with the level’s surface role (level 2 is surfaceContainer). See super’s module docs for the paint order.

Source

pub fn safe_area(self, enabled: bool) -> Self

Whether the bar consumes the top, left and right window insets itself (default true) — Flutter’s AppBar wrapping its toolbar in SafeArea(bottom: false). It grows by ctx.window_insets().padding().top, paints its fill (and shadow) edge to edge through that band and across the full width, and lays its slots out below the top inset and inside the left/right ones (a landscape notch or home-indicator edge). A parent frust::safe_area that already consumed an edge leaves nothing on it to consume, so it never double-insets. Pass false for a bar that is not docked to the window’s top edge (a preview, a pane, a sheet); it then consumes no edge at all.

Source

pub fn semantic_label(self, label: impl Into<String>) -> Self

Label the bar’s accessibility container explicitly (semanticLabel). Without one, a string title labels it and a caller view leaves it unlabelled.

Trait Implementations§

Source§

impl<State: 'static> View<State> for AppBarView<State>

Source§

type Element = AppBarWidget

The retained widget this view produces.
Source§

fn build(&self, ctx: &mut BuildCtx<'_>) -> AppBarWidget

Materialise a fresh widget for this view.
Source§

fn rebuild( &self, prev: &Self, element: &mut AppBarWidget, ctx: &mut BuildCtx<'_>, ) -> ChangeFlags

Reconcile prev (the previous view of the same type) against the live element, mutating it in place and reporting what changed.
Source§

fn teardown(&self, element: &mut AppBarWidget, ctx: &mut BuildCtx<'_>)

Tear down element when this view is being removed. Read more
Source§

fn message(&self, _element: &mut Self::Element, _state: &mut State)

Deliver an event message to this view, mutating application state. Read more

Auto Trait Implementations§

§

impl<State> !RefUnwindSafe for AppBarView<State>

§

impl<State> !Send for AppBarView<State>

§

impl<State> !Sync for AppBarView<State>

§

impl<State> !UnwindSafe for AppBarView<State>

§

impl<State> Freeze for AppBarView<State>
where TitleSlot<State>: Freeze, Option<AnyView<State>>: Freeze, Vec<AnyView<State>>: Freeze,

§

impl<State> Unpin for AppBarView<State>
where TitleSlot<State>: Unpin, Option<AnyView<State>>: Unpin, Vec<AnyView<State>>: Unpin,

§

impl<State> UnsafeUnpin for AppBarView<State>
where TitleSlot<State>: UnsafeUnpin, Option<AnyView<State>>: UnsafeUnpin, Vec<AnyView<State>>: UnsafeUnpin,

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<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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

fn simd_from(_simd: S, value: T) -> 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> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<State, V> ViewSeq<State, One> for V
where State: 'static, V: View<State>,

Source§

fn extend_views(self, out: &mut Vec<AnyView<State>>)

Push every element of this sequence, in order, onto out — erasing each with AnyView::new (a no-op for an element already an AnyView).
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more