Button

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

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

<template>
  <div class="flex flex-wrap items-center gap-2 md:flex-row">
    <Button variant="outline">
      Button
    </Button>
    <Button variant="outline" size="icon" aria-label="Submit">
      <ArrowUpIcon />
    </Button>
  </div>
</template>

Installation


pnpm dlx shadcn-vue@latest 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;
  }
}

Examples

Size

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

<template>
  <div class="flex flex-col items-start gap-8 sm:flex-row">
    <div class="flex items-start gap-2">
      <Button size="sm" variant="outline">
        Small
      </Button>
      <Button size="icon-sm" aria-label="Submit" variant="outline">
        <ArrowUpRightIcon />
      </Button>
    </div>
    <div class="flex items-start gap-2">
      <Button variant="outline">
        Default
      </Button>
      <Button size="icon" aria-label="Submit" variant="outline">
        <ArrowUpRightIcon />
      </Button>
    </div>
    <div class="flex items-start gap-2">
      <Button variant="outline" size="lg">
        Large
      </Button>
      <Button size="icon-lg" aria-label="Submit" variant="outline">
        <ArrowUpRightIcon />
      </Button>
    </div>
  </div>
</template>

Default

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

<template>
  <Button>
    Default
  </Button>
</template>

Outline

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

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

Secondary

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

<template>
  <Button variant="secondary">
    Secondary
  </Button>
</template>

Ghost

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

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

Destructive

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

<template>
  <Button variant="destructive">
    Destructive
  </Button>
</template>

Link

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

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

Icon

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

<template>
  <Button variant="outline" size="icon">
    <CircleFadingArrowUpIcon />
  </Button>
</template>

<template>
  <Button variant="outline" size="icon" aria-label="Submit">
    <CircleFadingArrowUpIcon />
  </Button>
</template>

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 { GitBranchIcon } from 'lucide-vue-next'
import { Button } from '@/components/ui/button'
</script>

<template>
  <Button variant="outline" size="sm">
    <GitBranchIcon />
    New Branch
  </Button>
</template>

Rounded

Use the rounded-full class to make the button rounded.

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

<template>
  <div class="flex flex-col gap-8">
    <Button variant="outline" size="icon" class="rounded-full">
      <ArrowUpIcon />
    </Button>
  </div>
</template>

Spinner

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

<template>
  <Button size="sm" variant="outline" disabled>
    <Spinner class="animate-spin" />
    Submit
  </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 variant="outline" size="icon" 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 variant="outline" size="icon" 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

The Button component is a wrapper around the button element that adds a variety of styles and functionality.

Prop	Type	Default
`variant`	`"default" \| "outline" \| "ghost" \| "destructive" \| "secondary" \| "link"`	`"default"`
`size`	`"default" \| "sm" \| "lg" \| "icon" \| "icon-sm" \| "icon-lg"`	`"default"`
`asChild`	`boolean`	`false`

Breadcrumb Button Group

On This Page

Installation Usage Cursor Examples Size Default Outline Secondary Ghost Destructive Link Icon With Icon Rounded Spinner Button Group Link (asChild)API Reference Button