Raxol.Terminal.Tooltip (Raxol v2.0.1)

View Source

Tooltip display functionality for terminal UI.

This module provides tooltip rendering capabilities for terminal applications, allowing contextual help text to appear on hover or focus.

Summary

Functions

Returns a specification to start this module under a supervisor.

Hides the currently displayed tooltip.

Starts the tooltip server.

Shows a tooltip with the given text at the current cursor position.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

handle_manager_info(msg, state)

Callback implementation for Raxol.Core.Behaviours.BaseManager.handle_manager_info/2.

hide()

@spec hide() :: :ok

Hides the currently displayed tooltip.

Examples

Raxol.Terminal.Tooltip.hide()

init_manager(opts)

Starts the tooltip server.

show(text)

@spec show(String.t()) :: :ok

Shows a tooltip with the given text at the current cursor position.

Parameters

  • text - The text to display in the tooltip

Examples

Raxol.Terminal.Tooltip.show("Click to submit")

start_link(init_opts \\ [])