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.rs22
1 files changed, 21 insertions, 1 deletions
diff --git a/widget/src/helpers.rs b/widget/src/helpers.rs
index 40a72452..9854c0bf 100644
--- a/widget/src/helpers.rs
+++ b/widget/src/helpers.rs
@@ -681,7 +681,27 @@ where
/// Creates a new [`Scrollable`] with the provided content.
///
-/// [`Scrollable`]: crate::Scrollable
+/// Scrollables let users navigate an endless amount of content with a scrollbar.
+///
+/// # 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::{column, scrollable, vertical_space};
+///
+/// enum Message {
+/// // ...
+/// }
+///
+/// fn view(state: &State) -> Element<'_, Message> {
+/// scrollable(column![
+/// "Scroll me!",
+/// vertical_space().height(3000),
+/// "You did it!",
+/// ]).into()
+/// }
+/// ```
pub fn scrollable<'a, Message, Theme, Renderer>(
content: impl Into<Element<'a, Message, Theme, Renderer>>,
) -> Scrollable<'a, Message, Theme, Renderer>