Link

Properties

Property	Type	Description
inline	boolean	Whether the link should be styled for being displayed inside a text.
linkComponent	ComponentType<Omit<DetailedHTMLProps<AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "ref">>	An alternative link component.
color	defaultdarklightdark-staticlight-staticDefault: "default"	The color of the link.
slot	string
whiteSpace	WhiteSpace	The whiteSpace css value of the element.
size	smDefault: "m"	The size of the element.
id	string	The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).
translate	yesno
style	StyleOrFunction<TooltipRenderProps>	The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.
render	DOMRenderFunction<"div", TooltipRenderProps>	Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
dir	string
lang	string
hidden	boolean
inert	boolean
isDisabled	boolean	Whether the link is disabled.
autoFocus	boolean	Whether the element should receive focus on render.
rel	string	The relationship between the linked resource and the current page. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel).
target	HTMLAttributeAnchorTarget	The target window for the link. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).
href	string	A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href).
hrefLang	string	Hints at the human language of the linked URL. See[MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#hreflang).
download	stringboolean	Causes the browser to download the linked URL. A string may be provided to suggest a file name. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).
ping	string	A space-separated list of URLs to ping when the link is followed. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#ping).
referrerPolicy	HTMLAttributeReferrerPolicy	How much of the referrer to send when following the link. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#referrerpolicy).
routerOptions	undefined	Options for the configured client side router.
children	ReactNode
wrapWith	ReactElement<unknown, string | JSXElementConstructor<any>>
ref	Ref<HTMLSpanElement>	Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @see React Docs
key	Key
className	string	The elements class name.

Events

