Struct ButtonProps

pub struct ButtonProps {

    pub class: String,
    pub children: Children,
    pub block: bool,
    pub disabled: bool,
    pub name: String,
    pub onclick: Callback<MouseEvent>,
    pub outline: bool,
    pub size: ButtonSize,
    pub style: Color,
    pub text: String,
    pub modal_target: Option<String>,
    pub modal_dismiss: bool,
    pub url: Option<AttrValue>,
    pub target: Option<AttrValue>,
    pub node_ref: NodeRef,
    pub id: Option<AttrValue>,
}

Properties for Button

Fields

class: String

CSS class

children: Children

Optional children

block: bool

Treat button as block that spans the full width of the parent

disabled: bool

Status of the button. Disabled buttons cannot be clicked.

name: String

Name of the component

onclick: Callback<MouseEvent>

Event called when the button is clicked

outline: bool

Show button as outlined instead of filled

size: ButtonSize

Size of the button

style: Color

Color of the button, default Color::Primary

text: String

Text displayed in the button

modal_target: Option<String>

if provided, we will set data-bs-toggle and data-bs-target for modal opening

modal_dismiss: bool

true if this button dismisses the modal that contains it

url: Option<AttrValue>

URL to direct to when the button is clicked. This turns the button into an <a> element.

This property is ignored if the button is disabled to avoid link functionality caveats, which may result in slightly different rendering on some browsers / platforms.

target: Option<AttrValue>

Target frame or window ID for the link. Only used if url is set and the button is not disabled.

node_ref: NodeRef

Reference to the NodeRef of the button’s underlying <button> or <a> element.

Used by components which add custom event handlers directly to the DOM.

See Node Refs in the Yew documentation for more information.

id: Option<AttrValue>

Optional HTML element ID for the underlying <button> or <a> element.

Trait Implementations

impl Clone for ButtonProps

fn clone(&self) -> ButtonProps

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq for ButtonProps

fn eq(&self, other: &ButtonProps) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Properties for ButtonProps

type Builder = ButtonPropsBuilder

Builder that will be used to construct properties

fn builder() -> Self::Builder

Entrypoint for building properties

impl StructuralPartialEq for ButtonProps