Struct Button

Source
pub struct Button<A = ()> { /* private fields */ }
Expand description

Clickable single-child button with stateful container styling.

Enter, Space, or a left-button release inside bounds runs the optional action. Disabled state suppresses activation and selects disabled styling, but the current focus policy still reports the button as focusable. Child text is not dynamically restyled; label constructors copy a normal text style once.

§Examples

use ailloli_ui_widgets::controls::{Button, ButtonVariant};
let button: Button<()> = Button::with_label_variant("Save", ButtonVariant::Primary);
let _ = button;

Implementations§

Source§

impl<A: 'static> Button<A>

Source

pub fn width(self, value: impl Into<Length>) -> Self

Sets preferred width from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().width(120.0);
let _ = widget;
Source

pub fn height(self, value: impl Into<Length>) -> Self

Sets preferred height from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().height(40.0);
let _ = widget;
Source

pub fn min_width(self, value: impl Into<Length>) -> Self

Sets the minimum width bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_width(40.0);
let _ = widget;
Source

pub fn max_width(self, value: impl Into<Length>) -> Self

Sets the maximum width bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_width(320.0);
let _ = widget;
Source

pub fn min_height(self, value: impl Into<Length>) -> Self

Sets the minimum height bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_height(24.0);
let _ = widget;
Source

pub fn max_height(self, value: impl Into<Length>) -> Self

Sets the maximum height bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_height(240.0);
let _ = widget;
Source

pub fn fill(self) -> Self

Sets both preferred axes to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill();
let _ = widget;
Source

pub fn fill_width(self) -> Self

Sets preferred width to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_width();
let _ = widget;
Source

pub fn fill_height(self) -> Self

Sets preferred height to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_height();
let _ = widget;
Source

pub fn margin(self, value: f32) -> Self

Sets uniform outer margin in logical pixels.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().margin(8.0);
let _ = widget;
Source

pub fn padding(self, value: f32) -> Self

Sets uniform inner padding in logical pixels.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().padding(8.0);
let _ = widget;
Source

pub fn flex_grow(self) -> Self

Sets flex-grow weight to one.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow();
let _ = widget;
Source

pub fn flex_grow_by(self, value: f32) -> Self

Sets a dimensionless flex-grow weight.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow_by(2.0);
let _ = widget;
Source

pub fn flex_shrink(self, value: f32) -> Self

Sets a dimensionless flex-shrink weight.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_shrink(1.0);
let _ = widget;
Source

pub fn flex_basis(self, value: impl Into<Length>) -> Self

Sets the preferred main-axis flex basis.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_basis(80.0);
let _ = widget;
Source

pub fn align_self(self, value: AlignItems) -> Self

Overrides cross-axis alignment for this flex item.

§Examples
use ailloli_ui_core::style::AlignItems;
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().align_self(AlignItems::Center);
let _ = widget;
Source§

impl<A: 'static> Button<A>

Source

pub fn new() -> Self

Creates an enabled primary button with an empty child and no action.

§Examples
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new();
let _ = button;
Source

pub fn with_label(label: impl Into<String>) -> Self

Creates a primary button with one unwrapped text child.

The normal primary text style is copied into the child at construction.

§Examples
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::with_label("Save");
let _ = button;
Source

pub fn with_label_variant( label: impl Into<String>, variant: ButtonVariant, ) -> Self

Creates a themed variant and an unwrapped label styled to match it.

Prefer this over calling Self::variant after Self::with_label, because later style changes do not propagate into an existing child.

§Examples
use ailloli_ui_widgets::controls::{Button, ButtonVariant};
let button: Button<()> = Button::with_label_variant("Delete", ButtonVariant::Destructive);
let _ = button;
Source

pub fn child(self, child: impl IntoView<A>) -> Self

Replaces the sole child view.

The button does not apply ButtonStyle::text to arbitrary children.

§Examples
use ailloli_ui_widgets::{controls::Button, text::Text};
let button: Button<()> = Button::new().child(Text::new("Custom"));
let _ = button;
Source

