Show container doc example in multiple places
This commit is contained in:
parent
3e6e669c4c
commit
96615d5537
3 changed files with 65 additions and 11 deletions
|
|
@ -1,8 +1,6 @@
|
||||||
//! Draw 2D graphics for your users.
|
//! Canvases can be leveraged to draw interactive 2D graphics.
|
||||||
//!
|
//!
|
||||||
//! # Example: Drawing a Simple Circle
|
//! # Example: Drawing a Simple Circle
|
||||||
//! Here's how we can use a [`Canvas`] to draw a simple circle:
|
|
||||||
//!
|
|
||||||
//! ```no_run
|
//! ```no_run
|
||||||
//! # mod iced { pub mod widget { pub use iced_widget::*; } pub use iced_widget::Renderer; pub use iced_widget::core::*; }
|
//! # mod iced { pub mod widget { pub use iced_widget::*; } pub use iced_widget::Renderer; pub use iced_widget::core::*; }
|
||||||
//! # pub type State = ();
|
//! # pub type State = ();
|
||||||
|
|
@ -91,8 +89,6 @@ pub type Frame<Renderer = crate::Renderer> = geometry::Frame<Renderer>;
|
||||||
/// A widget capable of drawing 2D graphics.
|
/// A widget capable of drawing 2D graphics.
|
||||||
///
|
///
|
||||||
/// # Example: Drawing a Simple Circle
|
/// # Example: Drawing a Simple Circle
|
||||||
/// Here's how we can use a [`Canvas`] to draw a simple circle:
|
|
||||||
///
|
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// # mod iced { pub mod widget { pub use iced_widget::*; } pub use iced_widget::Renderer; pub use iced_widget::core::*; }
|
/// # mod iced { pub mod widget { pub use iced_widget::*; } pub use iced_widget::Renderer; pub use iced_widget::core::*; }
|
||||||
/// # pub type State = ();
|
/// # pub type State = ();
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,24 @@
|
||||||
//! Decorate content and apply alignment.
|
//! Containers let you align a widget inside their boundaries.
|
||||||
|
//!
|
||||||
|
//! # 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::container;
|
||||||
|
//!
|
||||||
|
//! enum Message {
|
||||||
|
//! // ...
|
||||||
|
//! }
|
||||||
|
//!
|
||||||
|
//! fn view(state: &State) -> Element<'_, Message> {
|
||||||
|
//! container("This text is centered inside a rounded box!")
|
||||||
|
//! .padding(10)
|
||||||
|
//! .center(800)
|
||||||
|
//! .style(container::rounded_box)
|
||||||
|
//! .into()
|
||||||
|
//! }
|
||||||
|
//! ```
|
||||||
use crate::core::alignment::{self, Alignment};
|
use crate::core::alignment::{self, Alignment};
|
||||||
use crate::core::border::{self, Border};
|
use crate::core::border::{self, Border};
|
||||||
use crate::core::event::{self, Event};
|
use crate::core::event::{self, Event};
|
||||||
|
|
@ -16,9 +36,27 @@ use crate::core::{
|
||||||
};
|
};
|
||||||
use crate::runtime::task::{self, Task};
|
use crate::runtime::task::{self, Task};
|
||||||
|
|
||||||
/// An element decorating some content.
|
/// A widget that aligns its contents inside of its boundaries.
|
||||||
///
|
///
|
||||||
/// It is normally used for alignment purposes.
|
/// # 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::container;
|
||||||
|
///
|
||||||
|
/// enum Message {
|
||||||
|
/// // ...
|
||||||
|
/// }
|
||||||
|
///
|
||||||
|
/// fn view(state: &State) -> Element<'_, Message> {
|
||||||
|
/// container("This text is centered inside a rounded box!")
|
||||||
|
/// .padding(10)
|
||||||
|
/// .center(800)
|
||||||
|
/// .style(container::rounded_box)
|
||||||
|
/// .into()
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
#[allow(missing_debug_implementations)]
|
#[allow(missing_debug_implementations)]
|
||||||
pub struct Container<
|
pub struct Container<
|
||||||
'a,
|
'a,
|
||||||
|
|
|
||||||
|
|
@ -128,7 +128,27 @@ macro_rules! rich_text {
|
||||||
|
|
||||||
/// Creates a new [`Container`] with the provided content.
|
/// Creates a new [`Container`] with the provided content.
|
||||||
///
|
///
|
||||||
/// [`Container`]: crate::Container
|
/// Containers let you align a widget inside their boundaries.
|
||||||
|
///
|
||||||
|
/// # 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::container;
|
||||||
|
///
|
||||||
|
/// enum Message {
|
||||||
|
/// // ...
|
||||||
|
/// }
|
||||||
|
///
|
||||||
|
/// fn view(state: &State) -> Element<'_, Message> {
|
||||||
|
/// container("This text is centered inside a rounded box!")
|
||||||
|
/// .padding(10)
|
||||||
|
/// .center(800)
|
||||||
|
/// .style(container::rounded_box)
|
||||||
|
/// .into()
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
pub fn container<'a, Message, Theme, Renderer>(
|
pub fn container<'a, Message, Theme, Renderer>(
|
||||||
content: impl Into<Element<'a, Message, Theme, Renderer>>,
|
content: impl Into<Element<'a, Message, Theme, Renderer>>,
|
||||||
) -> Container<'a, Message, Theme, Renderer>
|
) -> Container<'a, Message, Theme, Renderer>
|
||||||
|
|
@ -1084,11 +1104,11 @@ where
|
||||||
|
|
||||||
/// Creates a new [`Canvas`].
|
/// Creates a new [`Canvas`].
|
||||||
///
|
///
|
||||||
|
/// Canvases can be leveraged to draw interactive 2D graphics.
|
||||||
|
///
|
||||||
/// [`Canvas`]: crate::Canvas
|
/// [`Canvas`]: crate::Canvas
|
||||||
///
|
///
|
||||||
/// # Example: Drawing a Simple Circle
|
/// # Example: Drawing a Simple Circle
|
||||||
/// Here's how we can use a [`Canvas`] to draw a simple circle:
|
|
||||||
///
|
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// # mod iced { pub mod widget { pub use iced_widget::*; } pub use iced_widget::Renderer; pub use iced_widget::core::*; }
|
/// # mod iced { pub mod widget { pub use iced_widget::*; } pub use iced_widget::Renderer; pub use iced_widget::core::*; }
|
||||||
/// # pub type State = ();
|
/// # pub type State = ();
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue