summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-09-19 05:19:54 +0200
committerLibravatar Héctor Ramón Jiménez <hector@hecrj.dev>2024-09-19 05:19:54 +0200
commit24fcc57873bdf2605c9df26d240d67d8e26873ed (patch)
treecb94d8b6c85186014b4a8d728b42a5728f31a3b0
parentb778d5cd567679619809b05e672398d3141558fa (diff)
downloadiced-24fcc57873bdf2605c9df26d240d67d8e26873ed.tar.gz
iced-24fcc57873bdf2605c9df26d240d67d8e26873ed.tar.bz2
iced-24fcc57873bdf2605c9df26d240d67d8e26873ed.zip
Show `rule` doc example in multiple places
-rw-r--r--widget/src/helpers.rs34
-rw-r--r--widget/src/rule.rs36
2 files changed, 67 insertions, 3 deletions
diff --git a/widget/src/helpers.rs b/widget/src/helpers.rs
index 1e9bafa7..40a72452 100644
--- a/widget/src/helpers.rs
+++ b/widget/src/helpers.rs
@@ -1149,7 +1149,22 @@ pub fn vertical_space() -> Space {
/// Creates a horizontal [`Rule`] with the given height.
///
-/// [`Rule`]: crate::Rule
+/// # 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::horizontal_rule;
+///
+/// #[derive(Clone)]
+/// enum Message {
+/// // ...,
+/// }
+///
+/// fn view(state: &State) -> Element<'_, Message> {
+/// horizontal_rule(2).into()
+/// }
+/// ```
pub fn horizontal_rule<'a, Theme>(height: impl Into<Pixels>) -> Rule<'a, Theme>
where
Theme: rule::Catalog + 'a,
@@ -1159,7 +1174,22 @@ where
/// Creates a vertical [`Rule`] with the given width.
///
-/// [`Rule`]: crate::Rule
+/// # 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::vertical_rule;
+///
+/// #[derive(Clone)]
+/// enum Message {
+/// // ...,
+/// }
+///
+/// fn view(state: &State) -> Element<'_, Message> {
+/// vertical_rule(2).into()
+/// }
+/// ```
pub fn vertical_rule<'a, Theme>(width: impl Into<Pixels>) -> Rule<'a, Theme>
where
Theme: rule::Catalog + 'a,
diff --git a/widget/src/rule.rs b/widget/src/rule.rs
index bbcd577e..92199ca9 100644
--- a/widget/src/rule.rs
+++ b/widget/src/rule.rs
@@ -1,4 +1,21 @@
-//! Display a horizontal or vertical rule for dividing content.
+//! Rules divide space horizontally or 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::horizontal_rule;
+//!
+//! #[derive(Clone)]
+//! enum Message {
+//! // ...,
+//! }
+//!
+//! fn view(state: &State) -> Element<'_, Message> {
+//! horizontal_rule(2).into()
+//! }
+//! ```
use crate::core;
use crate::core::border;
use crate::core::layout;
@@ -10,6 +27,23 @@ use crate::core::{
};
/// Display a horizontal or vertical rule for dividing content.
+///
+/// # 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::horizontal_rule;
+///
+/// #[derive(Clone)]
+/// enum Message {
+/// // ...,
+/// }
+///
+/// fn view(state: &State) -> Element<'_, Message> {
+/// horizontal_rule(2).into()
+/// }
+/// ```
#[allow(missing_debug_implementations)]
pub struct Rule<'a, Theme = crate::Theme>
where