Link

Links allow users to navigate to a different location. They can be presented inline inside a paragraph or as standalone text.

installyarn add @adobe/react-spectrum
version3.1.1
usageimport {Link} from '@adobe/react-spectrum'

Example#


<Link>
  <a href="https://www.imdb.com/title/tt6348138/" target="_blank">
    The missing link.
  </a>
</Link>
<Link>
  <a
    href="https://www.imdb.com/title/tt6348138/"
    target="_blank">
    The missing link.
  </a>
</Link>
<Link>
  <a
    href="https://www.imdb.com/title/tt6348138/"
    target="_blank">
    The missing link.
  </a>
</Link>

Content#


Links accept content as children. If the child is a native anchor element, or a link component used with a client side router, the Link component will add spectrum styles and event handlers to that element. Actual navigation will be handled by the wrapped element.

<Link>
  <a href="https://www.adobe.com" target="_blank">
    Adobe.com
  </a>
</Link>
<Link>
  <a href="https://www.adobe.com" target="_blank">
    Adobe.com
  </a>
</Link>
<Link>
  <a
    href="https://www.adobe.com"
    target="_blank">
    Adobe.com
  </a>
</Link>

To use in React Router

import {Link} from '@adobe/react-spectrum';
import {Link as RouterLink} from 'react-router-dom';

<Link>
  <RouterLink to="/next-page">Next Page</RouterLink>
</Link>
import {Link} from '@adobe/react-spectrum';
import {Link as RouterLink} from 'react-router-dom';

<Link>
  <RouterLink to="/next-page">Next Page</RouterLink>
</Link>
import {Link} from '@adobe/react-spectrum';
import {Link as RouterLink} from 'react-router-dom';

<Link>
  <RouterLink to="/next-page">
    Next Page
  </RouterLink>
</Link>

If the content is plain text, it will be styled and exposed to assistive technologies as a link. Events will need to be handled in JavaScript with the onPress prop. Note: this will not behave like a native link. Browser features like context menus and open in new tab will not apply.

<Link onPress={() => alert('pressed!')}>A label</Link>
<Link onPress={() => alert('pressed!')}>A label</Link>
<Link
  onPress={() =>
    alert('pressed!')
  }>
  A label
</Link>

Internationalization#

In order to internationalize a link, a localized string should be passed to the children prop.

Accessibility#

For string-typed children, the link component will expose the accessible role to assistive technology as a "link".

<Link onPress={(e) => alert(`clicked "${e.target.textContent}" Link`)}>
  I forgot my password
</Link>
<Link
  onPress={(e) =>
    alert(`clicked "${e.target.textContent}" Link`)
  }>
  I forgot my password
</Link>
<Link
  onPress={(e) =>
    alert(
      `clicked "${e.target.textContent}" Link`
    )
  }>
  I forgot my password
</Link>

For other children, use an element of semantic meaning, or use a role where appropriate.

Be mindful of what the experience is for users navigating with screen readers. Make sure to give enough context about where the link will take the user.

Props#