pub fn disabled(self, disabled: impl Into<Binding<bool>>) -> Self

Sets static or reactive disabled state.

Disabled buttons ignore activation but currently remain focusable.

§Examples
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::with_label("Unavailable").disabled(true);
let _ = button;
Source

pub fn disabled_signal(self, disabled: Memo<bool>) -> Self

Sets disabled state from a derived memo.

§Examples
use ailloli_ui_runtime::component::Memo;
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().disabled_signal(Memo::new(|| false));
let _ = button;
Source

pub fn on_click(self, action: impl IntoClickAction<A>) -> Self
where A: Clone,

Installs an activation action, replacing any previous action.

The application action type must be cloneable for queued dispatch.

§Examples
use ailloli_ui_widgets::controls::Button;
#[derive(Clone)]
enum Action { Save }
let button = Button::with_label("Save").on_click(Action::Save);
let _ = button;
Source

pub fn on_click_ctx(self, f: impl Fn(&mut EventCtx<A>) + 'static) -> Self

Installs a context-aware activation handler.

§Examples
use ailloli_ui_widgets::controls::Button;
let button = Button::<()>::new().on_click_ctx(|_ctx| {});
let _ = button;
Source

pub fn style(self, style: TextStyle) -> Self

Replaces only the stored normal label text style for compatibility.

The retained button does not propagate this into an existing child; it is observable through the stored style in immediate-mode/compatibility paths.

§Examples
use ailloli_ui_core::{Color, FontId, TextStyle};
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().style(TextStyle::new(FontId::Ui, 16, Color::WHITE));
let _ = button;
Source

pub fn button_style(self, style: ButtonStyle) -> Self

Replaces the complete button style.

This does not restyle an existing child. A later Self::variant call replaces this custom style.

§Examples
use ailloli_ui_widgets::controls::{Button, ButtonStyle};
let button: Button<()> = Button::new().button_style(ButtonStyle::outline());
let _ = button;
Source

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

Replaces the complete style with a default-theme variant.

Existing child styling is unchanged.

§Examples
use ailloli_ui_widgets::controls::{Button, ButtonVariant};
let button: Button<()> = Button::new().variant(ButtonVariant::Ghost);
let _ = button;
Source

pub fn align_items(self, value: AlignItems) -> Self

Sets child cross-axis alignment inside available content space.

Stretch currently positions like Start; it does not relayout the child.

§Examples
use ailloli_ui_core::style::AlignItems;
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().align_items(AlignItems::End);
let _ = button;
Source

pub fn justify_content(self, value: JustifyContent) -> Self

Sets child main-axis placement inside available content space.

For one child, SpaceBetween behaves as Start and SpaceAround/ SpaceEvenly behave as Center.

§Examples
use ailloli_ui_core::style::JustifyContent;
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().justify_content(JustifyContent::End);
let _ = button;
Source

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

Replaces background color in every existing container state.

Missing optional states remain absent.

§Examples
use ailloli_ui_core::Color;
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().background(Color::hex_rgb(0x224466));
let _ = button;
Source

pub fn radius(self, value: f32) -> Self

Sets uniform corner radius in every existing container state.

The logical-pixel value is stored without clamping.

§Examples
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().radius(8.0);
let _ = button;
Source

pub fn border(self, width: f32, color: Color) -> Self

Replaces all four border edges in every existing container state.

Width is in logical pixels and is not normalized here.

§Examples
use ailloli_ui_core::Color;
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().border(1.0, Color::WHITE);
let _ = button;
Source

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

Replaces every edge width while preserving edge colors in all states.

§Examples
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().border_width(2.0);
let _ = button;
Source

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

Replaces every edge color while preserving widths in all states.

§Examples
use ailloli_ui_core::Color;
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().border_color(Color::WHITE);
let _ = button;
Source

pub fn border_left(self, width: f32, color: Color) -> Self

Replaces only the left border edge in every existing state.

§Examples
use ailloli_ui_core::Color;
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().border_left(3.0, Color::WHITE);
let _ = button;
Source

pub fn border_top(self, width: f32, color: Color) -> Self

Replaces only the top border edge in every existing state.

§Examples
use ailloli_ui_core::Color;
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().border_top(3.0, Color::WHITE);
let _ = button;
Source

pub fn border_right(self, width: f32, color: Color) -> Self

Replaces only the right border edge in every existing state.

§Examples
use ailloli_ui_core::Color;
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().border_right(3.0, Color::WHITE);
let _ = button;
Source

pub fn border_bottom(self, width: f32, color: Color) -> Self

Replaces only the bottom border edge in every existing state.

§Examples
use ailloli_ui_core::Color;
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().border_bottom(3.0, Color::WHITE);
let _ = button;
Source

pub fn shadow(self, shadow: BoxShadow) -> Self

Appends one shadow to every existing container state.

Inset shadows contribute to visual bounds but are skipped by painting.

§Examples
use ailloli_ui_core::style::BoxShadow;
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().shadow(BoxShadow::sm());
let _ = button;
Source

pub fn shadow_none(self) -> Self

Removes all shadows from every existing container state.

§Examples
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().shadow_none();
let _ = button;
Source

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

Sets the last shadow color in every existing state.

An empty state first receives [BoxShadow::md].

§Examples
use ailloli_ui_core::Color;
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().shadow_color(Color::BLACK);
let _ = button;
Source

pub fn shadow_blur(self, value: f32) -> Self

Sets non-negative last-shadow blur radius in logical pixels.

Negative values and NaN become zero; an empty state first receives a medium default shadow.

§Examples
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().shadow_blur(12.0);
let _ = button;
Source

pub fn shadow_offset(self, x: f32, y: f32) -> Self

Sets last-shadow x/y offset in logical pixels without normalization.

§Examples
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().shadow_offset(0.0, 4.0);
let _ = button;
Source

pub fn shadow_spread(self, value: f32) -> Self

Sets non-negative last-shadow spread in logical pixels.

Negative values and NaN become zero.

§Examples
use ailloli_ui_widgets::controls::Button;
let button: Button<()> = Button::new().shadow_spread(2.0);
let _ = button;

Trait Implementations§

Source§

impl<A: 'static> Default for Button<A>

Source§

fn default() -> Self

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

impl<A: 'static> IntoView<A> for Button<A>

Source§

fn into_view(self) -> View<A>

Consumes a builder/value and returns its declarative view tree. Read more
Source§

impl<A: 'static> LayoutExt for Button<A>

Source§

fn layout_mut(&mut self) -> &mut LayoutStyle

Returns the widget’s mutable declarative size/inset state. Read more

Auto Trait Implementations§

§

impl<A> Freeze for Button<A>

§

impl<A = ()> !RefUnwindSafe for Button<A>

§

impl<A = ()> !Send for Button<A>

§

impl<A = ()> !Sync for Button<A>

§

impl<A> Unpin for Button<A>

§

impl<A = ()> !UnwindSafe for Button<A>

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, A> FlexItemExt<A> for T
where T: IntoView<A>,

Source§

fn flex_grow(self) -> View<A>

Sets flex-grow weight to one. Read more
Source§

fn flex_grow_by(self, value: f32) -> View<A>

Sets the dimensionless flex-grow weight. Read more
Source§

fn flex_shrink(self, value: f32) -> View<A>

Sets the dimensionless flex-shrink weight. Read more
Source§

fn flex_basis(self, value: impl Into<Length>) -> View<A>

Sets the preferred main-axis flex basis. Read more
Source§

fn align_self(self, value: AlignItems) -> View<A>

Overrides the parent cross-axis alignment for this view. Read more
Source§

fn fill_width(self) -> View<A>

Marks width as parent-fill in the view size hint. Read more
Source§

fn fill_height(self) -> View<A>

Marks height as parent-fill in the view size hint. Read more
Source§

fn fill(self) -> View<A>

Marks both axes as parent-fill in the view size hint. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T, A> IntoViewKeyExt<A> for T
where T: IntoView<A>,

§

fn key(self, key: impl Into<String>) -> View<A>

Converts self, assigns the owned key, and returns the view. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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