Link

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

install	`yarn add @react-spectrum/link`
version	3.2.4
usage	`import {Link} from '@react-spectrum/link'`

View guidelines

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 '@react-spectrum/link';
import {Link as RouterLink} from 'react-router-dom';

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

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

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

import {Link} from '@react-spectrum/link';
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#

Name	Type	Default	Description
`children`	`ReactNode`	—	The content to display in the link.
`variant`	`'primary' \| 'secondary' \| 'overBackground'`	`'primary'`	The visual style of the link.
`isQuiet`	`boolean`	—	Whether the link should be displayed with a quiet style.
`autoFocus`	`boolean`	—	Whether the element should receive focus on render.

Events

Name	Type	Default	Description
`onPress`	`( (e: PressEvent )) => void`	—	Handler that is called when the press is released over the target.
`onPressStart`	`( (e: PressEvent )) => void`	—	Handler 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 )) => void`	—	Handler 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 )) => void`	—	Handler that is called when the element receives focus.
`onBlur`	`( (e: FocusEvent )) => void`	—	Handler that is called when the element loses focus.
`onFocusChange`	`( (isFocused: boolean )) => void`	—	Handler that is called when the element's focus status changes.
`onKeyDown`	`( (e: KeyboardEvent )) => void`	—	Handler that is called when a key is pressed.
`onKeyUp`	`( (e: KeyboardEvent )) => void`	—	Handler that is called when a key is released.

Layout

Name	Type	Default	Description
`flex`	`Responsive<string \| number \| boolean>`	—	When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
`flexGrow`	`Responsive<number>`	—	When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
`flexShrink`	`Responsive<number>`	—	When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
`flexBasis`	`Responsive<number \| string>`	—	When used in a flex layout, specifies the initial main size of the element. See MDN.
`alignSelf`	`Responsive<'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`	`Responsive<'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.
`order`	`Responsive<number>`	—	The layout order for the element within a flex or grid container. See MDN.
`gridArea`	`Responsive<string>`	—	When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
`gridColumn`	`Responsive<string>`	—	When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
`gridRow`	`Responsive<string>`	—	When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
`gridColumnStart`	`Responsive<string>`	—	When used in a grid layout, specifies the starting column to span within the grid. See MDN.
`gridColumnEnd`	`Responsive<string>`	—	When used in a grid layout, specifies the ending column to span within the grid. See MDN.
`gridRowStart`	`Responsive<string>`	—	When used in a grid layout, specifies the starting row to span within the grid. See MDN.
`gridRowEnd`	`Responsive<string>`	—	When used in a grid layout, specifies the ending row to span within the grid. See MDN.

Spacing

Name	Type	Default	Description
`margin`	`Responsive<DimensionValue>`	—	The margin for all four sides of the element. See MDN.
`marginTop`	`Responsive<DimensionValue>`	—	The margin for the top side of the element. See MDN.
`marginBottom`	`Responsive<DimensionValue>`	—	The margin for the bottom side of the element. See MDN.
`marginStart`	`Responsive<DimensionValue>`	—	The margin for the logical start side of the element, depending on layout direction. See MDN.
`marginEnd`	`Responsive<DimensionValue>`	—	The margin for the logical end side of an element, depending on layout direction. See MDN.
`marginX`	`Responsive<DimensionValue>`	—	The margin for both the left and right sides of the element. See MDN.
`marginY`	`Responsive<DimensionValue>`	—	The margin for both the top and bottom sides of the element. See MDN.

Sizing

Name	Type	Default	Description
`width`	`Responsive<DimensionValue>`	—	The width of the element. See MDN.
`minWidth`	`Responsive<DimensionValue>`	—	The minimum width of the element. See MDN.
`maxWidth`	`Responsive<DimensionValue>`	—	The maximum width of the element. See MDN.
`height`	`Responsive<DimensionValue>`	—	The height of the element. See MDN.
`minHeight`	`Responsive<DimensionValue>`	—	The minimum height of the element. See MDN.
`maxHeight`	`Responsive<DimensionValue>`	—	The maximum height of the element. See MDN.

Positioning

Name	Type	Default	Description
`position`	`Responsive<'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky'>`	—	Specifies how the element is positioned. See MDN.
`top`	`Responsive<DimensionValue>`	—	The top position for the element. See MDN.
`bottom`	`Responsive<DimensionValue>`	—	The bottom position for the element. See MDN.
`left`	`Responsive<DimensionValue>`	—	The left position for the element. See MDN. Consider using `start` instead for RTL support.
`right`	`Responsive<DimensionValue>`	—	The right position for the element. See MDN. Consider using `start` instead for RTL support.
`start`	`Responsive<DimensionValue>`	—	The logical start position for the element, depending on layout direction. See MDN.
`end`	`Responsive<DimensionValue>`	—	The logical end position for the element, depending on layout direction. See MDN.
`zIndex`	`Responsive<number>`	—	The stacking order for the element. See MDN.
`isHidden`	`Responsive<boolean>`	—	Hides the element.

Accessibility

Name	Type	Default	Description
`aria-label`	`string`	—	Defines a string value that labels the current element.
`aria-labelledby`	`string`	—	Identifies the element (or elements) that labels the current element.
`aria-describedby`	`string`	—	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	—	Identifies the element (or elements) that provide a detailed, extended description for the object.

Advanced

Name	Type	Default	Description
`UNSAFE_className`	`string`	—	Sets the CSS className for the element. Only use as a last resort. Use style props instead.
`UNSAFE_style`	`CSSProperties`	—	Sets 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>

Name	Type	Description
`type`	`'pressstart' \| 'pressend' \| 'pressup' \| 'press'`	The type of press event being fired.
`pointerType`	`PointerType`	The pointer type that triggered the press event.
`target`	`HTMLElement`	The target element of the press event.
`shiftKey`	`boolean`	Whether the shift keyboard modifier was held during the press event.
`ctrlKey`	`boolean`	Whether the ctrl keyboard modifier was held during the press event.
`metaKey`	`boolean`	Whether the meta keyboard modifier was held during the press event.
`altKey`	`boolean`	Whether the alt keyboard modifier was held during the press event.