Link API
The API documentation of the Link React component. Learn more about the props and the CSS customization points.
Import
import Link from '@material-ui/core/Link';
// or
import { Link } from '@material-ui/core';
You can learn more about the difference by reading this guide.
Component name
The MuiLink
name can be used for providing default props or style overrides at the theme level.
Props
Name | Type | Default | Description |
---|---|---|---|
children | node | The content of the link. | |
classes | object | Override 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. |
component | element type | 'a' | The 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. |
TypographyClasses | object | classes 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).
CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiLink-root | Styles applied to the root element. |
underlineNone | .MuiLink-underlineNone | Styles applied to the root element if underline="none" . |
underlineHover | .MuiLink-underlineHover | Styles applied to the root element if underline="hover" . |
underlineAlways | .MuiLink-underlineAlways | Styles applied to the root element if underline="always" . |
button | .MuiLink-button | Styles applied to the root element if component="button" . |
focusVisible | .Mui-focusVisible | Pseudo-class applied to the root element if the link is keyboard focused. |
You can override the style of the component thanks to one of these customization points:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
overrides
property.
If that's not sufficient, you can check the implementation of the component for more detail.
Inheritance
The props of the Typography component are also available. You can take advantage of this behavior to target nested components.