diff options
| author |  Héctor Ramón Jiménez <hector@hecrj.dev> | 2024-09-19 04:57:32 +0200 |
|---|---|---|
| committer | Héctor Ramón Jiménez <hector@hecrj.dev> | 2024-09-19 04:57:32 +0200 |
| commit | c646ff5f1feb1112f9e34d75e40246e4fc1c74e6 (patch) | |
| tree | 8844414231db745ec63828448f108c95fa2f4d51 /widget/src/helpers.rs | |
| parent | 7b22b7e87699e22f3e16869093e8a01a91d2e93c (diff) | |
| download | iced-c646ff5f1feb1112f9e34d75e40246e4fc1c74e6.tar.gz iced-c646ff5f1feb1112f9e34d75e40246e4fc1c74e6.tar.bz2 iced-c646ff5f1feb1112f9e34d75e40246e4fc1c74e6.zip | |
Show `progress_bar` doc example in multiple places
Diffstat (limited to 'widget/src/helpers.rs')
| -rw-r--r-- | widget/src/helpers.rs | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/widget/src/helpers.rs b/widget/src/helpers.rs index 72d5d7fe..53286e0a 100644 --- a/widget/src/helpers.rs +++ b/widget/src/helpers.rs @@ -1112,11 +1112,31 @@ where /// Creates a new [`ProgressBar`]. /// +/// Progress bars visualize the progression of an extended computer operation, such as a download, file transfer, or installation. +/// /// It expects: /// * an inclusive range of possible values, and /// * the current value of the [`ProgressBar`]. /// -/// [`ProgressBar`]: crate::ProgressBar +/// # 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::progress_bar; +/// +/// struct State { +/// progress: f32, +/// } +/// +/// enum Message { +/// // ... +/// } +/// +/// fn view(state: &State) -> Element<'_, Message> { +/// progress_bar(0.0..=100.0, state.progress).into() +/// } +/// ``` pub fn progress_bar<'a, Theme>( range: RangeInclusive<f32>, value: f32, |