Show tooltip doc example in multiple places
This commit is contained in:
parent
22fbb9c221
commit
4e38992636
2 changed files with 68 additions and 3 deletions
|
|
@ -743,8 +743,29 @@ where
|
||||||
/// Creates a new [`Tooltip`] for the provided content with the given
|
/// Creates a new [`Tooltip`] for the provided content with the given
|
||||||
/// [`Element`] and [`tooltip::Position`].
|
/// [`Element`] and [`tooltip::Position`].
|
||||||
///
|
///
|
||||||
/// [`Tooltip`]: crate::Tooltip
|
/// Tooltips display a hint of information over some element when hovered.
|
||||||
/// [`tooltip::Position`]: crate::tooltip::Position
|
///
|
||||||
|
/// # 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, tooltip};
|
||||||
|
///
|
||||||
|
/// enum Message {
|
||||||
|
/// // ...
|
||||||
|
/// }
|
||||||
|
///
|
||||||
|
/// fn view(_state: &State) -> Element<'_, Message> {
|
||||||
|
/// tooltip(
|
||||||
|
/// "Hover me to display the tooltip!",
|
||||||
|
/// container("This is the tooltip contents!")
|
||||||
|
/// .padding(10)
|
||||||
|
/// .style(container::rounded_box),
|
||||||
|
/// tooltip::Position::Bottom,
|
||||||
|
/// ).into()
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
pub fn tooltip<'a, Message, Theme, Renderer>(
|
pub fn tooltip<'a, Message, Theme, Renderer>(
|
||||||
content: impl Into<Element<'a, Message, Theme, Renderer>>,
|
content: impl Into<Element<'a, Message, Theme, Renderer>>,
|
||||||
tooltip: impl Into<Element<'a, Message, Theme, Renderer>>,
|
tooltip: impl Into<Element<'a, Message, Theme, Renderer>>,
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,26 @@
|
||||||
//! Display a widget over another.
|
//! Tooltips display a hint of information over some element when hovered.
|
||||||
|
//!
|
||||||
|
//! # 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, tooltip};
|
||||||
|
//!
|
||||||
|
//! enum Message {
|
||||||
|
//! // ...
|
||||||
|
//! }
|
||||||
|
//!
|
||||||
|
//! fn view(_state: &State) -> Element<'_, Message> {
|
||||||
|
//! tooltip(
|
||||||
|
//! "Hover me to display the tooltip!",
|
||||||
|
//! container("This is the tooltip contents!")
|
||||||
|
//! .padding(10)
|
||||||
|
//! .style(container::rounded_box),
|
||||||
|
//! tooltip::Position::Bottom,
|
||||||
|
//! ).into()
|
||||||
|
//! }
|
||||||
|
//! ```
|
||||||
use crate::container;
|
use crate::container;
|
||||||
use crate::core::event::{self, Event};
|
use crate::core::event::{self, Event};
|
||||||
use crate::core::layout::{self, Layout};
|
use crate::core::layout::{self, Layout};
|
||||||
|
|
@ -13,6 +35,28 @@ use crate::core::{
|
||||||
};
|
};
|
||||||
|
|
||||||
/// An element to display a widget over another.
|
/// An element to display a widget over another.
|
||||||
|
///
|
||||||
|
/// # 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, tooltip};
|
||||||
|
///
|
||||||
|
/// enum Message {
|
||||||
|
/// // ...
|
||||||
|
/// }
|
||||||
|
///
|
||||||
|
/// fn view(_state: &State) -> Element<'_, Message> {
|
||||||
|
/// tooltip(
|
||||||
|
/// "Hover me to display the tooltip!",
|
||||||
|
/// container("This is the tooltip contents!")
|
||||||
|
/// .padding(10)
|
||||||
|
/// .style(container::rounded_box),
|
||||||
|
/// tooltip::Position::Bottom,
|
||||||
|
/// ).into()
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
#[allow(missing_debug_implementations)]
|
#[allow(missing_debug_implementations)]
|
||||||
pub struct Tooltip<
|
pub struct Tooltip<
|
||||||
'a,
|
'a,
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue