Skip to content
Edit this page

Link API

API documentation for the React Link component. Learn about the available props, and the CSS API.

Import

import Link from '@material-ui/core/Link';
// or
import { Link } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiLink can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
childrennodeThe content of the link.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
color'error'
| 'inherit'
| 'initial'
| 'primary'
| 'secondary'
| 'textPrimary'
| 'textSecondary'		'primary'The color of the link.
componentelement typeThe component used for the root node. Either a string to use a HTML element or a component.
⚠️ Needs to be able to hold a ref.
TypographyClassesobjectclasses prop applied to the Typography element.
underline'always'
| 'hover'
| 'none'		'hover'Controls when the link should have an underline.
variant'body1'
| 'body2'
| 'button'
| 'caption'
| 'h1'
| 'h2'
| 'h3'
| 'h4'
| 'h5'
| 'h6'
| 'inherit'
| 'overline'
| 'subtitle1'
| 'subtitle2'
| string		'inherit'Applies the theme typography styles.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (Typography).

Inheritance

While not explicitly documented above, the props of the Typography component are also available on Link. You can take advantage of this to target nested components.

CSS

Rule nameGlobal classDescription
root.MuiLink-rootStyles applied to the root element.
underlineNone.MuiLink-underlineNoneStyles applied to the root element if underline="none".
underlineHover.MuiLink-underlineHoverStyles applied to the root element if underline="hover".
underlineAlways.MuiLink-underlineAlwaysStyles applied to the root element if underline="always".
button.MuiLink-buttonStyles applied to the root element if component="button".
focusVisible.Mui-focusVisiblePseudo-class applied to the root element if the link is keyboard focused.

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos