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';
Component name
The nameMuiLink
can be used when providing default props or style overrides in the theme.Props
Name | Type | Default | Description |
---|---|---|---|
children | node | The content of the component. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
color | any | '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. ⚠️ Needs to be able to hold a ref. | |
sx | object | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. | |
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).
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 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 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.