Button

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

<twig:Button>
    Click me
</twig:Button>

Installation

Ensure the Symfony UX Toolkit is installed in your Symfony app:

$ composer require --dev symfony/ux-toolkit

Then, run the following command to install the component and its dependencies:

$ bin/console ux:install button --kit shadcn

The UX Toolkit is not mandatory to install a component. You can install it manually by following the next steps:

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

templates/components/Button.html.twig

{# @prop variant 'default'|'secondary'|'destructive'|'outline'|'ghost'|'link' The variant, default to `default` #}
{# @prop size 'default'|'sm'|'lg'|'icon'|'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: "inline-flex items-center justify-center gap-2 whitespace-nowrap rounded-md text-sm font-medium transition-all disabled:pointer-events-none disabled:opacity-50 [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4 shrink-0 [&_svg]:shrink-0 outline-none focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px] aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive",
    variants: {
        variant: {
            default: 'bg-primary text-primary-foreground hover:bg-primary/90',
            secondary: 'bg-secondary text-secondary-foreground hover:bg-secondary/80',
            destructive: 'bg-destructive text-white hover:bg-destructive/90 focus-visible:ring-destructive/20 dark:focus-visible:ring-destructive/40 dark:bg-destructive/60',
            outline: 'border bg-background shadow-xs hover:bg-accent hover:text-accent-foreground dark:bg-input/30 dark:border-input dark:hover:bg-input/50',
            ghost: 'hover:bg-accent hover:text-accent-foreground dark:hover:bg-accent/50',
            link: 'text-primary underline-offset-4 hover:underline',
        },
        size: {
            default: 'h-9 px-4 py-2 has-[>svg]:px-3',
            sm: 'h-8 rounded-md gap-1.5 px-3 has-[>svg]:px-2.5',
            lg: 'h-10 rounded-md px-6 has-[>svg]:px-4',
            icon: 'size-9',
            'icon-sm': 'size-8',
            'icon-lg': 'size-10',
        },
    },
) -%}
<{{ as }}
    data-slot="button"
    class="{{ style.apply({variant: variant, size: size}, attributes.render('class'))|tailwind_merge }}"
    {{ attributes }}
>
    {%- block content %}{% endblock -%}
</{{ as }}>

If necessary, 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

And the most important, enjoy!

Usage

<twig:Button>
    Click me
</twig:Button>

Examples

Default

<twig:Button>
    Click me
</twig:Button>

Primary

<twig:Button>Button</twig:Button>

Secondary

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

Destructive

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

Outline

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

Ghost

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

Link

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

Icon

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

With Icon

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

Loading

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

Different sizes

<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

<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'\|'sm'\|'lg'\|'icon'\|'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