Badge

Add status indicators to your interface for clear, attention-grabbing usability cues, conveying crucial information swiftly.

Installation

API Reference

This is an illustration of Badge component.

size

variant

action

<Badge size="md" variant="solid" action="muted">
  <BadgeText>Verified</BadgeText>
  <BadgeIcon as={GlobeIcon} className="ml-2" />
</Badge>

Installation

CLI

Manual

Run the following command:

npx gluestack-ui add badge

Step 1: Copy and paste the following code into your project.

"use client"
import React from "react"
import { Text, View } from "react-native"
import { PrimitiveIcon, UIIcon } from "@gluestack-ui/icon"
import { tva } from "@gluestack-ui/nativewind-utils/tva"
import {
  withStyleContext,
  useStyleContext,
} from "@gluestack-ui/nativewind-utils/withStyleContext"
import { cssInterop } from "nativewind"
import type { VariantProps } from "@gluestack-ui/nativewind-utils"
const SCOPE = "BADGE"

const badgeStyle = tva({
  base: "flex-row items-center rounded-sm data-[disabled=true]:opacity-50 px-2 py-1",
  variants: {
    action: {
      error: "bg-background-error border-error-300",
      warning: "bg-background-warning border-warning-300",
      success: "bg-background-success border-success-300",
      info: "bg-background-info border-info-300",
      muted: "bg-background-muted border-background-300",
    },
    variant: {
      solid: "",
      outline: "border",
    },
    size: {
      sm: "",
      md: "",
      lg: "",
    },
  },
})

const badgeTextStyle = tva({
  base: "text-typography-700 font-body font-normal tracking-normal uppercase",

  parentVariants: {
    action: {
      error: "text-error-600",
      warning: "text-warning-600",
      success: "text-success-600",
      info: "text-info-600",
      muted: "text-background-800",
    },
    size: {
      sm: "text-2xs",
      md: "text-xs",
      lg: "text-sm",
    },
  },
  variants: {
    isTruncated: {
      true: "web:truncate",
    },
    bold: {
      true: "font-bold",
    },
    underline: {
      true: "underline",
    },
    strikeThrough: {
      true: "line-through",
    },
    sub: {
      true: "text-xs",
    },
    italic: {
      true: "italic",
    },
    highlight: {
      true: "bg-yellow-500",
    },
  },
})

const badgeIconStyle = tva({
  base: "fill-none",
  parentVariants: {
    action: {
      error: "text-error-600",
      warning: "text-warning-600",
      success: "text-success-600",
      info: "text-info-600",
      muted: "text-background-800",
    },
    size: {
      sm: "h-3 w-3",
      md: "h-3.5 w-3.5",
      lg: "h-4 w-4",
    },
  },
})

const ContextView = withStyleContext(View, SCOPE)

cssInterop(PrimitiveIcon, {
  className: {
    target: "style",
    nativeStyleToProp: {
      height: true,
      width: true,
      fill: true,
      color: "classNameColor",
      stroke: true,
    },
  },
})

type IBadgeProps = React.ComponentPropsWithoutRef<typeof ContextView> &
  VariantProps<typeof badgeStyle>
const Badge = ({
  children,
  action = "muted",
  variant = "solid",
  size = "md",
  className,
  ...props
}: { className?: string } & IBadgeProps) => {
  return (
    <ContextView
      className={badgeStyle({ action, variant, class: className })}
      {...props}
      context={{
        action,
        variant,
        size,
      }}
    >
      {children}
    </ContextView>
  )
}

type IBadgeTextProps = React.ComponentPropsWithoutRef<typeof Text> &
  VariantProps<typeof badgeTextStyle>

const BadgeText = React.forwardRef<
  React.ElementRef<typeof Text>,
  IBadgeTextProps
>(({ children, className, size, ...props }, ref) => {
  const { size: parentSize, action: parentAction } = useStyleContext(SCOPE)
  return (
    <Text
      ref={ref}
      className={badgeTextStyle({
        parentVariants: {
          size: parentSize,
          action: parentAction,
        },
        size,
        class: className,
      })}
      {...props}
    >
      {children}
    </Text>
  )
})

