HyperlinkText class

A text widget that renders as a clickable hyperlink using OSC 8 escape sequences in terminals that support them.

When showUrl is true and label differs from url, the URL is shown in parentheses after the label as a fallback for terminals that do not support OSC 8. When showUrl is false (the default), only the styled label text is shown.

HyperlinkText(
  url: 'https://example.com',
  label: 'Example Website',
  showUrl: true, // renders: "Example Website (https://example.com)"
)
Inheritance

Constructors

HyperlinkText({required String url, String? label, Style? style, Color? linkColor, bool showUrl = false, Key? key})

Properties

children → List<Widget>
Child widgets that receive forwarded messages.
no setterinherited
debugRenderObjectPassthrough → bool
Whether this widget is intentionally transparent to render-object layouts.
no setterinherited
focusable → bool
Whether this widget can receive keyboard focus.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
Unique identifier for this widget.
no setterinherited
key → Key?
Key for preserving widget identity.
finalinherited
label → String?
Display text. If null, the URL itself is shown.
final
linkColor → Color?
Link color. Defaults to theme info/accent.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showUrl → bool
Whether to show the URL in parentheses after the label.
final
style → Style?
Optional base style. Defaults to theme body with underline.
final
theme → Theme
Access the current theme.
no setterinherited
url → String
The URL to link to.
final

Methods

build(BuildContext context) → Widget
Describes the part of the UI represented by this widget.
override
buildCachedView<T>(T builder(), Object? cacheKey) → T
Returns a cached view if the cache key matches.
inherited
handleInit() → Cmd?
Override this instead of init for widget-specific initialization.
inherited
handleIntercept(Msg msg) → (Widget, Cmd?)
Override this to handle messages before they reach children.
inherited
handleUpdate(Msg msg) → (Widget, Cmd?)
Override this to handle messages specific to this widget.
inherited
init() → Cmd?
Called once when the widget is first mounted.
inherited
invalidateCachedView() → void
Clears any cached view for this widget.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
update(Msg msg) → (Model, Cmd?)
Handles messages by forwarding to children then calling handleUpdate.
inherited
view() → Object
Renders the widget to a string or View.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited