Link API
API reference docs for the React Link component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import Link from '@mui/material/Link';
// or
import { Link } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.
Props of the Typography component are also available.
Name | Type | Default | Description |
---|---|---|---|
children | node | - | The content of the component. |
classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
color | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning' | 'textPrimary' | 'textSecondary' | 'textDisabled' | string | 'primary' | The color of the link. |
component | element type | - | The component used for the root node. Either a string to use a HTML element or a component. |
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. |
TypographyClasses | object | - |
|
underline | 'always' | 'hover' | 'none' | 'always' | 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. |
ref
is forwarded to the root element.Inheritance
While not explicitly documented above, the props of the Typography component are also available in Link. You can take advantage of this to target nested components.
Theme default props
You can use MuiLink
to change the default props of this component with the theme.
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-focusVisible | State class applied to the root element if the link is keyboard focused. | |
.MuiLink-button | button | Styles applied to the root element if component="button" . |
.MuiLink-root | root | Styles applied to the root element. |
.MuiLink-underlineAlways | underlineAlways | Styles applied to the root element if underline="always" . |
.MuiLink-underlineHover | underlineHover | Styles applied to the root element if underline="hover" . |
.MuiLink-underlineNone | underlineNone | Styles applied to the root element if underline="none" . |
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.
Source code
If you did not find the information in this page, consider having a look at the implementation of the component for more detail.