Sections

Get Started

Forms

Registry

Button

Displays a button or a component that looks like a button.

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <div class="flex flex-wrap items-center gap-2 md:flex-row">
    <Button>
      Button
    </Button>
    <Button variant="outline">
      Outline
    </Button>
  </div>
</template>

Installation


pnpm dlx @frontic/ui add button

Usage

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <Button variant="outline">
    Button
  </Button>
</template>

Cursor

Tailwind v4 switched from cursor: pointer to cursor: default for the button component.

If you want to keep the cursor: pointer behavior, add the following code to your CSS file:

tailwind.css

@layer base {
  button:not(:disabled),
  [role="button"]:not(:disabled) {
    cursor: pointer;
  }
}

Variants

Outline

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <Button variant="outline">
    Outline
  </Button>
</template>

Ghost

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <Button variant="ghost">
    Ghost
  </Button>
</template>

Link

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <Button variant="link">
    Link
  </Button>
</template>

Subtle

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <Button variant="subtle">Subtle</Button>
</template>

Colors

Primary

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <div class="flex flex-wrap items-center gap-2">
    <Button color="primary">Primary</Button>
    <Button color="primary" variant="subtle">Subtle</Button>
    <Button color="primary" variant="outline">Outline</Button>
  </div>
</template>

Secondary

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <div class="flex flex-wrap items-center gap-2">
    <Button color="secondary">Secondary</Button>
    <Button color="secondary" variant="subtle">Subtle</Button>
    <Button color="secondary" variant="outline">Outline</Button>
  </div>
</template>

Inverted

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <div class="flex flex-wrap items-center gap-2">
    <Button color="inverted">Inverted</Button>
    <Button color="inverted" variant="subtle">Subtle</Button>
    <Button color="inverted" variant="outline">Outline</Button>
  </div>
</template>

Buy

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <div class="flex flex-wrap items-center gap-2">
    <Button color="buy">Buy</Button>
    <Button color="buy" variant="subtle">Subtle</Button>
    <Button color="buy" variant="outline">Outline</Button>
  </div>
</template>

Checkout

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <div class="flex flex-wrap items-center gap-2">
    <Button color="checkout">Checkout</Button>
    <Button color="checkout" variant="subtle">Subtle</Button>
    <Button color="checkout" variant="outline">Outline</Button>
  </div>
</template>

Destructive

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <div class="flex flex-wrap items-center gap-2">
    <Button color="destructive">Destructive</Button>
    <Button color="destructive" variant="subtle">Subtle</Button>
    <Button color="destructive" variant="outline">Outline</Button>
  </div>
</template>

Positive

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <div class="flex flex-wrap items-center gap-2">
    <Button color="positive">Positive</Button>
    <Button color="positive" variant="subtle">Subtle</Button>
    <Button color="positive" variant="outline">Outline</Button>
  </div>
</template>

Sizes

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <div class="flex flex-wrap items-end gap-2">
    <Button size="xs" variant="outline">
      Extra Small
    </Button>
    <Button size="sm" variant="outline">
      Small
    </Button>
    <Button size="default" variant="outline">
      Default
    </Button>
    <Button size="lg" variant="outline">
      Large
    </Button>
  </div>
</template>

Pill

Use the pill prop to make the button fully rounded. Combines with any variant and color.

<script setup lang="ts">
import { CreditCardIcon, ShoppingCartIcon } from 'lucide-vue-next'
import { Button } from '@/components/ui/button'
</script>

<template>
  <div class="flex items-center gap-2">
    <Button pill color="buy">
      <ShoppingCartIcon />
      Add to Cart
    </Button>
    <Button pill color="checkout">
      <CreditCardIcon />
      Checkout
    </Button>
    <Button pill variant="outline">
      Continue Shopping
    </Button>
  </div>
</template>

Icon

For icon-only buttons like wishlist or favorite toggles, use the icon prop to make the button square. It automatically matches the width to the button height at any size.

<script setup lang="ts">
import { HeartIcon } from 'lucide-vue-next'
import { Button } from '@/components/ui/button'
</script>

<template>
  <Button icon variant="outline" pill aria-label="Add to Wishlist">
    <HeartIcon />
  </Button>
</template>

Examples

With Icon

The spacing between the icon and the text is automatically adjusted based on the size of the button. You do not need any margin on the icon.

<script setup lang="ts">
import { ShoppingCartIcon } from 'lucide-vue-next'
import { Button } from '@/components/ui/button'
</script>

<template>
  <Button color="buy">
    <ShoppingCartIcon />
    Add to Cart
  </Button>
</template>

Loading

<script setup lang="ts">
import { Button } from '@/components/ui/button'
import { Spinner } from '@/components/ui/spinner'
</script>

