Skip to content
Edit this page

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:

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.

The content of the component.

Type:

node

The color of the link.

To learn how to add your own colors, check out Themed components—Extend colors.

Type:

'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string

Default:

'primary'

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType

If true, the component is disabled.

Type:

bool

Default:

false

Element placed after the children.

Type:

node

Applies the theme typography styles.

Type:

'body1' | 'body2' | 'body3' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'inherit' | string

Default:

'body-md'

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.

Type:

bool

Default:

false

The props used for each slot inside.

Type:

{ endDecorator?: func | object, root?: func | object, startDecorator?: func | object }

Default:

{}

The components used for each slot inside.

See Slots API below for more details.

Type:

{ endDecorator?: elementType, root?: elementType, startDecorator?: elementType }

Default:

{}

Element placed before the children.

Type:

node

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object

The system color.

Type:

any

Controls when the link should have an underline.

Type:

'always' | 'hover' | 'none'

Default:

'hover'

Applies the theme link styles.

To learn how to add your own variants, check out Themed components—Extend variants.

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string

Default:

'plain'
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.

The component that renders the root.

Default: 'a'

Global class: .MuiLink-root

The component that renders the start decorator.

Default: 'span'

Global class: .MuiLink-startDecorator

The component that renders the end decorator.

Default: 'span'

Global class: .MuiLink-endDecorator

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

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

State class applied to the root element if disabled={true}.

State class applied to the root element if the link is keyboard focused.

.MuiLink-body-lg

Class name applied to the root element if level="body-lg".

.MuiLink-body-md

Class name applied to the root element if level="body-md".

.MuiLink-body-sm

Class name applied to the root element if level="body-sm".

.MuiLink-body-xs

Class name applied to the root element if level="body-xs".

Class name applied to the root element when color inversion is triggered.

Class name applied to the root element if color="danger".

Class name applied to the root element if color="neutral".

Class name applied to the root element if color="primary".

Class name applied to the root element if color="success".

Class name applied to the root element if color="warning".

Class name applied to the root element if level="h1".

Class name applied to the root element if level="h2".

Class name applied to the root element if level="h3".

Class name applied to the root element if level="h4".

Class name applied to the root element if level="title-lg".

Class name applied to the root element if level="title-md".

Class name applied to the root element if level="title-sm".

Class name applied to the root element if underline="always".

Class name applied to the root element if underline="hover".

Class name applied to the root element if underline="none".

Class name applied to the root element if variant="outlined".

Class name applied to the root element if variant="plain".

Class name applied to the root element if variant="soft".

Class name applied to the root element if variant="solid".