Struct Tooltip 

pub struct Tooltip;

A tooltip component for displaying contextual information.

Tooltip displays a positioned overlay with helpful text relative to a target area. It implements:

• Component for update/view logic
• Toggleable for visibility control

Positioning

The tooltip can be positioned Above, Below, Left, or Right of its target. When there isn’t enough space for the preferred position, it automatically falls back to the opposite side.

Auto-hide

When configured with a duration, the tooltip automatically hides after the specified time. Send periodic Tick(elapsed_ms) messages to drive this functionality.

Visual Format

Target area [████████]

         ┌─────────────────┐
         │ Helpful tooltip │  ← Tooltip (Below)
         │ text here       │
         └─────────────────┘

Example

use envision::component::{Tooltip, TooltipMessage, TooltipOutput, TooltipState, Component, Toggleable};

let mut state = TooltipState::new("Click to submit")
    .with_duration(3000);

// Show the tooltip
let output = Tooltip::update(&mut state, TooltipMessage::Show);
assert_eq!(output, Some(TooltipOutput::Shown));

// Tick until it expires
let output = Tooltip::update(&mut state, TooltipMessage::Tick(3000));
assert_eq!(output, Some(TooltipOutput::Expired));
assert!(!state.is_visible());

Implementations

impl Tooltip

pub fn view_at( state: &TooltipState, frame: &mut Frame<'_>, target: Rect, bounds: Rect, )

Renders the tooltip relative to a target area within bounds.

This is the primary rendering method. Call this instead of view() when you need to position the tooltip relative to a specific target.

Arguments

• state - The tooltip state
• frame - The frame to render to
• target - The target area to position relative to
• bounds - The bounding area (typically frame.area())

Example

use envision::component::{Tooltip, TooltipState, Toggleable};
use ratatui::prelude::*;

let mut state = TooltipState::new("Button help text");
Tooltip::show(&mut state);
assert!(Tooltip::is_visible(&state));

Trait Implementations

impl Component for Tooltip

type State = TooltipState

The component’s internal state type.

type Message = TooltipMessage

Messages this component can receive.

type Output = TooltipOutput

Messages this component can emit to its parent.

fn init() -> Self::State

Initialize the component state.

fn update(state: &mut Self::State, msg: Self::Message) -> Option<Self::Output>

Update component state based on a message.

fn view( state: &Self::State, frame: &mut Frame<'_>, area: Rect, _theme: &Theme, _ctx: &ViewContext, )

Render the component to the given area.

fn traced_view( state: &Self::State, frame: &mut Frame<'_>, area: Rect, theme: &Theme, ctx: &ViewContext, )

Renders the component with optional tracing instrumentation.

fn handle_event(state: &Self::State, event: &Event) -> Option<Self::Message>

Maps an input event to a component message.

fn dispatch_event( state: &mut Self::State, event: &Event, ) -> Option<Self::Output>

Dispatches an event by mapping it to a message and updating state.

impl Toggleable for Tooltip

fn is_visible(state: &Self::State) -> bool

Returns true if this component is currently visible.

fn set_visible(state: &mut Self::State, visible: bool)

Sets the visibility of this component.

fn toggle(state: &mut Self::State)

Toggles the visibility of this component.

fn show(state: &mut Self::State)

Shows this component.

fn hide(state: &mut Self::State)

Hides this component.