<template>
  <Button pill color="checkout" disabled>
    <Spinner class="animate-spin" />
    Processing Payment
  </Button>
</template>

Button Group

<script setup lang="ts">
import { ArchiveIcon, ArrowLeftIcon, CalendarPlusIcon, ClockIcon, ListFilterPlusIcon, MailCheckIcon, MoreHorizontalIcon, TagIcon, Trash2Icon } from 'lucide-vue-next'
import { Button } from '@/components/ui/button'
import { ButtonGroup } from '@/components/ui/button-group'
import { DropdownMenu, DropdownMenuContent, DropdownMenuGroup, DropdownMenuItem, DropdownMenuRadioGroup, DropdownMenuRadioItem, DropdownMenuSeparator, DropdownMenuSub, DropdownMenuSubContent, DropdownMenuSubTrigger, DropdownMenuTrigger } from '@/components/ui/dropdown-menu'

const label = ref('personal')
</script>

<template>
  <ButtonGroup>
    <ButtonGroup class="hidden sm:flex">
      <Button icon variant="outline" aria-label="Go Back">
        <ArrowLeftIcon />
      </Button>
    </ButtonGroup>
    <ButtonGroup>
      <Button variant="outline">
        Archive
      </Button>
      <Button variant="outline">
        Report
      </Button>
    </ButtonGroup>
    <ButtonGroup>
      <Button variant="outline">
        Snooze
      </Button>
      <DropdownMenu>
        <DropdownMenuTrigger as-child>
          <Button icon variant="outline" aria-label="More Options">
            <MoreHorizontalIcon />
          </Button>
        </DropdownMenuTrigger>
        <DropdownMenuContent align="end" class="w-52">
          <DropdownMenuGroup>
            <DropdownMenuItem>
              <MailCheckIcon />
              Mark as Read
            </DropdownMenuItem>
            <DropdownMenuItem>
              <ArchiveIcon />
              Archive
            </DropdownMenuItem>
          </DropdownMenuGroup>
          <DropdownMenuSeparator />
          <DropdownMenuGroup>
            <DropdownMenuItem>
              <ClockIcon />
              Snooze
            </DropdownMenuItem>
            <DropdownMenuItem>
              <CalendarPlusIcon />
              Add to Calendar
            </DropdownMenuItem>
            <DropdownMenuItem>
              <ListFilterPlusIcon />
              Add to List
            </DropdownMenuItem>
            <DropdownMenuSub>
              <DropdownMenuSubTrigger>
                <TagIcon class="mr-2 size-4" />
                Label As...
              </DropdownMenuSubTrigger>
              <DropdownMenuSubContent>
                <DropdownMenuRadioGroup v-model="label">
                  <DropdownMenuRadioItem value="personal">
                    Personal
                  </DropdownMenuRadioItem>
                  <DropdownMenuRadioItem value="work">
                    Work
                  </DropdownMenuRadioItem>
                  <DropdownMenuRadioItem value="other">
                    Other
                  </DropdownMenuRadioItem>
                </DropdownMenuRadioGroup>
              </DropdownMenuSubContent>
            </DropdownMenuSub>
          </DropdownMenuGroup>
          <DropdownMenuSeparator />
          <DropdownMenuGroup>
            <DropdownMenuItem variant="destructive">
              <Trash2Icon />
              Trash
            </DropdownMenuItem>
          </DropdownMenuGroup>
        </DropdownMenuContent>
      </DropdownMenu>
    </ButtonGroup>
  </ButtonGroup>
</template>

To create a button group, use the ButtonGroup component. See the Button Group documentation for more details.

Link (asChild)

You can use the as-child prop to make another component look like a button. Here's an example of a link that looks like a button.

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <Button as-child>
    <a href="/login">Login</a>
  </Button>
</template>

API Reference

Button

Renders a <button> element by default. Use as-child to render a different element with button styling.

Prop	Type	Default
`variant`	`"default" \| "subtle" \| "outline" \| "ghost" \| "link" \| "form"`	`"default"`
`color`	`"primary" \| "secondary" \| "inverted" \| "buy" \| "checkout" \| "destructive" \| "positive"`	`"primary"`
`size`	`"md" \| "xs" \| "sm" \| "lg" \| "xl"`	`"md"`
`pill`	`boolean`	`false`
`icon`	`boolean`	`false`
`as-child`	`boolean`	`false`

<script setup lang="ts">
import { Button } from '@/components/ui/button'
</script>

<template>
  <Button variant="outline" color="buy" pill size="lg" icon>
    <ShoppingCartIcon />
  </Button>
</template>

Use the as-child prop to render a different element, such as a link that looks like a button.

<template>
  <Button as-child color="checkout">
    <a href="/checkout">Proceed to Checkout</a>
  </Button>
</template>

Breadcrumb Button Group