//! Togglers let users make binary choices by toggling a switch. //! //! # Example //! ```no_run //! # mod iced { pub mod widget { pub use iced_widget::*; } pub use iced_widget::Renderer; pub use iced_widget::core::*; } //! # pub type Element<'a, Message> = iced_widget::core::Element<'a, Message, iced_widget::Theme, iced_widget::Renderer>; //! # //! use iced::widget::toggler; //! //! struct State { //! is_checked: bool, //! } //! //! enum Message { //! TogglerToggled(bool), //! } //! //! fn view(state: &State) -> Element<'_, Message> { //! toggler(state.is_checked) //! .label("Toggle me!") //! .on_toggle(Message::TogglerToggled) //! .into() //! } //! //! fn update(state: &mut State, message: Message) { //! match message { //! Message::TogglerToggled(is_checked) => { //! state.is_checked = is_checked; //! } //! } //! } //! ``` use crate::core::alignment; use crate::core::layout; use crate::core::mouse; use crate::core::renderer; use crate::core::text; use crate::core::touch; use crate::core::widget; use crate::core::widget::tree::{self, Tree}; use crate::core::window; use crate::core::{ Border, Clipboard, Color, Element, Event, Layout, Length, Pixels, Rectangle, Shell, Size, Theme, Widget, }; /// A toggler widget. /// /// # Example /// ```no_run /// # mod iced { pub mod widget { pub use iced_widget::*; } pub use iced_widget::Renderer; pub use iced_widget::core::*; } /// # pub type Element<'a, Message> = iced_widget::core::Element<'a, Message, iced_widget::Theme, iced_widget::Renderer>; /// # /// use iced::widget::toggler; /// /// struct State { /// is_checked: bool, /// } /// /// enum Message { /// TogglerToggled(bool), /// } /// /// fn view(state: &State) -> Element<'_, Message> { /// toggler(state.is_checked) /// .label("Toggle me!") /// .on_toggle(Message::TogglerToggled) /// .into() /// } /// /// fn update(state: &mut State, message: Message) { /// match message { /// Message::TogglerToggled(is_checked) => { /// state.is_checked = is_checked; /// } /// } /// } /// ``` #[allow(missing_debug_implementations)] pub struct Toggler< 'a, Message, Theme = crate::Theme, Renderer = crate::Renderer, > where Theme: Catalog, Renderer: text::Renderer, { is_toggled: bool, on_toggle: Option Message + 'a>>, label: Option>, width: Length, size: f32, text_size: Option, text_line_height: text::LineHeight, text_alignment: alignment::Horizontal, text_shaping: text::Shaping, text_wrapping: text::Wrapping, spacing: f32, font: Option, class: Theme::Class<'a>, last_status: Option, } impl<'a, Message, Theme, Renderer> Toggler<'a, Message, Theme, Renderer> where Theme: Catalog, Renderer: text::Renderer, { /// The default size of a [`Toggler`]. pub const DEFAULT_SIZE: f32 = 16.0; /// Creates a new [`Toggler`]. /// /// It expects: /// * a boolean describing whether the [`Toggler`] is checked or not /// * An optional label for the [`Toggler`] /// * a function that will be called when the [`Toggler`] is toggled. It /// will receive the new state of the [`Toggler`] and must produce a /// `Message`. pub fn new(is_toggled: bool) -> Self { Toggler { is_toggled, on_toggle: None, label: None, width: Length::Shrink, size: Self::DEFAULT_SIZE, text_size: None, text_line_height: text::LineHeight::default(), text_alignment: alignment::Horizontal::Left, text_shaping: text::Shaping::default(), text_wrapping: text::Wrapping::default(), spacing: Self::DEFAULT_SIZE / 2.0, font: None, class: Theme::default(), last_status: None, } } /// Sets the label of the [`Toggler`]. pub fn label(mut self, label: impl text::IntoFragment<'a>) -> Self { self.label = Some(label.into_fragment()); self } /// Sets the message that should be produced when a user toggles /// the [`Toggler`]. /// /// If this method is not called, the [`Toggler`] will be disabled. pub fn on_toggle( mut self, on_toggle: impl Fn(bool) -> Message + 'a, ) -> Self { self.on_toggle = Some(Box::new(on_toggle)); self } /// Sets the message that should be produced when a user toggles /// the [`Toggler`], if `Some`. /// /// If `None`, the [`Toggler`] will be disabled. pub fn on_toggle_maybe( mut self, on_toggle: Option Message + 'a>, ) -> Self { self.on_toggle = on_toggle.map(|on_toggle| Box::new(on_toggle) as _); self } /// Sets the size of the [`Toggler`]. pub fn size(mut self, size: impl Into) -> Self { self.size = size.into().0; self } /// Sets the width of the [`Toggler`]. pub fn width(mut self, width: impl Into) -> Self { self.width = width.into(); self } /// Sets the text size o the [`Toggler`]. pub fn text_size(mut self, text_size: impl Into) -> Self { self.text_size = Some(text_size.into()); self } /// Sets the text [`text::LineHeight`] of the [`Toggler`]. pub fn text_line_height( mut self, line_height: impl Into, ) -> Self { self.text_line_height = line_height.into(); self } /// Sets the horizontal alignment of the text of the [`Toggler`] pub fn text_alignment(mut self, alignment: alignment::Horizontal) -> Self { self.text_alignment = alignment; self } /// Sets the [`text::Shaping`] strategy of the [`Toggler`]. pub fn text_shaping(mut self, shaping: text::Shaping) -> Self { self.text_shaping = shaping; self } /// Sets the [`text::Wrapping`] strategy of the [`Toggler`]. pub fn text_wrapping(mut self, wrapping: text::Wrapping) -> Self { self.text_wrapping = wrapping; self } /// Sets the spacing between the [`Toggler`] and the text. pub fn spacing(mut self, spacing: impl Into) -> Self { self.spacing = spacing.into().0; self } /// Sets the [`Renderer::Font`] of the text of the [`Toggler`] /// /// [`Renderer::Font`]: crate::core::text::Renderer pub fn font(mut self, font: impl Into) -> Self { self.font = Some(font.into()); self } /// Sets the style of the [`Toggler`]. #[must_use] pub fn style(mut self, style: impl Fn(&Theme, Status) -> Style + 'a) -> Self where Theme::Class<'a>: From>, { self.class = (Box::new(style) as StyleFn<'a, Theme>).into(); self } /// Sets the style class of the [`Toggler`]. #[cfg(feature = "advanced")] #[must_use] pub fn class(mut self, class: impl Into>) -> Self { self.class = class.into(); self } } impl Widget for Toggler<'_, Message, Theme, Renderer> where Theme: Catalog, Renderer: text::Renderer, { fn tag(&self) -> tree::Tag { tree::Tag::of::>() } fn state(&self) -> tree::State { tree::State::new(widget::text::State::::default()) } fn size(&self) -> Size { Size { width: self.width, height: Length::Shrink, } } fn layout( &self, tree: &mut Tree, renderer: &Renderer, limits: &layout::Limits, ) -> layout::Node { let limits = limits.width(self.width); layout::next_to_each_other( &limits, self.spacing, |_| layout::Node::new(Size::new(2.0 * self.size, self.size)), |limits| { if let Some(label) = self.label.as_deref() { let state = tree .state .downcast_mut::>(); widget::text::layout( state, renderer, limits, self.width, Length::Shrink, label, self.text_line_height, self.text_size, self.font, self.text_alignment, alignment::Vertical::Top, self.text_shaping, self.text_wrapping, ) } else { layout::Node::new(Size::ZERO) } }, ) } fn update( &mut self, _state: &mut Tree, event: &Event, layout: Layout<'_>, cursor: mouse::Cursor, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, ) { let Some(on_toggle) = &self.on_toggle else { return; }; match event { Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left)) | Event::Touch(touch::Event::FingerPressed { .. }) => { let mouse_over = cursor.is_over(layout.bounds()); if mouse_over { shell.publish(on_toggle(!self.is_toggled)); shell.capture_event(); } } _ => {} } let current_status = if self.on_toggle.is_none() { Status::Disabled } else if cursor.is_over(layout.bounds()) { Status::Hovered { is_toggled: self.is_toggled, } } else { Status::Active { is_toggled: self.is_toggled, } }; if let Event::Window(window::Event::RedrawRequested(_now)) = event { self.last_status = Some(current_status); } else if self .last_status .is_some_and(|status| status != current_status) { shell.request_redraw(); } } fn mouse_interaction( &self, _state: &Tree, layout: Layout<'_>, cursor: mouse::Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> mouse::Interaction { if cursor.is_over(layout.bounds()) { if self.on_toggle.is_some() { mouse::Interaction::Pointer } else { mouse::Interaction::NotAllowed } } else { mouse::Interaction::default() } } fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, style: &renderer::Style, layout: Layout<'_>, _cursor: mouse::Cursor, viewport: &Rectangle, ) { /// Makes sure that the border radius of the toggler looks good at every size. const BORDER_RADIUS_RATIO: f32 = 32.0 / 13.0; /// The space ratio between the background Quad and the Toggler bounds, and /// between the background Quad and foreground Quad. const SPACE_RATIO: f32 = 0.05; let mut children = layout.children(); let toggler_layout = children.next().unwrap(); if self.label.is_some() { let label_layout = children.next().unwrap(); let state: &widget::text::State = tree.state.downcast_ref(); crate::text::draw( renderer, style, label_layout, state.0.raw(), crate::text::Style::default(), viewport, ); } let bounds = toggler_layout.bounds(); let style = theme .style(&self.class, self.last_status.unwrap_or(Status::Disabled)); let border_radius = bounds.height / BORDER_RADIUS_RATIO; let space = SPACE_RATIO * bounds.height; let toggler_background_bounds = Rectangle { x: bounds.x + space, y: bounds.y + space, width: bounds.width - (2.0 * space), height: bounds.height - (2.0 * space), }; renderer.fill_quad( renderer::Quad { bounds: toggler_background_bounds, border: Border { radius: border_radius.into(), width: style.background_border_width, color: style.background_border_color, }, ..renderer::Quad::default() }, style.background, ); let toggler_foreground_bounds = Rectangle { x: bounds.x + if self.is_toggled { bounds.width - 2.0 * space - (bounds.height - (4.0 * space)) } else { 2.0 * space }, y: bounds.y + (2.0 * space), width: bounds.height - (4.0 * space), height: bounds.height - (4.0 * space), }; renderer.fill_quad( renderer::Quad { bounds: toggler_foreground_bounds, border: Border { radius: border_radius.into(), width: style.foreground_border_width, color: style.foreground_border_color, }, ..renderer::Quad::default() }, style.foreground, ); } } impl<'a, Message, Theme, Renderer> From> for Element<'a, Message, Theme, Renderer> where Message: 'a, Theme: Catalog + 'a, Renderer: text::Renderer + 'a, { fn from( toggler: Toggler<'a, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer> { Element::new(toggler) } } /// The possible status of a [`Toggler`]. #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub enum Status { /// The [`Toggler`] can be interacted with. Active { /// Indicates whether the [`Toggler`] is toggled. is_toggled: bool, }, /// The [`Toggler`] is being hovered. Hovered { /// Indicates whether the [`Toggler`] is toggled. is_toggled: bool, }, /// The [`Toggler`] is disabled. Disabled, } /// The appearance of a toggler. #[derive(Debug, Clone, Copy, PartialEq)] pub struct Style { /// The background [`Color`] of the toggler. pub background: Color, /// The width of the background border of the toggler. pub background_border_width: f32, /// The [`Color`] of the background border of the toggler. pub background_border_color: Color, /// The foreground [`Color`] of the toggler. pub foreground: Color, /// The width of the foreground border of the toggler. pub foreground_border_width: f32, /// The [`Color`] of the foreground border of the toggler. pub foreground_border_color: Color, } /// The theme catalog of a [`Toggler`]. pub trait Catalog: Sized { /// The item class of the [`Catalog`]. type Class<'a>; /// The default class produced by the [`Catalog`]. fn default<'a>() -> Self::Class<'a>; /// The [`Style`] of a class with the given status. fn style(&self, class: &Self::Class<'_>, status: Status) -> Style; } /// A styling function for a [`Toggler`]. /// /// This is just a boxed closure: `Fn(&Theme, Status) -> Style`. pub type StyleFn<'a, Theme> = Box Style + 'a>; impl Catalog for Theme { type Class<'a> = StyleFn<'a, Self>; fn default<'a>() -> Self::Class<'a> { Box::new(default) } fn style(&self, class: &Self::Class<'_>, status: Status) -> Style { class(self, status) } } /// The default style of a [`Toggler`]. pub fn default(theme: &Theme, status: Status) -> Style { let palette = theme.extended_palette(); let background = match status { Status::Active { is_toggled } | Status::Hovered { is_toggled } => { if is_toggled { palette.primary.strong.color } else { palette.background.strong.color } } Status::Disabled => palette.background.weak.color, }; let foreground = match status { Status::Active { is_toggled } => { if is_toggled { palette.primary.strong.text } else { palette.background.base.color } } Status::Hovered { is_toggled } => { if is_toggled { Color { a: 0.5, ..palette.primary.strong.text } } else { palette.background.weak.color } } Status::Disabled => palette.background.base.color, }; Style { background, foreground, foreground_border_width: 0.0, foreground_border_color: Color::TRANSPARENT, background_border_width: 0.0, background_border_color: Color::TRANSPARENT, } }