Property	Type	Description
onClick	((e: MouseEvent<FocusableElement, MouseEvent>) => void)	**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress` provided for compatibility with other libraries. `onPress` provides additional event details for non-mouse interactions.
onClickCapture	MouseEventHandler<HTMLDivElement>
onAuxClick	MouseEventHandler<HTMLDivElement>
onAuxClickCapture	MouseEventHandler<HTMLDivElement>
onContextMenu	MouseEventHandler<HTMLDivElement>
onContextMenuCapture	MouseEventHandler<HTMLDivElement>
onDoubleClick	MouseEventHandler<HTMLDivElement>
onDoubleClickCapture	MouseEventHandler<HTMLDivElement>
onMouseDown	MouseEventHandler<HTMLDivElement>
onMouseDownCapture	MouseEventHandler<HTMLDivElement>
onMouseEnter	MouseEventHandler<HTMLDivElement>
onMouseLeave	MouseEventHandler<HTMLDivElement>
onMouseMove	MouseEventHandler<HTMLDivElement>
onMouseMoveCapture	MouseEventHandler<HTMLDivElement>
onMouseOut	MouseEventHandler<HTMLDivElement>
onMouseOutCapture	MouseEventHandler<HTMLDivElement>
onMouseOver	MouseEventHandler<HTMLDivElement>
onMouseOverCapture	MouseEventHandler<HTMLDivElement>
onMouseUp	MouseEventHandler<HTMLDivElement>
onMouseUpCapture	MouseEventHandler<HTMLDivElement>
onTouchCancel	TouchEventHandler<HTMLDivElement>
onTouchCancelCapture	TouchEventHandler<HTMLDivElement>
onTouchEnd	TouchEventHandler<HTMLDivElement>
onTouchEndCapture	TouchEventHandler<HTMLDivElement>
onTouchMove	TouchEventHandler<HTMLDivElement>
onTouchMoveCapture	TouchEventHandler<HTMLDivElement>
onTouchStart	TouchEventHandler<HTMLDivElement>
onTouchStartCapture	TouchEventHandler<HTMLDivElement>
onPointerDown	PointerEventHandler<HTMLDivElement>
onPointerDownCapture	PointerEventHandler<HTMLDivElement>
onPointerMove	PointerEventHandler<HTMLDivElement>
onPointerMoveCapture	PointerEventHandler<HTMLDivElement>
onPointerUp	PointerEventHandler<HTMLDivElement>
onPointerUpCapture	PointerEventHandler<HTMLDivElement>
onPointerCancel	PointerEventHandler<HTMLDivElement>
onPointerCancelCapture	PointerEventHandler<HTMLDivElement>
onPointerEnter	PointerEventHandler<HTMLDivElement>
onPointerLeave	PointerEventHandler<HTMLDivElement>
onPointerOver	PointerEventHandler<HTMLDivElement>
onPointerOverCapture	PointerEventHandler<HTMLDivElement>
onPointerOut	PointerEventHandler<HTMLDivElement>
onPointerOutCapture	PointerEventHandler<HTMLDivElement>
onGotPointerCapture	PointerEventHandler<HTMLDivElement>
onGotPointerCaptureCapture	PointerEventHandler<HTMLDivElement>
onLostPointerCapture	PointerEventHandler<HTMLDivElement>
onLostPointerCaptureCapture	PointerEventHandler<HTMLDivElement>
onScroll	UIEventHandler<HTMLDivElement>
onScrollCapture	UIEventHandler<HTMLDivElement>
onWheel	WheelEventHandler<HTMLDivElement>
onWheelCapture	WheelEventHandler<HTMLDivElement>
onAnimationStart	AnimationEventHandler<HTMLDivElement>
onAnimationStartCapture	AnimationEventHandler<HTMLDivElement>
onAnimationEnd	AnimationEventHandler<HTMLDivElement>
onAnimationEndCapture	AnimationEventHandler<HTMLDivElement>
onAnimationIteration	AnimationEventHandler<HTMLDivElement>
onAnimationIterationCapture	AnimationEventHandler<HTMLDivElement>
onTransitionCancel	TransitionEventHandler<HTMLDivElement>
onTransitionCancelCapture	TransitionEventHandler<HTMLDivElement>
onTransitionEnd	TransitionEventHandler<HTMLDivElement>
onTransitionEndCapture	TransitionEventHandler<HTMLDivElement>
onTransitionRun	TransitionEventHandler<HTMLDivElement>
onTransitionRunCapture	TransitionEventHandler<HTMLDivElement>
onTransitionStart	TransitionEventHandler<HTMLDivElement>
onTransitionStartCapture	TransitionEventHandler<HTMLDivElement>
onFocus	((e: FocusEvent<Element, Element>) => void)	Handler that is called when the element receives focus.
onBlur	((e: FocusEvent<Element, Element>) => void)	Handler that is called when the element loses focus.
onFocusChange	((isFocused: boolean) => void)	Handler that is called when the element's focus status changes.
onKeyDown	((e: KeyboardEvent) => void)	Handler that is called when a key is pressed.
onKeyUp	((e: KeyboardEvent) => void)	Handler that is called when a key is released.
onPress	((e: PressEvent) => void)	Handler that is called when the press is released over the target.
onPressStart	((e: PressEvent) => void)	Handler that is called when a press interaction starts.
onPressEnd	((e: PressEvent) => void)	Handler that is called when a press interaction ends, either over the target or when the pointer leaves the target.
onPressChange	((isPressed: boolean) => void)	Handler that is called when the press state changes.
onPressUp	((e: PressEvent) => void)	Handler that is called when a press is released over the target, regardless of whether it started on the target or not.
onHoverStart	((e: HoverEvent) => void)	Handler that is called when a hover interaction starts.
onHoverEnd	((e: HoverEvent) => void)	Handler that is called when a hover interaction ends.
onHoverChange	((isHovering: boolean) => void)	Handler that is called when the hover state changes.

Accessibility

Property	Type	Description
aria-current	string
aria-label	string	Defines a string value that labels the current element.
aria-labelledby	string	Identifies the element (or elements) that labels the current element.
aria-describedby	string	Identifies the element (or elements) that describes the object.
aria-details	string	Identifies the element (or elements) that provide a detailed, extended description for the object.