Struct vizia::views::RadioButton

pub struct RadioButton { /* private fields */ }

A radio button used to display and toggle boolean state.

Clicking on the radio button with the left mouse button triggers the on_select callback.

Examples

Basic radio button

The radio button must bound to some boolean data.

RadioButton::new(cx, AppData::value);

Radio button with an action

A radio button can be used to trigger a callback when selected. Usually this is emitting an event responsible for changing the data the radio button is bound to.

RadioButton::new(cx, AppData::value).on_select(|cx| cx.emit(AppEvent::ToggleValue));

Radio button with a label

A radio button is usually used with a label next to it describing what data the radio button is bound to or what the radio button does when pressed. This can be done, for example, by wrapping the radio button in an HStack and adding a Label to it.

HStack::new(cx, |cx| {
    RadioButton::new(cx, AppData::value);
    Label::new(cx, "Press me");
});

Implementations

impl RadioButton

pub fn new( cx: &mut Context, checked: impl Lens<Target = bool>, ) -> Handle<'_, RadioButton>

Trait Implementations

impl View for RadioButton

fn element(&self) -> Option<&'static str>

Specifies a name for the view type which can be used as an element selector in css.

fn event(&mut self, cx: &mut EventContext<'_>, event: &mut Event)

Handles any events received by the view.

fn build<F>(self, cx: &mut Context, content: F) -> Handle<'_, Self>

where F: FnOnce(&mut Context),

Builds the view into the tree and returns a handle which can be used to apply style and layout modifiers to the view.

fn draw(&self, cx: &mut DrawContext<'_>, canvas: &Canvas)

Provides custom drawing for the view.

fn accessibility(&self, cx: &mut AccessContext<'_>, node: &mut AccessNode)