Struct TopAppBar 

pub struct TopAppBar { /* private fields */ }

An M3 Expressive top app bar.

Implementations

impl TopAppBar

pub fn new(id: impl Into<ElementId>, variant: TopAppBarVariant) -> Self

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

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

Supporting text under the title.

pub fn title_content(self, content: impl IntoElement) -> Self

A caller element in the title’s place, e.g. a logo or image. A text title, if also set, stays the bar’s accessible heading.

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

Center a flexible bar’s titles (center-aligned bars always are).

pub fn navigation_icon(self, icon: impl IntoElement) -> Self

The leading navigation control, e.g. a menu or back icon button.

pub fn action(self, action: impl IntoElement) -> Self

A trailing action, e.g. an icon button or avatar.

pub fn actions<E: IntoElement>( self, actions: impl IntoIterator<Item = E>, ) -> Self

pub fn scrolled_under(self, scrolled: bool) -> Self

How far the content under the bar has scrolled, in design px. Override the scrolled-under state the offset implies, e.g. for a bar over content the caller knows is scrolled, or a static specimen. A flexible bar still collapses with the offset alone.

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

The flat container role (surface by default), e.g. the surface-container-lowest of the content pane a bar heads. Scrolled under, the bar still fades to surface-container.

pub fn scroll_offset(self, offset: f32) -> Self

pub fn search_placeholder(self, placeholder: impl Into<SharedString>) -> Self

The search field’s placeholder (search bars).

pub fn on_search( self, handler: impl Fn(&ClickEvent, &mut Window, &mut App) + 'static, ) -> Self

Activating the search field, e.g. to open a search view.

pub fn preview_state(self, state: InteractionPreview) -> Self

Render the search field as a static specimen in one forced interaction state. See InteractionPreview.

Trait Implementations

impl IntoElement for TopAppBar

type Element = ViewElement<TopAppBar>

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 RenderOnce for TopAppBar

fn render(self, window: &mut Window, cx: &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.