ARK CN

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

const ButtonDemo = () => <Button>Default</Button>;

export default ButtonDemo;

Installation

npx shadcn@latest add @ark-cn/button

Install the dependency required by this primitive:

npm install @ark-ui/react class-variance-authority

Copy the component source into your app:

TSXcomponents/ui/button.tsx

"use client";

import { ark } from "@ark-ui/react/factory";
import { cva, type VariantProps } from "class-variance-authority";
import type { ComponentProps } from "react";
import { Spinner } from "@/components/ui/spinner";
import { cn } from "@/lib/utils";

const buttonVariants = cva(
  "relative inline-flex shrink-0 cursor-pointer items-center justify-center gap-2 whitespace-nowrap rounded-lg border font-medium text-base outline-none transition-shadow before:pointer-events-none before:absolute before:inset-0 before:rounded-[calc(var(--radius-lg)-1px)] pointer-coarse:after:absolute pointer-coarse:after:size-full pointer-coarse:after:min-h-11 pointer-coarse:after:min-w-11 focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-1 focus-visible:ring-offset-background data-invalid:border-destructive/36 data-invalid:focus-visible:border-destructive/64 data-invalid:focus-visible:ring-destructive/20 dark:data-invalid:border-destructive/50 dark:data-invalid:focus-visible:ring-destructive/40 disabled:pointer-events-none disabled:opacity-64 data-loading:select-none data-loading:text-transparent sm:text-sm [&_svg:not([class*='opacity-'])]:opacity-80 [&_svg:not([class*='size-'])]:size-4.5 sm:[&_svg:not([class*='size-'])]:size-4 [&_svg]:pointer-events-none [&_svg]:-mx-0.5 [&_svg]:shrink-0",
  {
    defaultVariants: {
      size: "default",
      variant: "default",
    },
    variants: {
      size: {
        default: "h-9 px-[calc(--spacing(3)-1px)] sm:h-8",
        icon: "size-9 sm:size-8",
        "icon-lg": "size-10 sm:size-9",
        "icon-sm": "size-8 sm:size-7",
        "icon-xl":
          "size-11 sm:size-10 [&_svg:not([class*='size-'])]:size-5 sm:[&_svg:not([class*='size-'])]:size-4.5",
        "icon-xs":
          "size-7 rounded-md before:rounded-[calc(var(--radius-md)-1px)] sm:size-6 not-in-data-[slot=input-group]:[&_svg:not([class*='size-'])]:size-4 sm:not-in-data-[slot=input-group]:[&_svg:not([class*='size-'])]:size-3.5",
        lg: "h-10 px-[calc(--spacing(3.5)-1px)] sm:h-9",
        sm: "h-8 gap-1.5 px-[calc(--spacing(2.5)-1px)] sm:h-7",
        xl: "h-11 px-[calc(--spacing(4)-1px)] text-lg sm:h-10 sm:text-base [&_svg:not([class*='size-'])]:size-5 sm:[&_svg:not([class*='size-'])]:size-4.5",
        xs: "h-7 gap-1 rounded-md px-[calc(--spacing(2)-1px)] text-sm before:rounded-[calc(var(--radius-md)-1px)] sm:h-6 sm:text-xs [&_svg:not([class*='size-'])]:size-4 sm:[&_svg:not([class*='size-'])]:size-3.5",
      },
      variant: {
        default:
          "not-disabled:inset-shadow-[0_1px_--theme(--color-white/16%)] border-primary bg-primary text-primary-foreground shadow-primary/24 shadow-xs hover:bg-primary/90 data-pressed:bg-primary/90 *:data-[slot=button-loading-indicator]:text-primary-foreground [:active,[data-pressed]]:inset-shadow-[0_1px_--theme(--color-black/8%)] [:disabled,:active,[data-pressed]]:shadow-none",
        destructive:
          "not-disabled:inset-shadow-[0_1px_--theme(--color-white/16%)] border-destructive bg-destructive text-white shadow-destructive/24 shadow-xs hover:bg-destructive/90 data-pressed:bg-destructive/90 *:data-[slot=button-loading-indicator]:text-white [:active,[data-pressed]]:inset-shadow-[0_1px_--theme(--color-black/8%)] [:disabled,:active,[data-pressed]]:shadow-none",
        "destructive-outline":
          "border-input bg-popover not-dark:bg-clip-padding text-destructive-foreground shadow-xs/5 not-disabled:not-active:not-data-pressed:before:shadow-[0_1px_--theme(--color-black/4%)] hover:border-destructive/32 hover:bg-destructive/4 data-pressed:border-destructive/32 data-pressed:bg-destructive/4 *:data-[slot=button-loading-indicator]:text-foreground dark:bg-input/32 dark:not-disabled:before:shadow-[0_-1px_--theme(--color-white/2%)] dark:not-disabled:not-active:not-data-pressed:before:shadow-[0_-1px_--theme(--color-white/6%)] [:disabled,:active,[data-pressed]]:shadow-none",
        ghost:
          "border-transparent text-foreground hover:bg-accent data-pressed:bg-accent *:data-[slot=button-loading-indicator]:text-foreground",
        link: "border-transparent text-foreground underline-offset-4 hover:underline data-pressed:underline *:data-[slot=button-loading-indicator]:text-foreground",
        outline:
          "border-input bg-popover not-dark:bg-clip-padding text-foreground shadow-xs/5 not-disabled:not-active:not-data-pressed:before:shadow-[0_1px_--theme(--color-black/4%)] hover:bg-accent/50 data-pressed:bg-accent/50 *:data-[slot=button-loading-indicator]:text-foreground dark:bg-input/32 dark:data-pressed:bg-input/64 dark:hover:bg-input/64 dark:not-disabled:before:shadow-[0_-1px_--theme(--color-white/2%)] dark:not-disabled:not-active:not-data-pressed:before:shadow-[0_-1px_--theme(--color-white/6%)] [:disabled,:active,[data-pressed]]:shadow-none",
        secondary:
          "border-transparent bg-secondary text-secondary-foreground hover:bg-secondary/90 data-pressed:bg-secondary/90 *:data-[slot=button-loading-indicator]:text-secondary-foreground [:active,[data-pressed]]:bg-secondary/80",
      },
    },
  },
);