NameTypeDefaultDescription
childrenReactNodeThe content to display in the link.
variant'primary''secondary''overBackground''primary'The visual style of the link.
isQuietbooleanWhether the link should be displayed with a quiet style.
Events
NameTypeDefaultDescription
onPress( (e: PressEvent )) => voidHandler that is called when the press is released over the target.
onPressStart( (e: PressEvent )) => voidHandler that is called when a press interaction starts.
onPressEnd( (e: PressEvent )) => voidHandler that is called when a press interaction ends, either over the target or when the pointer leaves the target.
onPressChange( (isPressed: boolean )) => voidHandler that is called when the press state changes.
onPressUp( (e: PressEvent )) => voidHandler that is called when a press is released over the target, regardless of whether it started on the target or not.
Layout
NameTypeDefaultDescription
flexstringnumberbooleanWhen used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrownumberWhen used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinknumberWhen used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisnumberstringWhen used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelf'auto''normal''start''end''center''flex-start''flex-end''self-start''self-end''stretch'Overrides the alignItems property of a flex or grid container. See MDN.
justifySelf'auto''normal''start''end''flex-start''flex-end''self-start''self-end''center''left''right''stretch'Specifies how the element is justified inside a flex or grid container. See MDN.
ordernumberThe layout order for the element within a flex or grid container. See MDN.
gridAreastringWhen used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnstringWhen used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowstringWhen used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartstringWhen used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndstringWhen used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartstringWhen used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndstringWhen used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginDimensionValueThe margin for all four sides of the element. See MDN.
marginTopDimensionValueThe margin for the top side of the element. See MDN.
marginBottomDimensionValueThe margin for the bottom side of the element. See MDN.
marginStartDimensionValueThe margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndDimensionValueThe margin for the logical end side of an element, depending on layout direction. See MDN.
marginXDimensionValueThe margin for both the left and right sides of the element. See MDN.
marginYDimensionValueThe margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthDimensionValueThe width of the element. See MDN.
minWidthDimensionValueThe minimum width of the element. See MDN.
maxWidthDimensionValueThe maximum width of the element. See MDN.
heightDimensionValueThe height of the element. See MDN.
minHeightDimensionValueThe minimum height of the element. See MDN.
maxHeightDimensionValueThe maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
position'static''relative''absolute''fixed''sticky'Specifies how the element is positioned. See MDN.
topDimensionValueThe top position for the element. See MDN.
bottomDimensionValueThe bottom position for the element. See MDN.
leftDimensionValueThe left position for the element. See MDN. Consider using start instead for RTL support.
rightDimensionValueThe right position for the element. See MDN. Consider using start instead for RTL support.
startDimensionValueThe logical start position for the element, depending on layout direction. See MDN.
endDimensionValueThe logical end position for the element, depending on layout direction. See MDN.
zIndexnumberThe stacking order for the element. See MDN.
isHiddenbooleanHides the element.
Accessibility
NameTypeDefaultDescription
aria-labelstringDefines a string value that labels the current element.
aria-labelledbystringIdentifies the element (or elements) that labels the current element.
aria-describedbystringIdentifies the element (or elements) that describes the object.
aria-detailsstringIdentifies the element (or elements) that provide a detailed, extended description for the object.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestringSets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSPropertiesSets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#


View Guidelines

Primary#

<p>
  Would you like to <Link variant="primary">learn more</Link> about this fine
  component?
</p>
<p>
  Would you like to{' '}
  <Link variant="primary">learn more</Link> about this
  fine component?
</p>
<p>
  Would you like to{' '}
  <Link variant="primary">
    learn more
  </Link>{' '}
  about this fine
  component?
</p>

Secondary#

<p>
  Would you like to <Link variant="secondary">learn more</Link> about this
  fine component?
</p>
<p>
  Would you like to{' '}
  <Link variant="secondary">learn more</Link> about this
  fine component?
</p>
<p>
  Would you like to{' '}
  <Link variant="secondary">
    learn more
  </Link>{' '}
  about this fine
  component?
</p>

Over background#

<View backgroundColor="positive" padding="size-300">
  <Link variant="overBackground">Learn more here!</Link>
</View>
<View backgroundColor="positive" padding="size-300">
  <Link variant="overBackground">Learn more here!</Link>
</View>
<View
  backgroundColor="positive"
  padding="size-300">
  <Link variant="overBackground">
    Learn more here!
  </Link>
</View>

Quiet#

<p>
  Would you like to <Link isQuiet>learn more</Link> about this fine component?
</p>
<p>
  Would you like to <Link isQuiet>learn more</Link> about
  this fine component?
</p>
<p>
  Would you like to{' '}
  <Link isQuiet>
    learn more
  </Link>{' '}
  about this fine
  component?
</p>