Link API

API reference docs for the React Link component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Link

Import

import Link from '@mui/joy/Link';
// or
import { Link } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

Name	Type	Default	Description
children	node	-	The content of the component.
color	'danger' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	'primary'	The color of the link. To learn how to add your own colors, check out Themed components—Extend colors.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
disabled	bool	false	If `true`, the component is disabled.
endDecorator	node	-	Element placed after the children.
level	'body1' \| 'body2' \| 'body3' \| 'h1' \| 'h2' \| 'h3' \| 'h4' \| 'h5' \| 'h6' \| 'inherit' \| string	'body-md'	Applies the theme typography styles.
overlay	bool	false	If `true`, the ::after pseudo element is added to cover the area of interaction. The parent of the overlay Link should have `relative` CSS position.
slotProps	{ endDecorator?: func \| object, root?: func \| object, startDecorator?: func \| object }	{}	The props used for each slot inside.
slots	{ endDecorator?: elementType, root?: elementType, startDecorator?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
startDecorator	node	-	Element placed before the children.
sx	Array<func \| object \| bool> \| func \| object	-	The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
textColor	any	-	The system color.
underline	'always' \| 'hover' \| 'none'	'hover'	Controls when the link should have an underline.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'plain'	Applies the theme link styles. To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

You can use JoyLink to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Slot name	Class name	Default component	Description
root	.MuiLink-root	`'a'`	The component that renders the root.
startDecorator	.MuiLink-startDecorator	`'span'`	The component that renders the start decorator.
endDecorator	.MuiLink-endDecorator	`'span'`	The component that renders the end decorator.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.Mui-disabled		State class applied to the root element if `disabled={true}`.
.Mui-focusVisible		State class applied to the root element if the link is keyboard focused.
.MuiLink-body-lg	body-lg	Class name applied to the root element if `level="body-lg"`.
.MuiLink-body-md	body-md	Class name applied to the root element if `level="body-md"`.
.MuiLink-body-sm	body-sm	Class name applied to the root element if `level="body-sm"`.
.MuiLink-body-xs	body-xs	Class name applied to the root element if `level="body-xs"`.
.MuiLink-colorContext	colorContext	Class name applied to the root element when color inversion is triggered.
.MuiLink-colorDanger	colorDanger	Class name applied to the root element if `color="danger"`.
.MuiLink-colorNeutral	colorNeutral	Class name applied to the root element if `color="neutral"`.
.MuiLink-colorPrimary	colorPrimary	Class name applied to the root element if `color="primary"`.
.MuiLink-colorSuccess	colorSuccess	Class name applied to the root element if `color="success"`.
.MuiLink-colorWarning	colorWarning	Class name applied to the root element if `color="warning"`.
.MuiLink-h1	h1	Class name applied to the root element if `level="h1"`.
.MuiLink-h2	h2	Class name applied to the root element if `level="h2"`.
.MuiLink-h3	h3	Class name applied to the root element if `level="h3"`.
.MuiLink-h4	h4	Class name applied to the root element if `level="h4"`.
.MuiLink-title-lg	title-lg	Class name applied to the root element if `level="title-lg"`.
.MuiLink-title-md	title-md	Class name applied to the root element if `level="title-md"`.
.MuiLink-title-sm	title-sm	Class name applied to the root element if `level="title-sm"`.
.MuiLink-underlineAlways	underlineAlways	Class name applied to the root element if `underline="always"`.
.MuiLink-underlineHover	underlineHover	Class name applied to the root element if `underline="hover"`.
.MuiLink-underlineNone	underlineNone	Class name applied to the root element if `underline="none"`.
.MuiLink-variantOutlined	variantOutlined	Class name applied to the root element if `variant="outlined"`.
.MuiLink-variantPlain	variantPlain	Class name applied to the root element if `variant="plain"`.
.MuiLink-variantSoft	variantSoft	Class name applied to the root element if `variant="soft"`.
.MuiLink-variantSolid	variantSolid	Class name applied to the root element if `variant="solid"`.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.