Struct RadioButtonProps 

pub struct RadioButtonProps {

    pub id: String,
    pub name: Option<String>,
    pub value: Option<String>,
    pub checked: bool,
    pub disabled: bool,
    pub label: String,
    pub children: Element,
    pub color: Color,
    pub outline: bool,
    pub size: Size,
    pub autocomplete: Option<String>,
    pub class: String,
    pub onchange: Option<EventHandler<FormEvent>>,
    /* private fields */
}

Bootstrap radio toggle button (btn-check).

Bootstrap 5.3’s “Radio toggle buttons” — the radio sibling of CheckboxButton, and the markup behind a segmented button group: several radios sharing one name, each with its own label, wrapped in a ButtonGroup.

Bootstrap HTML → Dioxus

HTML	Dioxus
<input class="btn-check" type="radio" name="view" id="r1"><label class="btn btn-primary" for="r1">List</label>	RadioButton { id: "r1", name: "view", label: "List" }

rsx! {
    ButtonGroup {
        RadioButton { id: "v-list", name: "view", value: "list", label: "List", checked: true }
        RadioButton { id: "v-grid", name: "view", value: "grid", label: "Grid" }
    }
}

Fields

id: String

The input’s id and the label’s for target. Required, as for CheckboxButton.

name: Option<String>

The radio group name. Radios sharing a name are mutually exclusive — which is the whole point of a radio, so this is where a segmented control is actually defined.

value: Option<String>

The value submitted when this option is selected.

checked: bool

Whether this option is selected.

disabled: bool

Disable the control.

label: String

The visible text, rendered after any children.

children: Element

Rich label content, rendered inside the label before label.

color: Color

Button colour variant.

outline: bool

Use the outline style.

size: Size

Button size.

autocomplete: Option<String>

See CheckboxButtonProps::autocomplete.

class: String

Additional CSS classes, appended to the label’s button classes.

onchange: Option<EventHandler<FormEvent>>

Change handler, fired on the input.

Implementations

impl RadioButtonProps

pub fn builder() -> RadioButtonPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building RadioButtonProps. On the builder, call .id(...), .name(...)(optional), .value(...)(optional), .checked(...)(optional), .disabled(...)(optional), .label(...)(optional), .children(...)(optional), .color(...)(optional), .outline(...)(optional), .size(...)(optional), .autocomplete(...)(optional), .class(...)(optional), .onchange(...)(optional), .attributes(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RadioButtonProps.

Trait Implementations

impl Clone for RadioButtonProps

fn clone(&self) -> RadioButtonProps

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for RadioButtonProps

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

Equality operator ==.

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

Inequality operator !=.

impl Properties for RadioButtonProps

where Self: Clone,

type Builder = RadioButtonPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), ())>

The type of the builder for this component. Used to create “in-progress” versions of the props.

fn builder() -> Self::Builder

Create a builder for this component.

fn memoize(&mut self, new: &Self) -> bool

Make the old props equal to the new props. Return if the props were equal and should be memoized.

fn into_vcomponent<M>( self, render_fn: impl ComponentFunction<Self, M>, ) -> VComponent

where M: 'static,

Create a component from the props.

impl StructuralPartialEq for RadioButtonProps