Button

v1.0.0
Form

A versatile button component with multiple variants and sizes for different use cases.

Dependencies

@radix-ui/react-slot
class-variance-authority
Installation
Add this component to your project

CLI Installation

npx shadcn@latest add button

Manual Installation

import * as React from "react"
import { Slot } from "@radix-ui/react-slot"
import { cva, type VariantProps } from "class-variance-authority"
import { cn } from "@/lib/utils"

const buttonVariants = cva(
  "inline-flex items-center justify-center gap-2 whitespace-nowrap rounded-md text-sm font-medium ring-offset-background transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg]:size-4 [&_svg]:shrink-0",
  {
    variants: {
      variant: {
        default: "bg-primary text-primary-foreground hover:bg-primary/90",
        destructive: "bg-destructive text-destructive-foreground hover:bg-destructive/90",
        outline: "border border-input bg-background hover:bg-accent hover:text-accent-foreground",
        secondary: "bg-secondary text-secondary-foreground hover:bg-secondary/80",
        ghost: "hover:bg-accent hover:text-accent-foreground",
        link: "text-primary underline-offset-4 hover:underline",
      },
      size: {
        default: "h-10 px-4 py-2",
        sm: "h-9 rounded-md px-3",
        lg: "h-11 rounded-md px-8",
        icon: "h-10 w-10",
      },
    },
    defaultVariants: {
      variant: "default",
      size: "default",
    },
  }
)

export interface ButtonProps
  extends React.ButtonHTMLAttributes<HTMLButtonElement>,
    VariantProps<typeof buttonVariants> {
  asChild?: boolean
}

const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(
  ({ className, variant, size, asChild = false, ...props }, ref) => {
    const Comp = asChild ? Slot : "button"
    return (
      <Comp
        className={cn(buttonVariants({ variant, size, className }))}
        ref={ref}
        {...props}
      />
    )
  }
)
Button.displayName = "Button"

export { Button, buttonVariants }
Props
Component properties and their types
variant
'default' | 'destructive' | 'outline' | 'secondary' | 'ghost' | 'link'
default: 'default'

The visual style variant of the button

size
'default' | 'sm' | 'lg' | 'icon'
default: 'default'

The size of the button

asChild
boolean
default: false

Change the default rendered element for the one passed as a child

disabled
boolean
default: false

Whether the button is disabled

Examples
3 different usage examples

Default Button

import { Button } from "@/components/ui/button"

export function ButtonDemo() {
  return <Button>Click me</Button>
}

Registry

View the component registry file

View Registry
Live Preview
Interactive
3 examples available