Struct Builder

pub struct Builder<'a, Message, Variant> { /* private fields */ }

A builder for constructing a custom Button.

Implementations

impl<'a, Message> Builder<'a, Message, Hyperlink>

pub fn new(label: impl Into<Cow<'a, str>> + 'static, link: Hyperlink) -> Self

pub const fn trailing_icon(self, set: bool) -> Self

impl<'a, Message> Builder<'a, Message, Icon>

pub fn new(icon: Icon) -> Self

pub fn extra_small(self) -> Self

Applies the Extra Small button size preset.

pub fn medium(self) -> Self

Applies the Medium button size preset.

pub fn large(self) -> Self

Applies the Large button size preset.

pub fn extra_large(self) -> Self

Applies the Extra Large button size preset.

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

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

impl<'a, Message> Builder<'a, Message, Image<'a, Handle, Message>>

pub fn new(variant: Image<'a, Handle, Message>) -> Self

pub fn on_remove(self, message: Message) -> Self

pub fn on_remove_maybe(self, message: Option<Message>) -> Self

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

impl<'a, Message> Builder<'a, Message, Text>

pub fn new(text: Text) -> Self

pub fn leading_icon(self, icon: impl Into<Handle>) -> Self

pub fn trailing_icon(self, icon: impl Into<Handle>) -> Self

impl<'a, Message, Variant> Builder<'a, Message, Variant>

pub fn id(self, value: Id) -> Self

Sets the Id of the button.

pub fn label(self, value: impl Into<Cow<'a, str>>) -> Self

The label to display within the button.

pub fn tooltip(self, value: impl Into<Cow<'a, str>>) -> Self

pub fn on_press(self, value: Message) -> Self

Sets the message that will be produced when the button is pressed.

If None, the button will be disabled.

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

Sets the preferred width of the button.

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

Sets the preferred height of the button.

pub fn padding(self, value: impl Into<Padding>) -> Self

Sets the preferred padding of the button.

pub fn spacing(self, value: u16) -> Self

Sets the preferred spacing between elements in the button.

pub fn icon_size(self, value: u16) -> Self

Sets the preferred size of icons.

pub fn line_height(self, value: u16) -> Self

Sets the prefered font line height.

pub fn font_size(self, value: u16) -> Self

Sets the preferred font size.

pub fn font_weight(self, value: Weight) -> Self

Sets the preferred font weight.

pub fn class(self, value: ButtonClass) -> Self

The preferred style of the button.

impl<'a, Message, Variant> Builder<'a, Message, Variant>

pub fn on_press_maybe(self, on_press: Option<Message>) -> Self

Set the value of [on_press] as either Some or None.

Trait Implementations

impl<'a, Message: Clone + 'static> From<Builder<'a, Message, Hyperlink>> for Element<'a, Message>

fn from(builder: Button<'a, Message>) -> Element<'a, Message>

Converts to this type from the input type.

impl<'a, Message: Clone + 'static> From<Builder<'a, Message, Icon>> for Element<'a, Message>

fn from(builder: Button<'a, Message>) -> Element<'a, Message>

Converts to this type from the input type.

impl<'a, Message> From<Builder<'a, Message, Image<'a, Handle, Message>>> for Element<'a, Message>

where Handle: Clone + Hash, Message: Clone + 'static,

fn from(builder: Button<'a, Message>) -> Element<'a, Message>

Converts to this type from the input type.

impl<'a, Message: Clone + 'static> From<Builder<'a, Message, Text>> for Element<'a, Message>

fn from(builder: Button<'a, Message>) -> Element<'a, Message>

Converts to this type from the input type.