summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-09-19 05:42:21 +0200
committerLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-09-19 05:42:21 +0200
commit10fa40a85f09921c015fb2632aa34b9ef26d13cd (patch)
tree0242ec57a8340b9951a72631b64b6f1e7dca2e70
parent94f0e0a2125faae7ea331f2edba99dd44b28a41a (diff)
downloadiced-10fa40a85f09921c015fb2632aa34b9ef26d13cd.tar.gz
iced-10fa40a85f09921c015fb2632aa34b9ef26d13cd.tar.bz2
iced-10fa40a85f09921c015fb2632aa34b9ef26d13cd.zip
Show `slider` doc example in multiple places
-rw-r--r--widget/src/helpers.rs62
-rw-r--r--widget/src/slider.rs60
-rw-r--r--widget/src/vertical_slider.rs58
3 files changed, 162 insertions, 18 deletions
diff --git a/widget/src/helpers.rs b/widget/src/helpers.rs
index 9854c0bf..a8da2a32 100644
--- a/widget/src/helpers.rs
+++ b/widget/src/helpers.rs
@@ -969,7 +969,36 @@ where
/// Creates a new [`Slider`].
///
-/// [`Slider`]: crate::Slider
+/// Sliders let users set a value by moving an indicator.
+///
+/// # 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::slider;
+///
+/// struct State {
+/// value: f32,
+/// }
+///
+/// #[derive(Debug, Clone)]
+/// enum Message {
+/// ValueChanged(f32),
+/// }
+///
+/// fn view(state: &State) -> Element<'_, Message> {
+/// slider(0.0..=100.0, state.value, Message::ValueChanged).into()
+/// }
+///
+/// fn update(state: &mut State, message: Message) {
+/// match message {
+/// Message::ValueChanged(value) => {
+/// state.value = value;
+/// }
+/// }
+/// }
+/// ```
pub fn slider<'a, T, Message, Theme>(
range: std::ops::RangeInclusive<T>,
value: T,
@@ -985,7 +1014,36 @@ where
/// Creates a new [`VerticalSlider`].
///
-/// [`VerticalSlider`]: crate::VerticalSlider
+/// Sliders let users set a value by moving an indicator.
+///
+/// # 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::vertical_slider;
+///
+/// struct State {
+/// value: f32,
+/// }
+///
+/// #[derive(Debug, Clone)]
+/// enum Message {
+/// ValueChanged(f32),
+/// }
+///
+/// fn view(state: &State) -> Element<'_, Message> {
+/// vertical_slider(0.0..=100.0, state.value, Message::ValueChanged).into()
+/// }
+///
+/// fn update(state: &mut State, message: Message) {
+/// match message {
+/// Message::ValueChanged(value) => {
+/// state.value = value;
+/// }
+/// }
+/// }
+/// ```
pub fn vertical_slider<'a, T, Message, Theme>(
range: std::ops::RangeInclusive<T>,
value: T,
diff --git a/widget/src/slider.rs b/widget/src/slider.rs
index 15514afe..9477958d 100644
--- a/widget/src/slider.rs
+++ b/widget/src/slider.rs
@@ -1,4 +1,33 @@
-//! Display an interactive selector of a single value from a range of values.
+//! Sliders let users set a value by moving an indicator.
+//!
+//! # 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::slider;
+//!
+//! struct State {
+//! value: f32,
+//! }
+//!
+//! #[derive(Debug, Clone)]
+//! enum Message {
+//! ValueChanged(f32),
+//! }
+//!
+//! fn view(state: &State) -> Element<'_, Message> {
+//! slider(0.0..=100.0, state.value, Message::ValueChanged).into()
+//! }
+//!
+//! fn update(state: &mut State, message: Message) {
+//! match message {
+//! Message::ValueChanged(value) => {
+//! state.value = value;
+//! }
+//! }
+//! }
+//! ```
use crate::core::border::{self, Border};
use crate::core::event::{self, Event};
use crate::core::keyboard;
@@ -25,19 +54,32 @@ use std::ops::RangeInclusive;
///
/// # Example
/// ```no_run
-/// # type Slider<'a, T, Message> = iced_widget::Slider<'a, Message, T>;
+/// # 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>;
/// #
-/// #[derive(Clone)]
-/// pub enum Message {
-/// SliderChanged(f32),
+/// use iced::widget::slider;
+///
+/// struct State {
+/// value: f32,
/// }
///
-/// let value = 50.0;
+/// #[derive(Debug, Clone)]
+/// enum Message {
+/// ValueChanged(f32),
+/// }
///
-/// Slider::new(0.0..=100.0, value, Message::SliderChanged);
-/// ```
+/// fn view(state: &State) -> Element<'_, Message> {
+/// slider(0.0..=100.0, state.value, Message::ValueChanged).into()
+/// }
///
-/// ![Slider drawn by Coffee's renderer](https://github.com/hecrj/coffee/blob/bda9818f823dfcb8a7ad0ff4940b4d4b387b5208/images/ui/slider.png?raw=true)
+/// fn update(state: &mut State, message: Message) {
+/// match message {
+/// Message::ValueChanged(value) => {
+/// state.value = value;
+/// }
+/// }
+/// }
+/// ```
#[allow(missing_debug_implementations)]
pub struct Slider<'a, T, Message, Theme = crate::Theme>
where
diff --git a/widget/src/vertical_slider.rs b/widget/src/vertical_slider.rs
index a75ba49c..18633474 100644
--- a/widget/src/vertical_slider.rs
+++ b/widget/src/vertical_slider.rs
@@ -1,4 +1,33 @@
-//! Display an interactive selector of a single value from a range of values.
+//! Sliders let users set a value by moving an indicator.
+//!
+//! # 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::slider;
+//!
+//! struct State {
+//! value: f32,
+//! }
+//!
+//! #[derive(Debug, Clone)]
+//! enum Message {
+//! ValueChanged(f32),
+//! }
+//!
+//! fn view(state: &State) -> Element<'_, Message> {
+//! slider(0.0..=100.0, state.value, Message::ValueChanged).into()
+//! }
+//!
+//! fn update(state: &mut State, message: Message) {
+//! match message {
+//! Message::ValueChanged(value) => {
+//! state.value = value;
+//! }
+//! }
+//! }
+//! ```
use std::ops::RangeInclusive;
pub use crate::slider::{
@@ -29,16 +58,31 @@ use crate::core::{
///
/// # Example
/// ```no_run
-/// # type VerticalSlider<'a, T, Message> = iced_widget::VerticalSlider<'a, T, Message>;
+/// # 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>;
/// #
-/// #[derive(Clone)]
-/// pub enum Message {
-/// SliderChanged(f32),
+/// use iced::widget::vertical_slider;
+///
+/// struct State {
+/// value: f32,
/// }
///
-/// let value = 50.0;
+/// #[derive(Debug, Clone)]
+/// enum Message {
+/// ValueChanged(f32),
+/// }
///
-/// VerticalSlider::new(0.0..=100.0, value, Message::SliderChanged);
+/// fn view(state: &State) -> Element<'_, Message> {
+/// vertical_slider(0.0..=100.0, state.value, Message::ValueChanged).into()
+/// }
+///
+/// fn update(state: &mut State, message: Message) {
+/// match message {
+/// Message::ValueChanged(value) => {
+/// state.value = value;
+/// }
+/// }
+/// }
/// ```
#[allow(missing_debug_implementations)]
pub struct VerticalSlider<'a, T, Message, Theme = crate::Theme>