1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
use crate::prelude::*;
/// A Switch used to display and toggle a boolean state.
///
/// Clicking on the Switch with the left mouse button triggers the `on_toggle` callback.
///
/// # Examples
///
/// ## Basic Switch
///
/// The Switch must bound to some boolean data.
///
/// ```
/// # use vizia_core::prelude::*;
/// #
/// # #[derive(Lens)]
/// # struct AppData {
/// # value: bool,
/// # }
/// #
/// # impl Model for AppData {}
/// #
/// # let cx = &mut Context::default();
/// #
/// # AppData { value: false }.build(cx);
/// #
/// Switch::new(cx, AppData::value);
/// ```
///
/// ## Switch with an action
///
/// A Switch can be used to trigger a callback when toggled. Usually this is emitting an
/// event responsible for changing the data the Switch is bound to.
///
/// ```
/// # use vizia_core::prelude::*;
/// #
/// # #[derive(Lens)]
/// # struct AppData {
/// # value: bool,
/// # }
/// #
/// # impl Model for AppData {}
/// #
/// # enum AppEvent {
/// # ToggleValue,
/// # }
/// #
/// # let cx = &mut Context::default();
/// #
/// # AppData { value: false }.build(cx);
/// #
/// Switch::new(cx, AppData::value).on_toggle(|cx| cx.emit(AppEvent::ToggleValue));
/// ```
///
/// ## Switch with a label
///
/// A Switch is usually used with a label next to it describing what data the Switch
/// is bound to or what the Switch does when pressed. This can be done, for example, by
/// wrapping the Switch in an [`HStack`](crate::prelude::HStack) and adding a [`Label`](crate::prelude::Label)
/// to it.
///
/// ```
/// # use vizia_core::prelude::*;
/// #
/// # #[derive(Lens)]
/// # struct AppData {
/// # value: bool,
/// # }
/// #
/// # impl Model for AppData {}
/// #
/// # let cx = &mut Context::default();
/// #
/// # AppData { value: false }.build(cx);
/// #
/// HStack::new(cx, |cx| {
/// Switch::new(cx, AppData::value);
/// Label::new(cx, "Press me");
/// });
/// ```
pub struct Switch {
on_toggle: Option<Box<dyn Fn(&mut EventContext)>>,
}
impl Switch {
/// Creates a new Switch.
///
/// # Examples
///
/// ```
/// # use vizia_core::prelude::*;
/// #
/// # #[derive(Lens)]
/// # struct AppData {
/// # value: bool,
/// # }
/// #
/// # impl Model for AppData {}
/// #
/// # let cx = &mut Context::default();
/// #
/// # AppData { value: false }.build(cx);
/// #
/// Switch::new(cx, AppData::value);
/// ```
pub fn new(cx: &mut Context, checked: impl Lens<Target = bool>) -> Handle<Self> {
Self { on_toggle: None }
.build(cx, |cx| {
Element::new(cx)
.class("switch-handle-bg")
.hoverable(false)
.position_type(PositionType::SelfDirected);
Element::new(cx)
.class("switch-handle")
.hoverable(false)
.position_type(PositionType::SelfDirected);
})
.checked(checked)
.navigable(true)
}
}
impl Handle<'_, Switch> {
/// Set the callback triggered when the Switch is pressed.
///
/// # Examples
///
/// ```
/// # use vizia_core::prelude::*;
/// #
/// # #[derive(Lens)]
/// # struct AppData {
/// # value: bool,
/// # }
/// #
/// # impl Model for AppData {}
/// #
/// # enum AppEvent {
/// # ToggleValue,
/// # }
/// #
/// # let cx = &mut Context::default();
/// #
/// # AppData { value: false }.build(cx);
/// #
/// Switch::new(cx, AppData::value).on_toggle(|cx| cx.emit(AppEvent::ToggleValue));
/// ```
pub fn on_toggle<F>(self, callback: F) -> Self
where
F: 'static + Fn(&mut EventContext),
{
self.modify(|switch| switch.on_toggle = Some(Box::new(callback)))
}
}
impl View for Switch {
fn element(&self) -> Option<&'static str> {
Some("switch")
}
fn event(&mut self, cx: &mut EventContext, event: &mut Event) {
event.map(|window_event, meta| match window_event {
WindowEvent::Press { mouse } => {
let over = if *mouse { cx.mouse.left.pressed } else { cx.focused() };
if over == cx.current() && meta.target == cx.current() && !cx.is_disabled() {
if let Some(callback) = &self.on_toggle {
(callback)(cx);
}
}
}
_ => {}
});
}
}