Link

Imports#

import { Link } from '@chakra-ui/react'

Usage#

<Link>Chakra UI</Link>

Using as external link#

To use the link as an external link, pass the external prop. This will add the target='_blank' and rel='noopener noreferrer' attributes to the link.

<Link href='https://chakra-ui.com' external>
  Chakra UI
</Link>

Changing the variant of the link#

Pass the variant prop to change the style of the link.

<HStack>
  <Link variant='underline' href='#'>
    Chakra UI Docs
  </Link>
  <Link variant='plain' href='#'>
    Chakra UI Docs
  </Link>
</HStack>

Usage with Routing Library#

Use the asChild when you need to compose the link with those from Next.js or React Router.

import NextLink from 'next/link'
import { Link } from '@chakra-ui/react'

function Demo() {
  return (
    <Link asChild>
      <NextLink href='/home'>Home</NextLink>
    </Link>
  )
}

Props#

The Link component composes the Box component.

The Link component is a single part component. All of the styling is applied directly to the anchor element.

To learn more about styling single part components, visit the Component Style page.

Theming properties#

The properties that affect the theming of the Link component are:

• variant: The visual variant of the Link component.
• colorScheme: The color scheme of the Link component.
• size: The size of the Link component.

Note: Theming properties for Link component are not implemented in the default theme. You can extend the theme to implement them.

Theming utilities#

• defineStyle: a function used to create style objects.
• defineStyleConfig: a function used to define the style configuration for a single part component.

import { defineStyle, defineStyleConfig } from '@chakra-ui/react'

Adding a custom size#

Let's assume we want to include an extra large link size. Here's how we can do that:

import { defineStyle, defineStyleConfig } from '@chakra-ui/react'

const xl = defineStyle({
  fontSize: 'xl',
})

export const linkTheme = defineStyleConfig({
  sizes: { xl },
})

// Now we can use the new `xl` size
<Link size="xl">...</Link>

Every time you're adding anything new to the theme, you'd need to run the CLI command to get proper autocomplete in your IDE. You can learn more about the CLI tool here.

Adding a custom variant#

Let's assume we want to include a custom branded variant. Here's how we can do that:

import { defineStyle, defineStyleConfig } from '@chakra-ui/react'

const brandPrimary = defineStyle({
  textDecoration: 'underline',
  color: 'white',
  fontFamily: 'serif',
  fontWeight: 'normal',

  // let's also provide dark mode alternatives
  _dark: {
    color: 'orange.800',
  }
})

export const linkTheme = defineStyleConfig({
  variants: { brandPrimary },
})

// Now we can use the new `brandPrimary` variant
<Link variant="brandPrimary">...</Link>

Using a custom color scheme#

Let's assume we want to use our own custom color scale based on our brand. We'd need to define the color scale first in the main theme file:

import { extendTheme } from '@chakra-ui/react'

export const theme = extendTheme({
  colors: {
    brand: {
      50: '#f7fafc',
      ...
      500: '#718096',
      ...
      900: '#171923',
    }
  }
})

Then, we can use the custom color scale as the color scheme for the Link component:

<Link colorPalette='brand'>...</Link>

Setting default properties#

Let's assume that we want to set the default size, variant or color scheme of every link in our app. Here's how we can do that:

import { defineStyleConfig } from '@chakra-ui/react'

export const linkTheme = defineStyleConfig({
  defaultProps: {
    size: 'xl',
    variant: 'brandPrimary',
    colorScheme: 'brand',
  },
})

// This saves you time, instead of manually setting the size,
// variant and color scheme every time you use a Link component:
<Link size="xl" variant="brandPrimary" colorPalette="brand">...</Link>

Showcase#

import { Box, SimpleGrid, IconButton, Link, Text, useColorMode } from "@chakra-ui/react";
import { FaMoon, FaSun } from "react-icons/fa";
import { ExternalLinkIcon } from "@chakra-ui/icons";

export default function App() {
  const { toggleColorMode, colorMode } = useColorMode();
  return (
    <Box position="relative" h="100vh">
      <SimpleGrid gap={12} p={12} columns={2}>
        <Link textDecoration={"underline"} href="https://chakra-ui.com">
          themed underline link
        </Link>
        <Link href="https://chakra-ui.com" isExternal>
          themed external link <ExternalLinkIcon mx="2px" />
        </Link>
        <Text>
          Themed Link{" "}
          <Link href="https://chakra-ui.com">
            with inline text
          </Link>
        </Text>
        <Link href="https://chakra-ui.com" variant="custom">
          themed link with custom variant
        </Link>
        <Link href="https://chakra-ui.com" size="xl">
          link size xl
        </Link>
      </SimpleGrid>

      <IconButton
        rounded="full"
        aria-label="change theme"
        size="xs"
        position="absolute"
        bottom={4}
        left={4}
        onClick={toggleColorMode} icon={colorMode === "dark" ? <FaSun /> : <FaMoon />}
      />
    </Box>
  );
}