The Link component styles anchor tags with default hyperlink color cues and hover text decoration. Link
is used for destinations, or moving from one page to another.
In special cases where you'd like a <button>
styled like a Link
, use <Link as='button'>
. Make sure to provide a click handler with onClick
.
Important: When using the as
prop, be sure to always render an accessible element type, like a
, button
, input
, or summary
.
<Link href="https://github.com">Link</Link>
Name | Type | Default | Description |
---|---|---|---|
href | string | URL to be used for the Link. (The href is passed to the underlying <a> element. If as is specified, the link behavior may need different props). | |
muted | boolean | false | Uses a less prominent shade for Link color, and the default link shade on hover |
underline | boolean | false | Adds underline to the Link |
hoverColor | string | Color used when hovering over link | |
sx | SystemStyleObject | Style overrides to apply to the component. See also overriding styles. | |
as | React.ElementType | "a" | The underlying element to render — either a HTML element name or a React component. |
ref | React.RefObject<HTMLAnchorElement> | A ref to the element rendered by this component. Because this component is polymorphic, the type will vary based on the value of the as prop. | |
Additional props are passed to the <a> element. See MDN for a list of props accepted by the <a> element. If an as prop is specified, the accepted props will change accordingly. |