Struct Popup 

pub struct Popup {

    pub kind: PopupKind,
    pub title: Option<String>,
    pub description: Option<String>,
    pub transient: bool,
    pub content: PopupContent,
    pub position: PopupPosition,
    pub width: u16,
    pub max_height: u16,
    pub bordered: bool,
    pub border_style: Style,
    pub background_style: Style,
    pub scroll_offset: usize,
    pub text_selection: Option<PopupTextSelection>,
    pub accept_key_hint: Option<String>,
}

A popup/floating window This is a general-purpose UI primitive that can be used for:

• Completion menus
• Hover documentation
• Command palette
• File picker
• Diagnostic messages
• Quick fixes / code actions

Fields

kind: PopupKind

Kind of popup - determines input handling behavior

title: Option<String>

Title of the popup (optional)

description: Option<String>

Description text shown below title, above content (optional)

transient: bool

Whether this popup is transient (dismissed on focus loss, e.g. hover, signature help)

content: PopupContent

Content to display

position: PopupPosition

Position strategy

width: u16

Width of popup (in columns)

max_height: u16

Maximum height (will be clamped to available space)

bordered: bool

Whether to show borders

border_style: Style

Border style

background_style: Style

Background style

scroll_offset: usize

Scroll offset for content (for scrolling through long lists)

text_selection: Option<PopupTextSelection>

Text selection for copy/paste (None if no selection)

accept_key_hint: Option<String>

Key hint shown right-aligned on the selected item (e.g. “(Tab)”)

Implementations

impl Popup

pub fn text(content: Vec<String>, theme: &Theme) -> Self

Create a new popup with text content using theme colors

pub fn markdown( markdown_text: &str, theme: &Theme, registry: Option<&GrammarRegistry>, ) -> Self

Create a new popup with markdown content using theme colors

If registry is provided, code blocks will have syntax highlighting for ~150+ languages via syntect.

pub fn list(items: Vec<PopupListItem>, theme: &Theme) -> Self

Create a new popup with a list of items using theme colors

pub fn with_title(self, title: String) -> Self

Set the title

pub fn with_kind(self, kind: PopupKind) -> Self

Set the popup kind (determines input handling behavior)

pub fn with_transient(self, transient: bool) -> Self

Mark this popup as transient (will be dismissed on focus loss)

pub fn with_position(self, position: PopupPosition) -> Self

Set the position

pub fn with_width(self, width: u16) -> Self

Set the width

pub fn with_max_height(self, max_height: u16) -> Self

Set the max height

pub fn with_border_style(self, style: Style) -> Self

Set border style

pub fn selected_item(&self) -> Option<&PopupListItem>

Get the currently selected item (if this is a list popup)

pub fn select_next(&mut self)

Move selection down (for list popups)

pub fn select_prev(&mut self)

Move selection up (for list popups)

pub fn select_index(&mut self, index: usize) -> bool

Select a specific item by index. Returns true if the index was valid.

pub fn page_down(&mut self)

Scroll down by one page

pub fn page_up(&mut self)

Scroll up by one page

pub fn select_first(&mut self)

Select the first item (for list popups)

pub fn select_last(&mut self)

Select the last item (for list popups)

pub fn scroll_by(&mut self, delta: i32)

Scroll by a delta amount (positive = down, negative = up) Used for mouse wheel scrolling

pub fn item_count(&self) -> usize

Get the total number of items/lines in the popup

pub fn start_selection(&mut self, line: usize, col: usize)

Start text selection at position (used for mouse click)

pub fn extend_selection(&mut self, line: usize, col: usize)

Extend text selection to position (used for mouse drag)

pub fn clear_selection(&mut self)

Clear text selection

pub fn has_selection(&self) -> bool

Check if popup has active text selection

pub fn get_selected_text(&self) -> Option<String>

Get selected text from popup content

pub fn needs_scrollbar(&self) -> bool

Check if the popup needs a scrollbar (content exceeds visible area)

pub fn scroll_state(&self) -> (usize, usize, usize)

Get scroll state for scrollbar rendering

pub fn link_at_position( &self, relative_col: usize, relative_row: usize, ) -> Option<String>

Find the link URL at a given relative position within the popup content area. relative_col and relative_row are relative to the inner content area (after borders). Returns None if:

• The popup doesn’t contain markdown content
• The position doesn’t have a link

pub fn description_height(&self) -> u16

Get the height of the description area (including blank line separator) Returns 0 if there is no description.

pub fn calculate_area( &self, terminal_area: Rect, cursor_pos: Option<(u16, u16)>, ) -> Rect

Calculate the area where this popup should be rendered

pub fn render(&self, frame: &mut Frame<'_>, area: Rect, theme: &Theme)

Render the popup to the frame

pub fn render_with_hover( &self, frame: &mut Frame<'_>, area: Rect, theme: &Theme, hover_target: Option<&HoverTarget>, )

Render the popup to the frame with hover highlighting

Trait Implementations

impl Clone for Popup

fn clone(&self) -> Popup

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Popup

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Popup

fn eq(&self, other: &Popup) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Popup