Presets

Blocks

Get PRO

Need premium blocks and templates? Upgrade to PRO and get access.

Upgrade
JoinLogin
Presets
Monochrome
Overview
  • Introduction
  • Components
  • Installation
Components
  • Accordion
  • Alert
  • Alert Dialog
  • Aspect Ratio
  • Avatar
  • Badge
  • Breadcrumb
  • Button
  • Button Group
  • CalendarNEW
  • Card
  • CarouselNEW
  • Checkbox
  • Collapsible
  • Dialog
  • Dropdown Menu
  • Empty
  • Field
  • Input
  • Input Group
  • Item
  • Kbd
  • Label
  • Native Select
  • Scroll Area
  • SelectNEW
  • Separator
  • SwitchNEW
  • Table
  • Tabs
  • Textarea
  • TooltipNEW

Button

PreviousNext

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

1import { Button } from "@/components/ui/button";2import { ArrowUpIcon } from "lucide-solid";34export default function Preview() {

Installation

pnpm dlx sprawlify@latest add button
npx sprawlify@latest add button
yarn sprawlify@latest add button
bunx --bun sprawlify@latest add button

Install the following dependencies:

pnpm add @sprawlify/primitives @sprawlify/solid
npm install @sprawlify/primitives @sprawlify/solid
yarn add @sprawlify/primitives @sprawlify/solid
bun add @sprawlify/primitives @sprawlify/solid

Add the following files to your project:

button.tsx
1import { cva, type VariantProps } from "class-variance-authority";2import { cn } from "@/lib/utils";3import { sprawlify } from "@sprawlify/solid";4import type { ComponentProps } from "solid-js";5import { splitProps } from "solid-js";67const buttonVariants = cva(8  "focus-visible:border-ring focus-visible:ring-ring/50 aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive dark:aria-invalid:border-destructive/50 rounded-lg border border-transparent bg-clip-padding text-sm font-medium focus-visible:ring-3 aria-invalid:ring-3 [&_svg:not([class*='size-'])]:size-4 inline-flex items-center justify-center whitespace-nowrap transition-all disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none shrink-0 [&_svg]:shrink-0 outline-none group/button select-none",9  {10    variants: {11      variant: {12        default: "bg-primary text-primary-foreground [a]:hover:bg-primary/80",13        outline:14          "border-border bg-background hover:bg-muted hover:text-foreground dark:bg-input/30 dark:border-input dark:hover:bg-input/50 aria-expanded:bg-muted aria-expanded:text-foreground",15        secondary:16          "bg-secondary text-secondary-foreground hover:bg-secondary/80 aria-expanded:bg-secondary aria-expanded:text-secondary-foreground",17        ghost:18          "hover:bg-muted hover:text-foreground dark:hover:bg-muted/50 aria-expanded:bg-muted aria-expanded:text-foreground",19        destructive:20          "bg-destructive/10 hover:bg-destructive/20 focus-visible:ring-destructive/20 dark:focus-visible:ring-destructive/40 dark:bg-destructive/20 text-destructive focus-visible:border-destructive/40 dark:hover:bg-destructive/30",21        link: "text-primary underline-offset-4 hover:underline",22      },23      size: {24        default:25          "h-8 gap-1.5 px-2.5 has-data-[icon=inline-end]:pr-2 has-data-[icon=inline-start]:pl-2",26        xs: "h-6 gap-1 rounded-[min(var(--radius-md),10px)] px-2 text-xs in-data-[slot=button-group]:rounded-lg has-data-[icon=inline-end]:pr-1.5 has-data-[icon=inline-start]:pl-1.5 [&_svg:not([class*='size-'])]:size-3",27        sm: "h-7 gap-1 rounded-[min(var(--radius-md),12px)] px-2.5 text-[0.8rem] in-data-[slot=button-group]:rounded-lg has-data-[icon=inline-end]:pr-1.5 has-data-[icon=inline-start]:pl-1.5 [&_svg:not([class*='size-'])]:size-3.5",28        lg: "h-9 gap-1.5 px-2.5 has-data-[icon=inline-end]:pr-3 has-data-[icon=inline-start]:pl-3",29        icon: "size-8",30        "icon-xs":31          "size-6 rounded-[min(var(--radius-md),10px)] in-data-[slot=button-group]:rounded-lg [&_svg:not([class*='size-'])]:size-3",32        "icon-sm":33          "size-7 rounded-[min(var(--radius-md),12px)] in-data-[slot=button-group]:rounded-lg",34        "icon-lg": "size-9",35      },36    },37    defaultVariants: {38      variant: "default",39      size: "default",40    },41  },42);4344function Button(45  props: ComponentProps<typeof sprawlify.button> & VariantProps<typeof buttonVariants>,46) {47  const [local, others] = splitProps(props, ["variant", "size", "class"]);48  const variant = () => local.variant ?? "default";49  const size = () => local.size ?? "default";5051  return (52    <sprawlify.button53      data-scope="button"54      data-part="root"55      data-slot="button"56      data-variant={variant()}57      data-size={size()}58      class={cn(buttonVariants({ variant: variant(), size: size(), class: local.class }))}59      {...others}60    />61  );62}6364export { Button, buttonVariants };65

Update the import paths to match your project setup.

Usage

1import { Button } from "@/components/ui/button"
1<Button variant="outline">Button</Button>

Examples

Default

1import { Button } from "@/components/ui/button";23export default function Preview() {4  return <Button>Button</Button>;

Destructive

1import { Button } from "@/components/ui/button";23export default function Preview() {4  return <Button variant="destructive">Destructive</Button>;

Ghost

1import { Button } from "@/components/ui/button";23export default function Preview() {4  return <Button variant="ghost">Ghost</Button>;

Icon

1import { Button } from "@/components/ui/button";2import { CircleFadingArrowUpIcon } from "lucide-solid";34export default function Preview() {

Link

You can use the asChild prop on <Button /> to make another component look like a button. Here's an example of a link that looks like a button.

1import { Button } from "@/components/ui/button";23export default function Preview() {4  return <Button variant="link">Link</Button>;

Outline

1import { Button } from "@/components/ui/button";23export default function Preview() {4  return <Button variant="outline">Outline</Button>;

Rounded

1import { Button } from "@/components/ui/button";2import { ArrowUpIcon } from "lucide-solid";34export default function Preview() {

Secondary

1import { Button } from "@/components/ui/button";23export default function Preview() {4  return <Button variant="secondary">Secondary</Button>;

Size

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

1import { Button } from "@/components/ui/button";2import { ArrowUpRightIcon } from "lucide-solid";34export default function Preview() {

With Icon

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

1import { Button } from "@/components/ui/button";2import { GitBranchIcon } from "lucide-solid";34export default function Preview() {

On This Page

InstallationUsageExamplesDefaultDestructiveGhostIconLinkOutlineRoundedSecondarySizeWith Icon

Get PRO

Need premium blocks and templates? Upgrade to PRO and get access.