Badge
A small status indicator for labelling and categorising items.
ui/badge.tsx
import { mergeProps } from "@base-ui/react/merge-props";
import { useRender } from "@base-ui/react/use-render";
import { cva } from "class-variance-authority";
import type { VariantProps } from "class-variance-authority";
import type * as React from "react";
import { cn } from "@/lib/utils";
const badgeVariants = cva(
"inline-flex w-fit shrink-0 items-center justify-center gap-1 overflow-hidden whitespace-nowrap rounded-full border border-transparent px-2 py-0.5 font-medium text-xs transition-[color,box-shadow] focus-visible:border-ring focus-visible:ring-[3px] focus-visible:ring-ring/50 aria-invalid:border-destructive aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 [&>svg]:pointer-events-none [&>svg]:size-3",
{
defaultVariants: {
variant: "default",
},
variants: {
variant: {
default: "bg-primary text-primary-foreground [a&]:hover:bg-primary/90",
destructive:
"bg-destructive text-destructive-foreground focus-visible:ring-destructive/20 dark:focus-visible:ring-destructive/40 [a&]:hover:bg-destructive/90",
ghost: "[a&]:hover:bg-accent [a&]:hover:text-accent-foreground",
link: "text-primary underline-offset-4 [a&]:hover:underline",
outline:
"border-border text-foreground [a&]:hover:bg-accent [a&]:hover:text-accent-foreground",
secondary: "bg-secondary text-secondary-foreground [a&]:hover:bg-secondary/90",
success:
"bg-green-50 text-green-700 dark:bg-green-950 dark:text-green-300 [a&]:hover:bg-green-50/80 dark:[a&]:hover:bg-green-950/80",
warning:
"bg-yellow-50 text-yellow-700 dark:bg-yellow-950 dark:text-yellow-300 [a&]:hover:bg-yellow-50/80 dark:[a&]:hover:bg-yellow-950/80",
},
},
},
);
type BadgeProps = React.ComponentProps<"span"> &
VariantProps<typeof badgeVariants> & { asChild?: boolean };
const Badge = ({
className,
variant = "default",
asChild = false,
children,
...props
}: BadgeProps) =>
useRender({
defaultTagName: "span",
props: mergeProps<"span">(
{
className: cn(badgeVariants({ variant }), className),
},
asChild ? props : { ...props, children },
),
render: asChild ? (children as React.ReactElement) : undefined,
state: {
slot: "badge",
variant,
},
});
export { Badge, badgeVariants };
export type { BadgeProps };
- Where it goes
- stats
- Interaction
- animated-counter
DependenciesBundle weight · light
- ui-primitives
- @base-ui/react