gpui-kit GitHub

Components

HoverCard view

A preview surface that opens on hover and can be pointed at.

A view survives a frame. Hold it in an Entity with cx.new(..) and reach it with .update(..).

use gpui_kit::overlay::HoverCard;

Construct

new(ident: impl Into<Ident>, _window: &mut Window, cx: &mut Context<Self>) -> Self

Options

Chain onto the value.

trigger(trigger: impl Fn(&mut Window, &mut App) -> AnyElement + 'static) -> Self
name(name: impl Into<SharedString>) -> Self
content(content: impl Fn(&mut Window, &mut App) -> AnyElement + 'static) -> Self
placement(placement: Placement) -> Self
open_delay(delay: Duration) -> Self
grace(grace: Duration) -> Self

Commands

Need a Context, so they need a view.

open(cx: &mut Context<Self>)
close(cx: &mut Context<Self>)
dismiss(window: &mut Window, cx: &mut Context<Self>)

Queries

Only answer; they change nothing.

is_open() -> bool
is_leaving() -> bool
grace_period() -> Duration

Reports

The variants of the event it emits. It never applies the change itself.

Rendered by

Each of these compiles and is captured by the gate, so the code behind them is verified rather than written.

Source: crates/gpui-kit/src/overlay/hover_card.rs