HyperlinkWidget

Display clickable hyperlinks in your terminal UI using OSC 8 escape sequences.

In terminals that support OSC 8 (most modern terminals like iTerm2, Windows Terminal, GNOME Terminal, and Konsole), the text renders as a clickable link. In unsupported terminals, the text displays normally without link functionality.

Basic Usage

Create hyperlinks using the fluent API:

csharp

dotnet run

Web Terminal Note

In the live demo above, use Shift+Click to open links. Native terminals typically use Ctrl+Click (or Cmd+Click on macOS), but xterm.js reserves Shift+Click for bypassing mouse tracking mode.

Hyperlinks are focusable widgets. Users can navigate between links using Tab and activate them with Enter.

Click Handlers

Handle link activation in your application:

csharp

dotnet run

Web Terminal Note

In the live demo above, use Shift+Click to open links. Native terminals typically use Ctrl+Click (or Cmd+Click on macOS), but xterm.js reserves Shift+Click for bypassing mouse tracking mode.

The OnClick handler receives HyperlinkClickedEventArgs with access to:

• Uri - The link's target URL
• Text - The visible link text
• Context - Access to the application context for state updates

Terminal-Native Links

Even without an OnClick handler, OSC 8 links remain clickable in supported terminals. The terminal handles navigation natively when users Ctrl+Click or Cmd+Click the link.

Text Overflow Behavior

HyperlinkWidget supports the same overflow modes as TextWidget:

csharp

dotnet run

Web Terminal Note

In the live demo above, use Shift+Click to open links. Native terminals typically use Ctrl+Click (or Cmd+Click on macOS), but xterm.js reserves Shift+Click for bypassing mouse tracking mode.

Truncate (Default)

Text is clipped when it extends beyond its bounds:

csharp

Wrap

Text wraps to multiple lines at word boundaries:

csharp

Ellipsis

Text is truncated with "..." when it exceeds the width:

csharp

Link Parameters

OSC 8 supports optional parameters for advanced link behavior:

Grouping Links with IDs

Use WithId to group multiple hyperlink segments as a single logical link. This is useful when a link spans multiple lines or elements:

csharp

When grouped, terminals highlight all segments together on hover.

Custom Parameters

Use WithParameters for arbitrary OSC 8 parameters:

csharp

TIP

In practice, only the id parameter is routinely used. For link grouping, prefer the WithId method shown above—it's more readable and type-safe.

Default Bindings

HyperlinkWidget registers these input bindings when a click handler is set:

Input	Action
Enter	Open link
Left mouse click	Open link

Custom Bindings

You can add additional keyboard shortcuts or custom bindings to any widget. See the Input Handling guide for details on working with input bindings.

Related Widgets

• TextWidget - For non-interactive text display
• ButtonWidget - For button-style interactions