summaryrefslogtreecommitdiffstats
path: root/widget/src/column.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-09-19 06:49:22 +0200
committerLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-09-19 06:49:22 +0200
commit31c42c1d02d6a76dedaa780e6832a23765c8aef2 (patch)
tree2dbb170bbf4743746600d89b08f8dd288175022d /widget/src/column.rs
parentcda1369c790cac27dce90abaead2bca940047ed0 (diff)
downloadiced-31c42c1d02d6a76dedaa780e6832a23765c8aef2.tar.gz
iced-31c42c1d02d6a76dedaa780e6832a23765c8aef2.tar.bz2
iced-31c42c1d02d6a76dedaa780e6832a23765c8aef2.zip
Write doc examples for `column` and `row`
Diffstat (limited to '')
-rw-r--r--widget/src/column.rs21
1 files changed, 21 insertions, 0 deletions
diff --git a/widget/src/column.rs b/widget/src/column.rs
index d3ea4cf7..fc4653b9 100644
--- a/widget/src/column.rs
+++ b/widget/src/column.rs
@@ -12,6 +12,27 @@ use crate::core::{
};
/// A container that distributes its contents vertically.
+///
+/// # Example
+/// ```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, column};
+///
+/// #[derive(Debug, Clone)]
+/// enum Message {
+/// // ...
+/// }
+///
+/// fn view(state: &State) -> Element<'_, Message> {
+/// column![
+/// "I am on top!",
+/// button("I am in the center!"),
+/// "I am below.",
+/// ].into()
+/// }
+/// ```
#[allow(missing_debug_implementations)]
pub struct Column<'a, Message, Theme = crate::Theme, Renderer = crate::Renderer>
{