Button

A clickable element that triggers actions or events, supporting various styles and states.

Loading...
<div class="flex flex-wrap items-center gap-2 md:flex-row">
    <twig:Button variant="outline">Button</twig:Button>
    <twig:Button variant="outline" size="icon" aria-label="Submit">
        <twig:ux:icon name="lucide:arrow-up" />
    </twig:Button>
</div>

Installation

bin/console ux:install button --kit shadcn

That's it!

Install the following Composer dependencies:

composer require twig/extra-bundle twig/html-extra:^3.12.0 tales-from-a-dev/twig-tailwind-extra:^1.0.0

Copy the following file(s) into your Symfony app:

{# @prop variant 'default'|'secondary'|'destructive'|'outline'|'ghost'|'link' The variant, default to `default` #}
{# @prop size 'default'|'xs'|'sm'|'lg'|'icon'|'icon-xs'|'icon-sm'|'icon-lg' The size, default to `default` #}
{# @prop as 'button' The HTML tag to use, default to `button` #}
{# @block content The default block #}
{%- props variant = 'default', size = 'default', as = 'button' -%}
{%- set style = html_cva(
    base: "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-[3px] aria-invalid:ring-[3px] [&_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",
    variants: {
        variant: {
            default: 'bg-primary text-primary-foreground [a]:hover:bg-primary/80',
            secondary: 'bg-secondary text-secondary-foreground hover:bg-secondary/80 aria-expanded:bg-secondary aria-expanded:text-secondary-foreground',
            destructive: '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',
            outline: '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',
            ghost: 'hover:bg-muted hover:text-foreground dark:hover:bg-muted/50 aria-expanded:bg-muted aria-expanded:text-foreground',
            link: 'text-primary underline-offset-4 hover:underline',
        },
        size: {
            default: 'h-8 gap-1.5 px-2.5 has-data-[icon=inline-end]:pr-2 has-data-[icon=inline-start]:pl-2',
            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",
            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",
            lg: 'h-9 gap-1.5 px-2.5 has-data-[icon=inline-end]:pr-3 has-data-[icon=inline-start]:pl-3',
            icon: 'size-8',
            'icon-xs': "size-6 rounded-[min(var(--radius-md),10px)] in-data-[slot=button-group]:rounded-lg [&_svg:not([class*='size-'])]:size-3",
            'icon-sm': 'size-7 rounded-[min(var(--radius-md),12px)] in-data-[slot=button-group]:rounded-lg',
            'icon-lg': 'size-9',
        },
    },
) -%}
<{{ as }}
    data-slot="button"
    class="{{ style.apply({variant: variant, size: size}, attributes.render('class'))|tailwind_merge }}"
    {{ attributes }}
>
    {%- block content %}{% endblock -%}
</{{ as }}>

Happy coding!

Usage

<twig:Button variant="outline">Button</twig:Button>

Examples

Default

Loading...
<twig:Button>Button</twig:Button>

Outline

Loading...
<twig:Button variant="outline">Outline</twig:Button>

Secondary

Loading...
<twig:Button variant="secondary">Secondary</twig:Button>

Ghost

Loading...
<twig:Button variant="ghost">Ghost</twig:Button>

Destructive

Loading...
<twig:Button variant="destructive">Destructive</twig:Button>

Link

Loading...
<twig:Button variant="link">Link</twig:Button>

Icon

Loading...
<twig:Button variant="outline" size="icon">
    <twig:ux:icon name="lucide:circle-fading-arrow-up" />
</twig:Button>

With Icon

Loading...
<twig:Button>
    <twig:ux:icon name="lucide:mail" /> Login with Email
</twig:Button>

Rounded

Loading...
<twig:Button variant="outline" size="icon" class="rounded-full">
    <twig:ux:icon name="lucide:arrow-up" />
</twig:Button>

Loading

Loading...
<twig:Button disabled>
    <twig:ux:icon name="lucide:loader-2" class="animate-spin" /> Please wait
</twig:Button>

Different sizes

Loading...
<div class="flex flex-col items-start gap-8 sm:flex-row">
    <div class="flex items-center gap-2">
        <twig:Button size="sm" variant="outline">Small</twig:Button>
        <twig:Button size="icon-sm" variant="outline" aria-label="Submit">
            <twig:ux:icon name="lucide:arrow-up-right" class="size-4" />
        </twig:Button>
    </div>
    <div class="flex items-center gap-2">
        <twig:Button variant="outline">Default</twig:Button>
        <twig:Button variant="outline" aria-label="Submit">
            <twig:ux:icon name="lucide:arrow-up-right" class="size-4" />
        </twig:Button>
    </div>
    <div class="flex items-center gap-2">
        <twig:Button size="lg" variant="outline">Large</twig:Button>
        <twig:Button size="icon-lg" variant="outline" aria-label="Submit">
            <twig:ux:icon name="lucide:arrow-up-right" class="size-4" />
        </twig:Button>
    </div>
</div>

As link

Loading...
<twig:Button as="a" href="https://example.com">Link</twig:Button>

API Reference

Button

Prop Type Description
variant 'default'|'secondary'|'destructive'|'outline'|'ghost'|'link' The variant, default to default
size 'default'|'xs'|'sm'|'lg'|'icon'|'icon-xs'|'icon-sm'|'icon-lg' The size, default to default
as 'button' The HTML tag to use, default to button
Block Description
content The default block