summaryrefslogtreecommitdiffstats
path: root/widget/src/helpers.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-09-18 23:05:50 +0200
committerLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-09-19 02:30:24 +0200
commit0a95af78f46728b86cb78380791f40f008be99eb (patch)
treec492ef202be6db352d0aab20cf852660323ad6bd /widget/src/helpers.rs
parentdc2efb3fabc5378671eb91f0983464f372143c1c (diff)
downloadiced-0a95af78f46728b86cb78380791f40f008be99eb.tar.gz
iced-0a95af78f46728b86cb78380791f40f008be99eb.tar.bz2
iced-0a95af78f46728b86cb78380791f40f008be99eb.zip
Add quick example to `widget::button` module
Diffstat (limited to 'widget/src/helpers.rs')
-rw-r--r--widget/src/helpers.rs16
1 files changed, 15 insertions, 1 deletions
diff --git a/widget/src/helpers.rs b/widget/src/helpers.rs
index 51978823..2ad62156 100644
--- a/widget/src/helpers.rs
+++ b/widget/src/helpers.rs
@@ -653,7 +653,21 @@ where
/// Creates a new [`Button`] with the provided content.
///
-/// [`Button`]: crate::Button
+/// ```no_run
+/// # mod iced { pub mod widget { pub use iced_widget::*; } }
+/// # pub type State = ();
+/// # pub type Element<'a, Message> = iced_widget::core::Element<'a, Message, iced_widget::Theme, iced_widget::Renderer>;
+/// use iced::widget::button;
+///
+/// #[derive(Clone)]
+/// enum Message {
+/// ButtonPressed,
+/// }
+///
+/// fn view(state: &State) -> Element<'_, Message> {
+/// button("Press me!").on_press(Message::ButtonPressed).into()
+/// }
+/// ```
pub fn button<'a, Message, Theme, Renderer>(
content: impl Into<Element<'a, Message, Theme, Renderer>>,
) -> Button<'a, Message, Theme, Renderer>