Show svg doc example in multiple places
This commit is contained in:
parent
10fa40a85f
commit
9773631354
2 changed files with 51 additions and 1 deletions
|
|
@ -1341,8 +1341,26 @@ pub fn image<Handle>(handle: impl Into<Handle>) -> crate::Image<Handle> {
|
||||||
|
|
||||||
/// Creates a new [`Svg`] widget from the given [`Handle`].
|
/// Creates a new [`Svg`] widget from the given [`Handle`].
|
||||||
///
|
///
|
||||||
|
/// Svg widgets display vector graphics in your application.
|
||||||
|
///
|
||||||
/// [`Svg`]: crate::Svg
|
/// [`Svg`]: crate::Svg
|
||||||
/// [`Handle`]: crate::svg::Handle
|
/// [`Handle`]: crate::svg::Handle
|
||||||
|
///
|
||||||
|
/// # 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::svg;
|
||||||
|
///
|
||||||
|
/// enum Message {
|
||||||
|
/// // ...
|
||||||
|
/// }
|
||||||
|
///
|
||||||
|
/// fn view(state: &State) -> Element<'_, Message> {
|
||||||
|
/// svg("tiger.svg").into()
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
#[cfg(feature = "svg")]
|
#[cfg(feature = "svg")]
|
||||||
pub fn svg<'a, Theme>(
|
pub fn svg<'a, Theme>(
|
||||||
handle: impl Into<core::svg::Handle>,
|
handle: impl Into<core::svg::Handle>,
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,20 @@
|
||||||
//! Display vector graphics in your application.
|
//! Svg widgets display vector graphics in your application.
|
||||||
|
//!
|
||||||
|
//! # 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::svg;
|
||||||
|
//!
|
||||||
|
//! enum Message {
|
||||||
|
//! // ...
|
||||||
|
//! }
|
||||||
|
//!
|
||||||
|
//! fn view(state: &State) -> Element<'_, Message> {
|
||||||
|
//! svg("tiger.svg").into()
|
||||||
|
//! }
|
||||||
|
//! ```
|
||||||
use crate::core::layout;
|
use crate::core::layout;
|
||||||
use crate::core::mouse;
|
use crate::core::mouse;
|
||||||
use crate::core::renderer;
|
use crate::core::renderer;
|
||||||
|
|
@ -19,6 +35,22 @@ pub use crate::core::svg::Handle;
|
||||||
///
|
///
|
||||||
/// [`Svg`] images can have a considerable rendering cost when resized,
|
/// [`Svg`] images can have a considerable rendering cost when resized,
|
||||||
/// specially when they are complex.
|
/// specially when they are complex.
|
||||||
|
///
|
||||||
|
/// # 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::svg;
|
||||||
|
///
|
||||||
|
/// enum Message {
|
||||||
|
/// // ...
|
||||||
|
/// }
|
||||||
|
///
|
||||||
|
/// fn view(state: &State) -> Element<'_, Message> {
|
||||||
|
/// svg("tiger.svg").into()
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
#[allow(missing_debug_implementations)]
|
#[allow(missing_debug_implementations)]
|
||||||
pub struct Svg<'a, Theme = crate::Theme>
|
pub struct Svg<'a, Theme = crate::Theme>
|
||||||
where
|
where
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue