Skip to main content

SplitButtonView

Struct SplitButtonView 

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

A declarative split button. See the module docs.

Implementations§

Source§

impl<State: 'static> SplitButtonView<State>

Source

pub fn size(self, size: SplitButtonSize) -> Self

Set the size tier (the module docs’ Sizes table).

Source

pub fn shape(self, shape: SplitButtonShape) -> Self

Set the corner-radius family (pill vs. per-size token radius).

Source

pub fn variant(self, variant: SplitButtonVariant) -> Self

Set the container treatment (the module docs’ Variants section).

Source

pub fn trailing_alignment(self, alignment: SplitButtonTrailingAlignment) -> Self

Set how the trailing chevron is centred (trailingAlignment).

Source

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

Whether the control as a whole accepts input — the reference’s IgnorePointer(ignoring: !enabled). false disables both halves regardless of Self::trailing_enabled.

Source

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

Whether the trailing menu trigger accepts input, independently of the leading action (default true).

The reference carries leadingEnabled/trailingEnabled as two distinct variables fed from one prop (m3e_split_button_content.dart:212); this makes the second one real, so an app can offer the action while the menu has nothing to show. A disabled trailing half paints the 38%/12% disabled roles, reports disabled semantics, and simply never arms.

Source

pub fn leading_icon<F, V>(self, icon: F) -> Self
where F: Fn() -> V + 'static, V: View<State>,

Attach a leading icon before the label (M3ESplitButton.leadingIcon). The factory is re-invoked per pass, since a view is a value rebuilt every frame. The factory may return any view, which is erased here: .leading_icon(|| icon(icons::CHECK)).

Source

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

Override the trailing half’s accessible name (default "Show menu") — the reference’s trailingTooltip in the one role this framework has for it.

Source

pub fn gap(self, gap: f64) -> Self

Override the gap between the halves, in logical px (M3ESplitButtonDecoration.gap). Unset resolves SPLIT_ELEVATED_INNER_GAP for SplitButtonVariant::Elevated and SPLIT_INNER_GAP otherwise.

Source

pub fn haptic(self, haptic: HapticSignal) -> Self

The haptic signal both halves fire on activation. Defaults to HapticSignal::None, matching the reference (a button is silent unless its decoration names a signal).

Source

pub fn items(self, items: Vec<SplitButtonItem>) -> Self

The menu’s items (M3ESplitButton.items) — the list both SplitButtonMenuStyles present.

Source

pub fn selected_value(self, value: Option<String>) -> Self

The app-confirmed selected value the menu’s rows check against (M3ESplitButton.selectedValue).

Source

pub fn menu_style(self, style: SplitButtonMenuStyle) -> Self

Which presentation the menu takes (M3ESplitButtonDecoration.menuStyle).

Source

pub fn on_select<F: Fn(&mut State, MenuSelection) + 'static>( self, on_select: F, ) -> Self

Fired when a menu row is activated (M3ESplitButton.onSelected).

Source

pub fn menu_anchor(self, anchor: &OverlayAnchor) -> Self

Capture the trailing segment’s window rect into anchor on every paint, so Self::popup_menu has a rect to place against — the same OverlayAnchor handoff crate::button_group::ButtonGroupView::overflow_anchor takes.

Source

pub fn popup_menu(&self) -> AnyView<State>

The popup-style menu — a crate::menu() anchored below the trailing segment. Mount it separately (the top of the app’s own frust::Stack, or a transparent navigator page) and keep it mounted, toggling the open flag split_button takes rather than unmounting it, for the host’s exit ramp. See the module docs’ Menu styles section.

Source

pub fn sheet_menu(&self) -> BottomSheetView<State>

The bottom-sheet-style menu — the same items inside a crate::bottom_sheet, to hand to crate::show_bottom_sheet (which needs a frust::NavigatorController this widget cannot reach). See the module docs’ Menu styles section.

Source

pub fn menu_route(&self) -> SplitButtonMenuRoute<State>

The presentation this button’s Self::menu_style calls for — the route selector _openMenu performs (m3e_split_button_menu.dart:22), minus the descoped native arm.

Trait Implementations§

Source§

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

Source§

type Element = SplitButtonWidget

The retained widget this view produces.
Source§

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

Materialise a fresh widget for this view.
Source§

fn rebuild( &self, prev: &Self, element: &mut SplitButtonWidget, 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 SplitButtonWidget, 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 SplitButtonView<State>

§

impl<State> !Send for SplitButtonView<State>

§

impl<State> !Sync for SplitButtonView<State>

§

impl<State> !UnwindSafe for SplitButtonView<State>

§

impl<State> Freeze for SplitButtonView<State>
where Option<Rc<dyn Fn() -> AnyView<State>>>: Freeze, Rc<dyn Fn(&mut State)>: Freeze, Option<Rc<dyn Fn(&mut State, MenuSelection)>>: Freeze,

§

impl<State> Unpin for SplitButtonView<State>
where Option<Rc<dyn Fn() -> AnyView<State>>>: Unpin, Rc<dyn Fn(&mut State)>: Unpin, Option<Rc<dyn Fn(&mut State, MenuSelection)>>: Unpin,

§

impl<State> UnsafeUnpin for SplitButtonView<State>

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