Tag

Tag component is used for items that need to be labeled, categorized, or organized using keywords that describe them.

Import#

Chakra UI exports 5 Tag related components:

Tag: The wrapper for all the tag elements
TagLabel: The label for tag's text content.
TagLeftIcon: The icon placed on the left side of the tag
TagRightIcon: The icon placed on the right side of the tag
TagCloseButton: The close button for the tag.

import {
  Tag,
  TagLabel,
  TagLeftIcon,
  TagRightIcon,
  TagCloseButton,
} from "@chakra-ui/core"

import {
  Tag,
  TagLabel,
  TagLeftIcon,
  TagRightIcon,
  TagCloseButton,
} from "@chakra-ui/core"

Usage#

Sample Tag

<Tag>Sample Tag</Tag>

<Tag>Sample Tag</Tag>

Editable Example

TealTealTeal

<HStack spacing={4}>
  {["sm", "md", "lg"].map((size) => (
    <Tag size={size} key={size} variant="solid" colorScheme="teal">
      Teal
    </Tag>
  ))}
</HStack>

<HStack spacing={4}>
  {["sm", "md", "lg"].map((size) => (
    <Tag size={size} key={size} variant="solid" colorScheme="teal">
      Teal
    </Tag>
  ))}
</HStack>

Editable Example

With left icon#

CyanCyanCyan

<HStack spacing={4}>
  {["sm", "md", "lg"].map((size) => (
    <Tag size={size} key={size} variant="subtle" colorScheme="cyan">
      <TagLeftIcon boxSize="12px" as={AddIcon} />
      <TagLabel>Cyan</TagLabel>
    </Tag>
  ))}
</HStack>

<HStack spacing={4}>
  {["sm", "md", "lg"].map((size) => (
    <Tag size={size} key={size} variant="subtle" colorScheme="cyan">
      <TagLeftIcon boxSize="12px" as={AddIcon} />
      <TagLabel>Cyan</TagLabel>
    </Tag>
  ))}
</HStack>

Editable Example

With right icon#

BlueBlueBlue

<HStack spacing={4}>
  {["sm", "md", "lg"].map((size) => (
    <Tag size={size} key={size} variant="outline" colorScheme="blue">
      <TagLabel>Blue</TagLabel>
      <TagRightIcon as={MdSettings} />
    </Tag>
  ))}
</HStack>

<HStack spacing={4}>
  {["sm", "md", "lg"].map((size) => (
    <Tag size={size} key={size} variant="outline" colorScheme="blue">
      <TagLabel>Blue</TagLabel>
      <TagRightIcon as={MdSettings} />
    </Tag>
  ))}
</HStack>

Editable Example

With close button#

GreenGreenGreen

<HStack spacing={4}>
  {["sm", "md", "lg"].map((size) => (
    <Tag
      size={size}
      key={size}
      borderRadius="full"
      variant="solid"
      colorScheme="green"
    >
      <TagLabel>Green</TagLabel>
      <TagCloseButton />
    </Tag>
  ))}
</HStack>

<HStack spacing={4}>
  {["sm", "md", "lg"].map((size) => (
    <Tag
      size={size}
      key={size}
      borderRadius="full"
      variant="solid"
      colorScheme="green"
    >
      <TagLabel>Green</TagLabel>
      <TagCloseButton />
    </Tag>
  ))}
</HStack>

Editable Example

With custom element#

Segun

<Tag colorScheme="red" borderRadius="full">
  <Avatar
    src="https://bit.ly/sage-adebayo"
    size="xs"
    name="Segun Adebayo"
    ml={-1}
    mr={2}
  />
  <TagLabel>Segun</TagLabel>
</Tag>

<Tag colorScheme="red" borderRadius="full">
  <Avatar
    src="https://bit.ly/sage-adebayo"
    size="xs"
    name="Segun Adebayo"
    ml={-1}
    mr={2}
  />
  <TagLabel>Segun</TagLabel>
</Tag>

Editable Example

Props#

Name	Type	Default	Description
`variant`	`solid`, `subtle`, `outline`	`solid`	The variant style of the tag component.
`size`	`sm`, `md`, `lg`	`md`	The size of the tag component.
`colorScheme`	`string`		The color scheme of the tag variant.

Edit this page

Tag

.css-12m0k8p{pointer-events:auto;}Import.css-1l2j62r{color:#319795;font-weight:400;outline:none;opacity:0;margin-left:0.375rem;}.css-1l2j62r:focus,.css-1l2j62r[data-focus]{opacity:1;box-shadow:0 0 0 3px rgba(66,153,225,0.6);}#

Usage#

With left icon#

With right icon#

With close button#

With custom element#

Props#

Import#