Struct Tooltip

Source
pub struct Tooltip<A = ()> { /* private fields */ }
Expand description

A non-interactive text tooltip attached to one trigger view.

Text is mounted in the host’s retained popup overlay through [PopupContent]. The trigger remains fully composable through Tooltip::child. Tooltip content is hit-tested by the popup host for correct z-order, but its non-interactive semantics never consume pointer input or enter focus traversal.

Hover opens after 500 ms and closes after a 100 ms grace period. Keyboard focus opens immediately; blur and Escape close immediately. Delays can be customized with Tooltip::open_delay and Tooltip::close_delay. Empty content, missing/zero-sized triggers, and disabled state make the tooltip unavailable and close any mounted popup.

§Examples

use ailloli_ui_widgets::controls::{Button, Tooltip};
let tooltip = Tooltip::with_label("Save changes")
    .child(Button::<()>::with_label("Save"));
let _ = tooltip;

Implementations§

Source§

impl<A: 'static> Tooltip<A>

Source

pub fn width(self, value: impl Into<Length>) -> Self

Sets preferred width from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().width(120.0);
let _ = widget;
Source

pub fn height(self, value: impl Into<Length>) -> Self

Sets preferred height from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().height(40.0);
let _ = widget;
Source

pub fn min_width(self, value: impl Into<Length>) -> Self

Sets the minimum width bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_width(40.0);
let _ = widget;
Source

pub fn max_width(self, value: impl Into<Length>) -> Self

Sets the maximum width bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_width(320.0);
let _ = widget;
Source

pub fn min_height(self, value: impl Into<Length>) -> Self

Sets the minimum height bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_height(24.0);
let _ = widget;
Source

pub fn max_height(self, value: impl Into<Length>) -> Self

Sets the maximum height bound.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_height(240.0);
let _ = widget;
Source

pub fn fill(self) -> Self

Sets both preferred axes to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill();
let _ = widget;
Source

pub fn fill_width(self) -> Self

Sets preferred width to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_width();
let _ = widget;
Source

pub fn fill_height(self) -> Self

Sets preferred height to parent fill.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_height();
let _ = widget;
Source

pub fn margin(self, value: f32) -> Self

Sets uniform outer margin in logical pixels.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().margin(8.0);
let _ = widget;
Source

pub fn padding(self, value: f32) -> Self

Sets uniform inner padding in logical pixels.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().padding(8.0);
let _ = widget;
Source

pub fn flex_grow(self) -> Self

Sets flex-grow weight to one.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow();
let _ = widget;
Source

pub fn flex_grow_by(self, value: f32) -> Self

Sets a dimensionless flex-grow weight.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow_by(2.0);
let _ = widget;
Source

pub fn flex_shrink(self, value: f32) -> Self

Sets a dimensionless flex-shrink weight.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_shrink(1.0);
let _ = widget;
Source

pub fn flex_basis(self, value: impl Into<Length>) -> Self

Sets the preferred main-axis flex basis.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_basis(80.0);
let _ = widget;
Source

pub fn align_self(self, value: AlignItems) -> Self

Overrides cross-axis alignment for this flex item.

§Examples
use ailloli_ui_core::style::AlignItems;
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().align_self(AlignItems::Center);
let _ = widget;
Source§

impl<A: 'static> Tooltip<A>

Source

pub fn new() -> Self

Creates an empty tooltip. Add text with Self::content and a trigger with Self::child.

Defaults are top/center placement, 500 ms hover-open delay, 100 ms hover-close grace, and a 6-logical-pixel gap.

§Examples
use ailloli_ui_widgets::controls::Tooltip;
let tooltip: Tooltip<()> = Tooltip::new();
let _ = tooltip;
Source

pub fn with_label(content: impl Into<Binding<String>>) -> Self

Creates a tooltip with retained text content.

A trigger must still be supplied with Self::child. Empty current content makes the tooltip unavailable.

§Examples
use ailloli_ui_widgets::controls::Tooltip;
let tooltip: Tooltip<()> = Tooltip::with_label("Keyboard shortcut");
let _ = tooltip;
Source

pub fn content(self, content: impl Into<Binding<String>>) -> Self

Sets the text rendered in the retained popup bubble.

Static strings, Signal<String>, State<String>, and Memo<String> are accepted through [Binding]. Arbitrary public view content remains intentionally deferred while the shared portal already mounts this specialized text subtree in the top-level overlay.

A later call replaces the previous binding. "" does not mount an empty bubble; it disables and closes the tooltip until the binding is nonempty.

§Examples
use ailloli_ui_runtime::component::Memo;
use ailloli_ui_widgets::controls::Tooltip;
let tooltip: Tooltip<()> = Tooltip::new().content(Memo::new(|| "Help".to_string()));
let _ = tooltip;
Source

pub fn child(self, child: impl IntoView<A>) -> Self

Sets or replaces the trigger view.

A trigger must resolve to nonzero width and height. Focusable children keep normal focus routing; the tooltip shell is only a fallback focus target for a non-focusable trigger.

§Examples
use ailloli_ui_widgets::controls::{Button, Tooltip};
let tooltip = Tooltip::with_label("Create").child(Button::<()>::with_label("New"));
let _ = tooltip;
Source

pub fn placement(self, placement: PopupPlacement) -> Self

