8.0k New

Button

Previous Next

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

API Reference

Epicenter

Local-first, open source apps

Special Sponsor 
<script lang="ts">
	import ArrowUpIcon from "@lucide/svelte/icons/arrow-up";
	import { Button } from "$lib/components/ui/button/index.js";
</script>
 
<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>

Installation 

pnpm dlx shadcn-svelte@latest add button

Usage 

<script lang="ts">
  import { Button } from "$lib/components/ui/button/index.js";
</script>
 
<Button variant="outline">Button</Button>

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:

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

Size

Use the size prop to change the size of the button.

<script lang="ts">
	import ArrowUpRightIcon from "@lucide/svelte/icons/arrow-up-right";
	import { Button } from "$lib/components/ui/button/index.js";
</script>
 
<div class="flex flex-col items-start gap-8 sm:flex-row">
	<div class="flex items-start gap-2">
		<Button size="xs" variant="outline">Extra Small</Button>
		<Button size="icon-xs" aria-label="Submit" variant="outline">
			<ArrowUpRightIcon />
		</Button>
	</div>
	<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>

Default 

<script lang="ts">
	import { Button } from "$lib/components/ui/button/index.js";
</script>
 
<Button>Button</Button>

Outline 

<script lang="ts">
	import { Button } from "$lib/components/ui/button/index.js";
</script>
 
<Button variant="outline">Outline</Button>

Secondary 

<script lang="ts">
	import { Button } from "$lib/components/ui/button/index.js";
</script>
 
<Button variant="secondary">Secondary</Button>

Ghost 

<script lang="ts">
	import { Button } from "$lib/components/ui/button/index.js";
</script>
 
<Button variant="ghost">Ghost</Button>

Destructive 

<script lang="ts">
	import { Button } from "$lib/components/ui/button/index.js";
</script>
 
<Button variant="destructive">Destructive</Button>

Link 

<script lang="ts">
	import { Button } from "$lib/components/ui/button/index.js";
</script>
 
<Button variant="link">Link</Button>

Icon 

<script lang="ts">
	import CircleFadingArrowUpIcon from "@lucide/svelte/icons/circle-fading-arrow-up";
	import { Button } from "$lib/components/ui/button/index.js";
</script>
 
<Button variant="outline" size="icon" aria-label="Submit">
	<CircleFadingArrowUpIcon />
</Button>

With Icon

Remember to add the data-icon="inline-start" or data-icon="inline-end" attribute to the icon for the correct spacing.

<script lang="ts">
	import IconGitBranch from "@tabler/icons-svelte/icons/git-branch";
	import IconGitFork from "@tabler/icons-svelte/icons/git-fork";
	import { Button } from "$lib/components/ui/button/index.js";
</script>
 
<div class="flex gap-2">
	<Button variant="outline">
		<IconGitBranch data-icon="inline-start" /> New Branch
	</Button>
	<Button variant="outline">
		Fork
		<IconGitFork data-icon="inline-end" />
	</Button>
</div>

Rounded

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

<script lang="ts">
	import ArrowUpIcon from "@lucide/svelte/icons/arrow-up";
	import { Button } from "$lib/components/ui/button/index.js";
</script>
 
<div class="flex gap-2">
	<Button class="rounded-full">Get Started</Button>
	<Button variant="outline" size="icon" class="rounded-full">
		<ArrowUpIcon />
	</Button>
</div>

Spinner

Render a <Spinner /> component inside the button to show a loading state. Remember to add the data-icon="inline-start" or data-icon="inline-end" attribute to the spinner for the correct spacing.

<script lang="ts">
	import { Button } from "$lib/components/ui/button/index.js";
	import { Spinner } from "$lib/components/ui/spinner/index.js";
</script>
 
<div class="flex gap-2">
	<Button variant="outline" disabled>
		<Spinner data-icon="inline-start" />
		Generating
	</Button>
	<Button variant="secondary" disabled>
		Downloading
		<Spinner data-icon="inline-end" />
	</Button>
