Interface RenderTooltipOptions

Options accepted by renderTooltip.

interface RenderTooltipOptions {
    height?: number;
    message: string;
    placement?: TooltipPlacement;
    showPlacement?: boolean;
    width?: number;
}

Index

Properties

height? message placement? showPlacement? width?

Properties

`Optional`height

height?: number

Maximum rendered height.

message

message: string

Tooltip content.

`Optional`placement

placement?: TooltipPlacement

Placement hint rendered as text for deterministic output.

`Optional`showPlacement

showPlacement?: boolean

Whether to include placement marker.

`Optional`width

width?: number

Maximum terminal-cell width of each line.