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.

children

The content of the component.

Type:

node

color

The color of the link.

Type:

Default:

'primary'

component

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

Type:

elementType

disabled

If true, the component is disabled.

Type:

bool

Default:

false

endDecorator

Element placed after the children.

Type:

node

level

Applies the theme typography styles.

Type:

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

Default:

'body-md'

overlay

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

slotProps

The props used for each slot inside.

Type:

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

Default:

{}

slots

The components used for each slot inside.

Type:

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

Default:

{}

startDecorator

Element placed before the children.

Type:

node

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

Type:

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

textColor

The system color.

Type:

any

underline

Controls when the link should have an underline.

Type:

'always' | 'hover' | 'none'

Default:

'hover'

variant

Applies the theme link styles.

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.

root'a'Required

Global class: .MuiLink-root

Description: The component that renders the root.

startDecorator'span'Required

Global class: .MuiLink-startDecorator

Description: The component that renders the start decorator.

endDecorator'span'Required

Global class: .MuiLink-endDecorator

Description: The component that renders the end decorator.

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.

CSS classes

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

.Mui-disabledSTATE

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

.Mui-focusVisibleSTATE

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".

.MuiLink-colorContext

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

.MuiLink-colorDanger

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

.MuiLink-colorNeutral

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

.MuiLink-colorPrimary

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

.MuiLink-colorSuccess

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

.MuiLink-colorWarning

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

.MuiLink-h1

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

.MuiLink-h2

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

.MuiLink-h3

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

.MuiLink-h4

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

.MuiLink-title-lg

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

.MuiLink-title-md

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

.MuiLink-title-sm

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

.MuiLink-underlineAlways

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

.MuiLink-underlineHover

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

.MuiLink-underlineNone

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

.MuiLink-variantOutlined

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

.MuiLink-variantPlain

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

.MuiLink-variantSoft

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

.MuiLink-variantSolid

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

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.