Sets the preferred side of the popup relative to its trigger.

When a window viewport is available, placement may flip and clamps to remain visible; headless fallback uses the requested placement directly.

§Examples
use ailloli_ui_widgets::controls::{PopupPlacement, Tooltip};
let tooltip: Tooltip<()> = Tooltip::with_label("Details").placement(PopupPlacement::Bottom);
let _ = tooltip;
Source

pub fn alignment(self, alignment: PopupAlignment) -> Self

Sets popup alignment along the side selected by Self::placement.

§Examples
use ailloli_ui_widgets::controls::{PopupAlignment, Tooltip};
let tooltip: Tooltip<()> = Tooltip::with_label("Details").alignment(PopupAlignment::Start);
let _ = tooltip;
Source

pub fn disabled(self, disabled: impl Into<Binding<bool>>) -> Self

Sets a static or reactive disabled binding.

Disabled state closes the popup, cancels pending phases, and removes the tooltip shell from focus traversal; it does not disable the child itself.

§Examples
use ailloli_ui_widgets::controls::Tooltip;
let tooltip: Tooltip<()> = Tooltip::with_label("Unavailable").disabled(true);
let _ = tooltip;
Source

pub fn disabled_signal(self, disabled: Memo<bool>) -> Self

Convenience alias for Self::disabled with a reactive memo.

§Examples
use ailloli_ui_runtime::component::Memo;
use ailloli_ui_widgets::controls::Tooltip;
let tooltip: Tooltip<()> = Tooltip::with_label("Help").disabled_signal(Memo::new(|| false));
let _ = tooltip;
Source

pub fn open_delay(self, delay: Duration) -> Self

Sets the hover-open delay.

Duration::ZERO opens on the same phase resolution without scheduling a timer. Keyboard focus still opens immediately regardless of this value.

§Examples
use std::time::Duration;
use ailloli_ui_widgets::controls::Tooltip;
let tooltip: Tooltip<()> = Tooltip::with_label("Instant").open_delay(Duration::ZERO);
let _ = tooltip;
Source

pub fn close_delay(self, delay: Duration) -> Self

Sets the grace period after hover leaves an already painted tooltip.

This delay does not apply to blur, Escape, disabling, empty content, or leaving during the opening phase. Zero closes on the same phase update.

§Examples
use std::time::Duration;
use ailloli_ui_widgets::controls::Tooltip;
let tooltip: Tooltip<()> =
    Tooltip::with_label("Help").close_delay(Duration::from_millis(250));
let _ = tooltip;
Source

pub fn gap(self, gap: f32) -> Self

Sets trigger-to-popup separation in logical pixels, clamped to zero.

NaN is treated as zero.

§Examples
use ailloli_ui_widgets::controls::Tooltip;
let tooltip: Tooltip<()> = Tooltip::with_label("Help").gap(8.0);
let _ = tooltip;
Source

pub fn tooltip_style(self, style: TooltipStyle) -> Self

Replaces bubble colors, typography, padding, radius, and wrap width.

The maximum text width is clamped to zero when measured; padding and radius are otherwise accepted as-is.

§Examples
use ailloli_ui_widgets::controls::{Tooltip, TooltipStyle};
let tooltip: Tooltip<()> =
    Tooltip::with_label("Help").tooltip_style(TooltipStyle::default());
let _ = tooltip;

Trait Implementations§

Source§

impl<A: 'static> Default for Tooltip<A>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<A: 'static> IntoView<A> for Tooltip<A>

Source§

fn into_view(self) -> View<A>

Consumes a builder/value and returns its declarative view tree. Read more
Source§

impl<A: 'static> LayoutExt for Tooltip<A>

Source§

fn layout_mut(&mut self) -> &mut LayoutStyle

Returns the widget’s mutable declarative size/inset state. Read more

Auto Trait Implementations§

§

impl<A> Freeze for Tooltip<A>

§

impl<A = ()> !RefUnwindSafe for Tooltip<A>

§

impl<A = ()> !Send for Tooltip<A>

§

impl<A = ()> !Sync for Tooltip<A>

§

impl<A> Unpin for Tooltip<A>

§

impl<A = ()> !UnwindSafe for Tooltip<A>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T, A> FlexItemExt<A> for T
where T: IntoView<A>,

Source§

fn flex_grow(self) -> View<A>

Sets flex-grow weight to one. Read more
Source§

fn flex_grow_by(self, value: f32) -> View<A>

Sets the dimensionless flex-grow weight. Read more
Source§

fn flex_shrink(self, value: f32) -> View<A>

Sets the dimensionless flex-shrink weight. Read more
Source§

fn flex_basis(self, value: impl Into<Length>) -> View<A>

Sets the preferred main-axis flex basis. Read more
Source§

fn align_self(self, value: AlignItems) -> View<A>

Overrides the parent cross-axis alignment for this view. Read more
Source§

fn fill_width(self) -> View<A>

Marks width as parent-fill in the view size hint. Read more
Source§

fn fill_height(self) -> View<A>

Marks height as parent-fill in the view size hint. Read more
Source§

fn fill(self) -> View<A>

Marks both axes as parent-fill in the view size hint. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T, A> IntoViewKeyExt<A> for T
where T: IntoView<A>,

§

fn key(self, key: impl Into<String>) -> View<A>

Converts self, assigns the owned key, and returns the view. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,