Link API
API reference docs for the React Link component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import Link from '@mui/joy/Link';
// or
import { Link } from '@mui/joy';
Props of the native component are also available.
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
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:{}
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
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'
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.
To learn how to customize the slot, check out the Overriding component structure guide.
The component that renders the start decorator.
Global class: .MuiLink-startDecorator
Default: 'span'
These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.