Class Link

A clickable text element that can navigate to a URL or trigger an action.

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
BindableElement
TextElement
BaseTextElement
LocalizedTextElement
Link
BreadcrumbItem
Implements
Inherited Members
TextElement.HandleEventBubbleUp(EventBase)
VisualElement.Focus()
VisualElement.Overlaps(Rect)
VisualElement.ToString()
VisualElement.TryGetBinding(BindingId, out Binding)
VisualElement.TryGetDataSourceContext(BindingId, out DataSourceContext)
VisualElement.TryGetLastBindingToUIResult(in BindingId, out BindingResult)
VisualElement.TryGetLastBindingToSourceResult(in BindingId, out BindingResult)
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.cacheAsBitmap
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallbackOnce<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.RegisterCallbackOnce<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, CallbackOptions)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, CallbackOptions)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, CallbackOptions)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, CallbackOptions)
CallbackEventHandler.NotifyPropertyChanged(in BindingId)
Namespace: Unity.AppUI.UI
Assembly: Unity.AppUI.dll
[UxmlElement]
public class Link : LocalizedTextElement, IEventHandler, IResolvedStyle, ITransform, ITransitionAnimations, IVisualElementScheduler, IBindable, INotifyValueChanged<string>, ITextEdition, ITextElementExperimentalFeatures, IExperimentalFeatures, ITextSelection, IContextOverrideElement, IAdditionalDataHolder, IPressable

The Link component is a fundamental navigation element that allows users to navigate to different URLs or trigger actions within your application. Links are interactive text elements that can be clicked, focused, and activated using keyboard navigation.

Links can be styled with different text sizes to establish visual hierarchy and improve readability. They inherit text localization capabilities and support keyboard focus management for better accessibility.

Links should be visually distinguishable from regular text to indicate their interactive nature. Use appropriate styling (like underlines or distinct colors) to make links recognizable.

Basic Usage. Simple link with URL.

<Link text="Click me" url="https://example.com" />

Size Variants. Links with different sizes.

<VerticalStack spacing="10">
    <Link text="Small Link" size="S" />
    <Link text="Medium Link" size="M" />
    <Link text="Large Link" size="L" />
</VerticalStack>

Custom Click Handler. Link with custom click behavior.

var link = new Link("Custom Action");
link.clickable.clicked += () => {
    // Custom action
    Debug.Log("Link clicked!");
};

Localized Link. Link using localized text.

<Link text="@MyLocalizedText" url="https://example.com" />

Constructors

Link()

Default constructor.

Declaration
public Link()

Link(string)

Constructor.

Declaration
public Link(string text)
Parameters
Type Name Description
string text

The text of the link.

Link(string, string)

Constructor.

Declaration
public Link(string text, string url)
Parameters
Type Name Description
string text

The text of the link.
string url

The URL of the link.

Fields

The Link's size USS class name.

Declaration
public const string sizeUssClassName = "appui-link--size-"
Field Value
Type Description
string

The Link's USS class name.

Declaration
public const string ussClassName = "appui-link"
Field Value
Type Description
string

Properties

The clickable manipulator.

Declaration
[CreateProperty]
public Pressable clickable { get; set; }
Property Value
Type Description
Pressable

The size of the link.

Declaration
[CreateProperty]
[UxmlAttribute]
public TextSize size { get; set; }
Property Value
Type Description
TextSize

The URL of the link.

Declaration
[CreateProperty]
[UxmlAttribute]
public string url { get; set; }
Property Value
Type Description
string

Methods

GetSizeUssClassName(TextSize)

Declaration
public static string GetSizeUssClassName(TextSize enumValue)
Parameters
Type Name Description
TextSize enumValue
Returns
Type Description
string

Implements

Extension Methods