From 51f7ce73248bea2bb7cc2b662433e46fa0c44dcb Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector@hecrj.dev>
Date: Thu, 19 Sep 2024 03:03:11 +0200
Subject: Show `checkbox` doc example in multiple places

---
 widget/src/helpers.rs | 34 ++++++++++++++++++++++++++++++++--
 1 file changed, 32 insertions(+), 2 deletions(-)

(limited to 'widget/src/helpers.rs')

diff --git a/widget/src/helpers.rs b/widget/src/helpers.rs
index 30d40edc..1ed0bde2 100644
--- a/widget/src/helpers.rs
+++ b/widget/src/helpers.rs
@@ -653,6 +653,7 @@ where
 
 /// Creates a new [`Button`] with the provided content.
 ///
+/// # Example
 /// ```no_run
 /// # mod iced { pub mod widget { pub use iced_widget::*; } }
 /// # pub type State = ();
@@ -747,7 +748,36 @@ pub use crate::markdown::view as markdown;
 
 /// Creates a new [`Checkbox`].
 ///
-/// [`Checkbox`]: crate::Checkbox
+/// # 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::checkbox;
+///
+/// struct State {
+///    is_checked: bool,
+/// }
+///
+/// enum Message {
+///     CheckboxToggled(bool),
+/// }
+///
+/// fn view(state: &State) -> Element<'_, Message> {
+///     checkbox("Toggle me!", state.is_checked)
+///         .on_toggle(Message::CheckboxToggled)
+///         .into()
+/// }
+///
+/// fn update(state: &mut State, message: Message) {
+///     match message {
+///         Message::CheckboxToggled(is_checked) => {
+///             state.is_checked = is_checked;
+///         }
+///     }
+/// }
+/// ```
+/// ![Checkbox drawn by `iced_wgpu`](https://github.com/iced-rs/iced/blob/7760618fb112074bc40b148944521f312152012a/docs/images/checkbox.png?raw=true)
 pub fn checkbox<'a, Message, Theme, Renderer>(
     label: impl Into<String>,
     is_checked: bool,
@@ -1001,7 +1031,7 @@ where
 ///
 /// [`Canvas`]: crate::Canvas
 ///
-/// ## Drawing a simple circle
+/// # Example: Drawing a Simple Circle
 /// Here's how we can use a [`Canvas`] to draw a simple circle:
 ///
 /// ```no_run
-- 
cgit