summaryrefslogtreecommitdiffstats
path: root/widget/src/helpers.rs
diff options
context:
space:
mode:
Diffstat (limited to 'widget/src/helpers.rs')
-rw-r--r--widget/src/helpers.rs33
1 files changed, 32 insertions, 1 deletions
diff --git a/widget/src/helpers.rs b/widget/src/helpers.rs
index cf8c0520..ec4f2265 100644
--- a/widget/src/helpers.rs
+++ b/widget/src/helpers.rs
@@ -947,7 +947,38 @@ where
/// Creates a new [`Toggler`].
///
-/// [`Toggler`]: crate::Toggler
+/// 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;
+/// }
+/// }
+/// }
+/// ```
pub fn toggler<'a, Message, Theme, Renderer>(
is_checked: bool,
) -> Toggler<'a, Message, Theme, Renderer>