</div>

Button Group

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

<script lang="ts">
	import Archive from "@lucide/svelte/icons/archive";
	import ArrowLeft from "@lucide/svelte/icons/arrow-left";
	import CalendarPlus from "@lucide/svelte/icons/calendar-plus";
	import Clock from "@lucide/svelte/icons/clock";
	import ListFilter from "@lucide/svelte/icons/list-filter";
	import MailCheck from "@lucide/svelte/icons/mail-check";
	import MoreHorizontal from "@lucide/svelte/icons/more-horizontal";
	import Tag from "@lucide/svelte/icons/tag";
	import Trash2 from "@lucide/svelte/icons/trash-2";
	import * as ButtonGroup from "$lib/components/ui/button-group/index.js";
	import * as DropdownMenu from "$lib/components/ui/dropdown-menu/index.js";
	import { Button } from "$lib/components/ui/button/index.js";
 
	let label = $state("personal");
</script>
 
<ButtonGroup.Root>
	<ButtonGroup.Root class="hidden sm:flex">
		<Button variant="outline" size="icon" aria-label="Go Back">
			<ArrowLeft />
		</Button>
	</ButtonGroup.Root>
	<ButtonGroup.Root>
		<Button variant="outline">Archive</Button>
		<Button variant="outline">Report</Button>
	</ButtonGroup.Root>
	<ButtonGroup.Root>
		<Button variant="outline">Snooze</Button>
		<DropdownMenu.Root>
			<DropdownMenu.Trigger>
				{#snippet child({ props })}
					<Button {...props} variant="outline" size="icon" aria-label="More Options">
						<MoreHorizontal />
					</Button>
				{/snippet}
			</DropdownMenu.Trigger>
			<DropdownMenu.Content align="end" class="w-40">
				<DropdownMenu.Group>
					<DropdownMenu.Item>
						<MailCheck />
						Mark as Read
					</DropdownMenu.Item>
					<DropdownMenu.Item>
						<Archive />
						Archive
					</DropdownMenu.Item>
				</DropdownMenu.Group>
				<DropdownMenu.Separator />
				<DropdownMenu.Group>
					<DropdownMenu.Item>
						<Clock />
						Snooze
					</DropdownMenu.Item>
					<DropdownMenu.Item>
						<CalendarPlus />
						Add to Calendar
					</DropdownMenu.Item>
					<DropdownMenu.Item>
						<ListFilter />
						Add to List
					</DropdownMenu.Item>
					<DropdownMenu.Sub>
						<DropdownMenu.SubTrigger>
							<Tag />
							Label As...
						</DropdownMenu.SubTrigger>
						<DropdownMenu.SubContent>
							<DropdownMenu.RadioGroup bind:value={label}>
								<DropdownMenu.RadioItem value="personal">Personal</DropdownMenu.RadioItem>
								<DropdownMenu.RadioItem value="work">Work</DropdownMenu.RadioItem>
								<DropdownMenu.RadioItem value="other">Other</DropdownMenu.RadioItem>
							</DropdownMenu.RadioGroup>
						</DropdownMenu.SubContent>
					</DropdownMenu.Sub>
				</DropdownMenu.Group>
				<DropdownMenu.Separator />
				<DropdownMenu.Group>
					<DropdownMenu.Item variant="destructive">
						<Trash2 />
						Trash
					</DropdownMenu.Item>
				</DropdownMenu.Group>
			</DropdownMenu.Content>
		</DropdownMenu.Root>
	</ButtonGroup.Root>
</ButtonGroup.Root>

As Link

Pass an href prop to <Button /> to render it as an <a> element that looks like a button. You can also use the buttonVariants helper to make any other element look like a button.

<script lang="ts">
	import { Button } from "$lib/components/ui/button/index.js";
</script>
 
<Button href="#" variant="secondary" size="sm">Login</Button>