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
added3.0.0
usageimport {Link} from '@adobe/react-spectrum'

Example#


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

Content#


Links accept content as children. If the link has an href prop, it will be rendered as an <a> element.

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

When a <Link> does not have an href prop, it is rendered as a <span role="link"> instead of an <a>. 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 link')}>Adobe</Link>
<Link onPress={() => alert('Pressed link')}>Adobe</Link>
<Link
  onPress={() =>
    alert(
      'Pressed link'
    )}
>
  Adobe
</Link>

Client side routing#

The <Link> component works with frameworks and client side routers like Next.js and React Router. As with other React Spectrum components that support links, this works via the Provider component at the root of your app. See the client side routing guide to learn how to set this up.

Internationalization#

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

Accessibility#

When an href is not provided, 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>

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.

The quiet style must only be used when the placement and context of the link is explicit enough that a visible underline isn’t necessary. It must not be used within, for example, a paragraph of text.

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.
autoFocusbooleanWhether the element should receive focus on render.
hrefstringA URL to link to. See MDN.
targetHTMLAttributeAnchorTargetThe target window for the link. See MDN.
relstringThe relationship between the linked resource and the current page. See MDN.
downloadbooleanstringCauses the browser to download the linked URL. A string may be provided to suggest a file name. See MDN.
pingstringA space-separated list of URLs to ping when the link is followed. See MDN.
referrerPolicyHTMLAttributeReferrerPolicyHow much of the referrer to send when following the link. See MDN.
Events
NameTypeDescription
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 )) => void

Handler 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 )) => void

Handler that is called when a press is released over the target, regardless of whether it started on the target or not.

onFocus( (e: FocusEvent<Target> )) => voidHandler that is called when the element receives focus.
onBlur( (e: FocusEvent<Target> )) => voidHandler that is called when the element loses focus.
onFocusChange( (isFocused: boolean )) => voidHandler that is called when the element's focus status changes.
onKeyDown( (e: KeyboardEvent )) => voidHandler that is called when a key is pressed.
onKeyUp( (e: KeyboardEvent )) => voidHandler that is called when a key is released.
Layout
NameTypeDescription
flexResponsive<stringnumberboolean>When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrowResponsive<number>When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinkResponsive<number>When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisResponsive<numberstring>When used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelfResponsive<'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.
justifySelfResponsive<'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.
orderResponsive<number>The layout order for the element within a flex or grid container. See MDN.
gridAreaResponsive<string>When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnResponsive<string>When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowResponsive<string>When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartResponsive<string>When used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndResponsive<string>When used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartResponsive<string>When used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndResponsive<string>When used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDescription
marginResponsive<DimensionValue>The margin for all four sides of the element. See MDN.
marginTopResponsive<DimensionValue>The margin for the top side of the element. See MDN.
marginBottomResponsive<DimensionValue>The margin for the bottom side of the element. See MDN.
marginStartResponsive<DimensionValue>The margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndResponsive<DimensionValue>The margin for the logical end side of an element, depending on layout direction. See MDN.
marginXResponsive<DimensionValue>The margin for both the left and right sides of the element. See MDN.
marginYResponsive<DimensionValue>The margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDescription
widthResponsive<DimensionValue>The width of the element. See MDN.
minWidthResponsive<DimensionValue>The minimum width of the element. See MDN.
maxWidthResponsive<DimensionValue>The maximum width of the element. See MDN.
heightResponsive<DimensionValue>The height of the element. See MDN.
minHeightResponsive<DimensionValue>The minimum height of the element. See MDN.
maxHeightResponsive<DimensionValue>The maximum height of the element. See MDN.
Positioning
NameTypeDescription
positionResponsive<'static''relative''absolute''fixed''sticky'>Specifies how the element is positioned. See MDN.
topResponsive<DimensionValue>The top position for the element. See MDN.
bottomResponsive<DimensionValue>The bottom position for the element. See MDN.
leftResponsive<DimensionValue>The left position for the element. See MDN. Consider using start instead for RTL support.
rightResponsive<DimensionValue>The right position for the element. See MDN. Consider using start instead for RTL support.
startResponsive<DimensionValue>The logical start position for the element, depending on layout direction. See MDN.
endResponsive<DimensionValue>The logical end position for the element, depending on layout direction. See MDN.
zIndexResponsive<number>The stacking order for the element. See MDN.
isHiddenResponsive<boolean>Hides the element.
Accessibility
NameTypeDescription
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
NameTypeDescription
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>