interface ButtonProps extends ComponentProps<typeof ark.button> {
  variant?: VariantProps<typeof buttonVariants>["variant"];
  size?: VariantProps<typeof buttonVariants>["size"];
  loading?: boolean;
}

const Button = ({
  className,
  variant = "default",
  size = "default",
  children,
  loading = false,
  ...props
}: ButtonProps) => {
  return (
    <ark.button
      data-slot="button"
      className={cn(buttonVariants({ variant, size, className }))}
      aria-disabled={loading || undefined}
      data-loading={loading ? "" : undefined}
      {...props}
    >
      {children}
      {loading && (
        <Spinner
          className="pointer-events-none absolute"
          data-slot="button-loading-indicator"
        />
      )}
    </ark.button>
  );
};

export { Button, buttonVariants };

Add the following CSS to your stylesheet (e.g. styles.css):

@theme inline {
  --color-destructive-foreground: var(--destructive-foreground);
  --color-info: var(--info);
  --color-info-foreground: var(--info-foreground);
  --color-success: var(--success);
  --color-success-foreground: var(--success-foreground);
  --color-warning: var(--warning);
  --color-warning-foreground: var(--warning-foreground);
}
:root {
  --destructive-foreground: var(--color-red-400);
  --info: var(--color-blue-500);
  --info-foreground: var(--color-blue-700);
  --success: var(--color-emerald-500);
  --success-foreground: var(--color-emerald-700);
  --warning: var(--color-amber-500);
  --warning-foreground: var(--color-amber-700);
}
.dark {
  --destructive-foreground: var(--color-red-400);
  --info: var(--color-blue-500);
  --info-foreground: var(--color-blue-400);
  --success: var(--color-emerald-500);
  --success-foreground: var(--color-emerald-400);
  --warning: var(--color-amber-500);
  --warning-foreground: var(--color-amber-400);
}

Update import aliases to match your project setup.

Usage

import * as Button from "@/components/ui/button"

Read exported parts in src/components/ui/button.tsx and compose the primitive according to the Ark UI pattern for this component.

Examples

Default

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

const ButtonDemo = () => <Button>Default</Button>;

export default ButtonDemo;

Outline

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

const ButtonOutlineDemo = () => <Button variant="outline">Outline</Button>;

export default ButtonOutlineDemo;

Secondary

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

