pub struct IconButtonView<State: 'static> { /* private fields */ }Expand description
A declarative M3 Expressive icon button. See the module docs.
Implementations§
Source§impl<State: 'static> IconButtonView<State>
impl<State: 'static> IconButtonView<State>
Sourcepub fn variant(self, variant: IconButtonVariant) -> Self
pub fn variant(self, variant: IconButtonVariant) -> Self
Set the container treatment (the module docs’ Variants table).
Sourcepub fn size(self, size: IconButtonSize) -> Self
pub fn size(self, size: IconButtonSize) -> Self
Set the size tier (the module docs’ Sizes and widths table).
Sourcepub fn shape(self, shape: IconButtonShape) -> Self
pub fn shape(self, shape: IconButtonShape) -> Self
Set the resting shape family.
Sourcepub fn width(self, width: IconButtonWidth) -> Self
pub fn width(self, width: IconButtonWidth) -> Self
Set the container width tier.
Sourcepub fn selected(self, selected: bool) -> Self
pub fn selected(self, selected: bool) -> Self
Mark this a toggle icon button carrying selected, per the
module docs’ Toggle section — never self-mutated by a press.
Sourcepub fn selected_icon(self, icon: impl View<State>) -> Self
pub fn selected_icon(self, icon: impl View<State>) -> Self
The icon painted while selected, falling back to the base icon when
unset — also makes this a toggle icon button on its own even without
Self::selected (the module docs’ Toggle section).
Sourcepub fn enabled(self, enabled: bool) -> Self
pub fn enabled(self, enabled: bool) -> Self
Whether the button accepts a press (default true). Never dims
color — see the module docs’ Variants section.
Sourcepub fn haptic(self, haptic: HapticSignal) -> Self
pub fn haptic(self, haptic: HapticSignal) -> Self
The haptic signal to fire on a press. Defaults to
HapticSignal::None.
Sourcepub fn badge(self, value: BadgeValue) -> Self
pub fn badge(self, value: BadgeValue) -> Self
Attach a badge (the module docs’ Badge section).
Sourcepub fn suppress_ink(self, suppress: bool) -> Self
pub fn suppress_ink(self, suppress: bool) -> Self
Suppress the hover/focus/pressed state-layer overlay (the
reference’s suppressInk, which forces both its splash and its
overlay color transparent — this framework has no ripple, so
suppressing the state layer is the whole effect).
Sourcepub fn semantic_label(self, label: impl Into<String>) -> Self
pub fn semantic_label(self, label: impl Into<String>) -> Self
The accessible label, when the icon alone doesn’t name the action.
Trait Implementations§
Source§impl<State: 'static> View<State> for IconButtonView<State>
impl<State: 'static> View<State> for IconButtonView<State>
Source§type Element = IconButtonWidget
type Element = IconButtonWidget
Source§fn build(&self, ctx: &mut BuildCtx<'_>) -> IconButtonWidget
fn build(&self, ctx: &mut BuildCtx<'_>) -> IconButtonWidget
Source§fn rebuild(
&self,
prev: &Self,
element: &mut IconButtonWidget,
ctx: &mut BuildCtx<'_>,
) -> ChangeFlags
fn rebuild( &self, prev: &Self, element: &mut IconButtonWidget, ctx: &mut BuildCtx<'_>, ) -> ChangeFlags
prev (the previous view of the same type) against the live
element, mutating it in place and reporting what changed.Auto Trait Implementations§
impl<State> !RefUnwindSafe for IconButtonView<State>
impl<State> !Send for IconButtonView<State>
impl<State> !Sync for IconButtonView<State>
impl<State> !UnwindSafe for IconButtonView<State>
impl<State> Freeze for IconButtonView<State>
impl<State> Unpin for IconButtonView<State>
impl<State> UnsafeUnpin for IconButtonView<State>where
AnyView<State>: UnsafeUnpin,
Option<AnyView<State>>: UnsafeUnpin,
Rc<dyn Fn(&mut State)>: UnsafeUnpin,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.impl<T> ErasedDestructor for Twhere
T: 'static,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T> StorageAccess<T> for T
impl<T> StorageAccess<T> for T
Source§fn as_borrowed(&self) -> &T
fn as_borrowed(&self) -> &T
Source§fn into_taken(self) -> T
fn into_taken(self) -> T
Source§impl<State, V> ViewSeq<State, One> for Vwhere
State: 'static,
V: View<State>,
impl<State, V> ViewSeq<State, One> for Vwhere
State: 'static,
V: View<State>,
Source§fn extend_views(self, out: &mut Vec<AnyView<State>>)
fn extend_views(self, out: &mut Vec<AnyView<State>>)
out — erasing each
with AnyView::new (a no-op for an element already an AnyView).