type IBadgeIconProps = React.ComponentPropsWithoutRef<typeof PrimitiveIcon> &
  VariantProps<typeof badgeIconStyle>

const BadgeIcon = React.forwardRef<
  React.ElementRef<typeof UIIcon>,
  IBadgeIconProps
>(({ className, size, ...props }, ref) => {
  const { size: parentSize, action: parentAction } = useStyleContext(SCOPE)

  if (typeof size === "number") {
    return (
      <UIIcon
        ref={ref}
        {...props}
        className={badgeIconStyle({ class: className })}
        size={size}
      />
    )
  } else if (
    (props?.height !== undefined || props?.width !== undefined) &&
    size === undefined
  ) {
    return (
      <UIIcon
        ref={ref}
        {...props}
        className={badgeIconStyle({ class: className })}
      />
    )
  }
  return (
    <UIIcon
      className={badgeIconStyle({
        parentVariants: {
          size: parentSize,
          action: parentAction,
        },
        size,
        class: className,
      })}
      {...props}
      ref={ref}
    />
  )
})

Badge.displayName = "Badge"
BadgeText.displayName = "BadgeText"
BadgeIcon.displayName = "BadgeIcon"

export { Badge, BadgeIcon, BadgeText }

Step 2: Update the import paths to match your project setup.

API Reference

To use this component in your project, include the following import statement in your file.

import { Badge } from "@/components/ui/badge"

export default () => (
  <Badge>
    <BadgeText />
    <BadgeIcon />
  </Badge>
)

Component Props

This section provides a comprehensive reference list for the component props, detailing descriptions, properties, types, and default behavior for easy project integration.

Badge

It inherits all the properties of React Native's View component.

BadgeText

It inherits all the properties of React Native's Text component.

BadgeIcon

Contains all Icon related layout style props and actions. It inherits all the properties of gluestack Style's AsForwarder component.

Props

Badge component is created using View component from react-native. It extends all the props supported by React Native View.

Badge

Name	Value	Default
action	error \| warning \| success \| info \| muted	success
variant	solid \| outline	solid
size	sm \| md \| lg	md

Important Note

Note: These props are exclusively applicable when utilizing the default configuration of gluestack-ui/config. If you are using a custom theme, these props may not be available.

Examples

The Examples section provides visual representations of the different variants of the component, allowing you to quickly and easily determine which one best fits your needs. Simply copy the code and integrate it into your project.

Badge with Avatar

An example of the Badge component being used with the Avatar component to display badges alongside user avatars for enhanced visual representation or identification.

<VStack space="2xl">
  <HStack space="md">
    <Avatar>
      <AvatarFallbackText>SS</AvatarFallbackText>
      <AvatarImage
        source={{
          uri: "https://images.unsplash.com/photo-1535713875002-d1d0cf377fde?ixlib=rb-4.0.3&ixid=MnwxMjA3fDB8MHxzZWFyY2h8Mnx8dXNlcnxlbnwwfHwwfHw%3D&auto=format&fit=crop&w=800&q=60",
        }}
      />
    </Avatar>
    <VStack>
      <HStack>
        <Heading size="sm">Ronald Richards</Heading>
        <Badge size="sm" variant="solid" action="success" className="ml-1">
          <BadgeText>Verified</BadgeText>
          <BadgeIcon as={BadgeCheckIcon} className="ml-1" />
        </Badge>
      </HStack>
      <Text size="sm">Nursing Assistant</Text>
    </VStack>
  </HStack>
</VStack>

Badge Composition

An example of the Badge component being used with the Composition component, allowing for the display of badges within a composition of other UI elements.

<Box className="items-center">
  <VStack>
    <Badge
      className="z-10 self-end h-[22px] w-[22px] bg-red-600 rounded-full -mb-3.5 -mr-3.5"
      variant="solid"
    >
      <BadgeText className="text-white">2</BadgeText>
    </Badge>
    <Button>
      <ButtonText>Notifications</ButtonText>
    </Button>
  </VStack>
</Box>