const ButtonSecondaryDemo = () => (
  <Button variant="secondary">Secondary</Button>
);

export default ButtonSecondaryDemo;

Destructive

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

const ButtonDestructiveDemo = () => (
  <Button variant="destructive">Destructive</Button>
);

export default ButtonDestructiveDemo;

Destructive Outline

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

const ButtonDestructiveOutlineDemo = () => (
  <Button variant="destructive-outline">Destructive Outline</Button>
);

export default ButtonDestructiveOutlineDemo;

Ghost

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

const ButtonGhostDemo = () => <Button variant="ghost">Ghost</Button>;

export default ButtonGhostDemo;

Link

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

const ButtonLinkDemo = () => <Button variant="link">Link</Button>;

export default ButtonLinkDemo;

Extra-small Size

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

const ButtonExtraSmallDemo = () => <Button size="xs">Extra-small Size</Button>;

export default ButtonExtraSmallDemo;

Small Size

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

const ButtonSmallDemo = () => <Button size="sm">Small Size</Button>;

export default ButtonSmallDemo;

Large Size

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

const ButtonLargeDemo = () => <Button size="lg">Large Size</Button>;

export default ButtonLargeDemo;

Extra-large Size

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

const ButtonExtraLargeDemo = () => <Button size="xl">Extra-large Size</Button>;

export default ButtonExtraLargeDemo;

Disabled

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

const ButtonDisabledDemo = () => <Button disabled>Disabled</Button>;

export default ButtonDisabledDemo;

Icon

import { PlusIcon } from "lucide-react";
import { Button } from "@/components/ui/button";

const ButtonIconDemo = () => (
  <Button aria-label="Add item" size="icon">
    <PlusIcon />
  </Button>
);

export default ButtonIconDemo;

Icon Small Size

import { PlusIcon } from "lucide-react";
import { Button } from "@/components/ui/button";

const ButtonIconSmallDemo = () => (
  <Button aria-label="Add item small" size="icon-sm">
    <PlusIcon />
  </Button>
);

export default ButtonIconSmallDemo;

Icon Large Size

import { PlusIcon } from "lucide-react";
import { Button } from "@/components/ui/button";

const ButtonIconLargeDemo = () => (
  <Button aria-label="Add item large" size="icon-lg">
    <PlusIcon />
  </Button>
);

export default ButtonIconLargeDemo;

With Icon

import { PlusIcon } from "lucide-react";
import { Button } from "@/components/ui/button";

const ButtonWithIconDemo = () => (
  <Button>
    <PlusIcon />
    With Icon
  </Button>
);

export default ButtonWithIconDemo;

With Link

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

const ButtonWithLinkDemo = () => <Button variant="link">Open docs</Button>;

export default ButtonWithLinkDemo;

Loading (Built-in Prop)

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

const ButtonLoadingBuiltInDemo = () => (
  <Button loading>Loading (Built-in Prop)</Button>
);

export default ButtonLoadingBuiltInDemo;

Loading (Custom Composition)

import { Loader2Icon } from "lucide-react";
import { Button } from "@/components/ui/button";

const ButtonLoadingCustomCompositionDemo = () => (
  <Button aria-live="polite" disabled>
    <Loader2Icon className="animate-spin" />
    Loading (Custom Composition)
  </Button>
);

export default ButtonLoadingCustomCompositionDemo;

API reference

This component is an ark-cn composition. All props and DOM behavior are defined by Ark unless you see an ark-cn-only row below.

Button

Prop	Type	Description
variant?	"default" \| "destructive" \| "outline" \| "secondary" \| "ghost" \| "link" \| "info" \| "success" \| "warning" \| "destructive-outline"	Visual style preset.
size?	"default" \| "sm" \| "lg" \| "xl" \| "xs" \| "icon" \| "icon-xs" \| "icon-sm" \| "icon-lg"	Size preset including icon-only sizes.
loading?	boolean	Shows spinner, sets aria-disabled and data-loading.

Button

Installation

Usage

Examples

Default

Outline

Secondary

Destructive

Destructive Outline

Ghost

Link

Extra-small Size

Small Size

Large Size

Extra-large Size

Disabled

Icon

Icon Small Size

Icon Large Size

With Icon

With Link

Loading (Built-in Prop)

Loading (Custom Composition)

API reference

Button

On this page