Show image doc example in multiple places
This commit is contained in:
parent
96615d5537
commit
e98a441b0f
2 changed files with 50 additions and 7 deletions
|
|
@ -1047,7 +1047,26 @@ where
|
||||||
|
|
||||||
/// Creates a new [`Image`].
|
/// Creates a new [`Image`].
|
||||||
///
|
///
|
||||||
|
/// Images display raster graphics in different formats (PNG, JPG, etc.).
|
||||||
|
///
|
||||||
/// [`Image`]: crate::Image
|
/// [`Image`]: crate::Image
|
||||||
|
///
|
||||||
|
/// # 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::image;
|
||||||
|
///
|
||||||
|
/// enum Message {
|
||||||
|
/// // ...
|
||||||
|
/// }
|
||||||
|
///
|
||||||
|
/// fn view(state: &State) -> Element<'_, Message> {
|
||||||
|
/// image("ferris.png").into()
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
|
/// <img src="https://github.com/iced-rs/iced/blob/9712b319bb7a32848001b96bd84977430f14b623/examples/resources/ferris.png?raw=true" width="300">
|
||||||
#[cfg(feature = "image")]
|
#[cfg(feature = "image")]
|
||||||
pub fn image<Handle>(handle: impl Into<Handle>) -> crate::Image<Handle> {
|
pub fn image<Handle>(handle: impl Into<Handle>) -> crate::Image<Handle> {
|
||||||
crate::Image::new(handle.into())
|
crate::Image::new(handle.into())
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,21 @@
|
||||||
//! Display images in your user interface.
|
//! Images display raster graphics in different formats (PNG, JPG, etc.).
|
||||||
|
//!
|
||||||
|
//! # 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::image;
|
||||||
|
//!
|
||||||
|
//! enum Message {
|
||||||
|
//! // ...
|
||||||
|
//! }
|
||||||
|
//!
|
||||||
|
//! fn view(state: &State) -> Element<'_, Message> {
|
||||||
|
//! image("ferris.png").into()
|
||||||
|
//! }
|
||||||
|
//! ```
|
||||||
|
//! <img src="https://github.com/iced-rs/iced/blob/9712b319bb7a32848001b96bd84977430f14b623/examples/resources/ferris.png?raw=true" width="300">
|
||||||
pub mod viewer;
|
pub mod viewer;
|
||||||
pub use viewer::Viewer;
|
pub use viewer::Viewer;
|
||||||
|
|
||||||
|
|
@ -22,16 +39,23 @@ pub fn viewer<Handle>(handle: Handle) -> Viewer<Handle> {
|
||||||
/// A frame that displays an image while keeping aspect ratio.
|
/// A frame that displays an image while keeping aspect ratio.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Example
|
||||||
///
|
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// # use iced_widget::image::{self, Image};
|
/// # mod iced { pub mod widget { pub use iced_widget::*; } }
|
||||||
/// #
|
/// # pub type State = ();
|
||||||
/// let image = Image::<image::Handle>::new("resources/ferris.png");
|
/// # pub type Element<'a, Message> = iced_widget::core::Element<'a, Message, iced_widget::Theme, iced_widget::Renderer>;
|
||||||
/// ```
|
/// use iced::widget::image;
|
||||||
///
|
///
|
||||||
|
/// enum Message {
|
||||||
|
/// // ...
|
||||||
|
/// }
|
||||||
|
///
|
||||||
|
/// fn view(state: &State) -> Element<'_, Message> {
|
||||||
|
/// image("ferris.png").into()
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
/// <img src="https://github.com/iced-rs/iced/blob/9712b319bb7a32848001b96bd84977430f14b623/examples/resources/ferris.png?raw=true" width="300">
|
/// <img src="https://github.com/iced-rs/iced/blob/9712b319bb7a32848001b96bd84977430f14b623/examples/resources/ferris.png?raw=true" width="300">
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
pub struct Image<Handle> {
|
pub struct Image<Handle = image::Handle> {
|
||||||
handle: Handle,
|
handle: Handle,
|
||||||
width: Length,
|
width: Length,
|
||||||
height: Length,
|
height: Length,
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue