View as Markdown

Button

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

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

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

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 app:

{# @prop variant &#039;default&#039;|&#039;secondary&#039;|&#039;destructive&#039;|&#039;outline&#039;|&#039;ghost&#039;|&#039;link&#039; The visual style variant. #}
{# @prop size &#039;default&#039;|&#039;xs&#039;|&#039;sm&#039;|&#039;lg&#039;|&#039;icon&#039;|&#039;icon-xs&#039;|&#039;icon-sm&#039;|&#039;icon-lg&#039; The button size. #}
{# @prop as &#039;button&#039; The HTML tag to render. #}
{# @block content The button label and/or icon. #}
{%- props variant = &#039;default&#039;, size = &#039;default&#039;, as = &#039;button&#039; -%}
{%- set style = html_cva(
    base: &quot;group/button inline-flex shrink-0 items-center justify-center rounded-lg border border-transparent bg-clip-padding text-sm font-medium whitespace-nowrap transition-all outline-none select-none focus-visible:border-ring focus-visible:ring-3 focus-visible:ring-ring/50 active:not-aria-[haspopup]:translate-y-px disabled:pointer-events-none disabled:opacity-50 aria-invalid:border-destructive aria-invalid:ring-3 aria-invalid:ring-destructive/20 dark:aria-invalid:border-destructive/50 dark:aria-invalid:ring-destructive/40 [&amp;_svg]:pointer-events-none [&amp;_svg]:shrink-0 [&amp;_svg:not([class*=&#039;size-&#039;])]:size-4&quot;,
    variants: {
        variant: {
            default: &#039;bg-primary text-primary-foreground [a]:hover:bg-primary/80&#039;,
            outline: &#039;border-border bg-background hover:bg-muted hover:text-foreground aria-expanded:bg-muted aria-expanded:text-foreground dark:border-input dark:bg-input/30 dark:hover:bg-input/50&#039;,
            secondary: &#039;bg-secondary text-secondary-foreground hover:bg-secondary/80 aria-expanded:bg-secondary aria-expanded:text-secondary-foreground&#039;,
            ghost: &#039;hover:bg-muted hover:text-foreground aria-expanded:bg-muted aria-expanded:text-foreground dark:hover:bg-muted/50&#039;,
            destructive: &#039;bg-destructive/10 text-destructive hover:bg-destructive/20 focus-visible:border-destructive/40 focus-visible:ring-destructive/20 dark:bg-destructive/20 dark:hover:bg-destructive/30 dark:focus-visible:ring-destructive/40&#039;,
            link: &#039;text-primary underline-offset-4 hover:underline&#039;,
        },
        size: {
            default: &#039;h-8 gap-1.5 px-2.5 ltr:has-data-[icon=inline-end]:pr-2 rtl:has-data-[icon=inline-end]:pe-2 ltr:has-data-[icon=inline-start]:pl-2 rtl:has-data-[icon=inline-start]:ps-2&#039;,
            xs: &quot;h-6 gap-1 rounded-[min(var(--radius-md),10px)] px-2 text-xs in-data-[slot=button-group]:rounded-lg ltr:has-data-[icon=inline-end]:pr-1.5 rtl:has-data-[icon=inline-end]:pe-1.5 ltr:has-data-[icon=inline-start]:pl-1.5 rtl:has-data-[icon=inline-start]:ps-1.5 [&amp;_svg:not([class*=&#039;size-&#039;])]:size-3&quot;,
            sm: &quot;h-7 gap-1 rounded-[min(var(--radius-md),12px)] px-2.5 text-[0.8rem] in-data-[slot=button-group]:rounded-lg ltr:has-data-[icon=inline-end]:pr-1.5 rtl:has-data-[icon=inline-end]:pe-1.5 ltr:has-data-[icon=inline-start]:pl-1.5 rtl:has-data-[icon=inline-start]:ps-1.5 [&amp;_svg:not([class*=&#039;size-&#039;])]:size-3.5&quot;,
            lg: &#039;h-9 gap-1.5 px-2.5 ltr:has-data-[icon=inline-end]:pr-2 rtl:has-data-[icon=inline-end]:pe-2 ltr:has-data-[icon=inline-start]:pl-2 rtl:has-data-[icon=inline-start]:ps-2&#039;,
            icon: &#039;size-8&#039;,
            &#039;icon-xs&#039;: &quot;size-6 rounded-[min(var(--radius-md),10px)] in-data-[slot=button-group]:rounded-lg [&amp;_svg:not([class*=&#039;size-&#039;])]:size-3&quot;,
            &#039;icon-sm&#039;: &#039;size-7 rounded-[min(var(--radius-md),12px)] in-data-[slot=button-group]:rounded-lg&#039;,
            &#039;icon-lg&#039;: &#039;size-9&#039;,
        },
    },
) -%}
&lt;{{ as }}
    data-slot=&quot;button&quot;
    data-variant=&quot;{{ variant }}&quot;
    data-size=&quot;{{ size }}&quot;
    class=&quot;{{ style.apply({variant: variant, size: size}, attributes.render(&#039;class&#039;))|tailwind_merge }}&quot;
    {{ attributes }}
&gt;
    {%- block content %}{% endblock -%}
&lt;/{{ as }}&gt;

Usage

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

Examples

Size

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

Loading... 
<div class="flex flex-col items-start gap-8 sm:flex-row">
    <div class="flex items-start gap-2">
        <twig:Button size="xs" variant="outline">Extra Small</twig:Button>
        <twig:Button size="icon-xs" variant="outline" aria-label="Submit">
            <twig:ux:icon name="lucide:arrow-up-right" />
        </twig:Button>
    </div>
    <div class="flex items-start 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" />
        </twig:Button>
    </div>
    <div class="flex items-start gap-2">
        <twig:Button variant="outline">Default</twig:Button>
        <twig:Button size="icon" variant="outline" aria-label="Submit">
            <twig:ux:icon name="lucide:arrow-up-right" />
        </twig:Button>
    </div>
    <div class="flex items-start 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" />
        </twig:Button>
    </div>
</div>

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

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

Loading... 
<twig:Button variant="outline" size="sm">
    <twig:ux:icon name="lucide:git-branch" /> New Branch
</twig:Button>

Rounded

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

Loading... 
<div class="flex flex-col gap-8">
    <twig:Button variant="outline" size="icon" class="rounded-full">
        <twig:ux:icon name="lucide:arrow-up" />
    </twig: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.

Loading... 
<div class="flex gap-2">
    <twig:Button variant="outline" disabled>
        <twig:Spinner data-icon="inline-start" />
        Generating
    </twig:Button>
    <twig:Button variant="secondary" disabled>
        Downloading
        <twig:Spinner data-icon="inline-start" />
    </twig:Button>
</div>

As Child

You can use the as prop on Button to make another element look like a button. Here's an example of a link that looks like a button.

Loading... 
<twig:Button as="a" href="/login">Login</twig:Button>

RTL

To enable RTL support, set the dir="rtl" attribute on the root element.

Loading... 
<div class="flex flex-col gap-8">
    <div class="flex flex-wrap items-center gap-2 md:flex-row" dir="rtl">
        <twig:Button variant="outline">زر</twig:Button>
        <twig:Button variant="destructive">حذف</twig:Button>
        <twig:Button variant="outline">
            إرسال
            <twig:ux:icon name="lucide:arrow-right" class="rtl:rotate-180" data-icon="inline-end" />
        </twig:Button>
        <twig:Button variant="outline" size="icon" aria-label="Add">
            <twig:ux:icon name="lucide:plus" />
        </twig:Button>
        <twig:Button variant="secondary" disabled>
            <twig:Spinner data-icon="inline-start" />
            جاري التحميل
        </twig:Button>
    </div>
    <div class="flex flex-wrap items-center gap-2 md:flex-row" dir="rtl">
        <twig:Button variant="outline">לחצן</twig:Button>
        <twig:Button variant="destructive">מחק</twig:Button>
        <twig:Button variant="outline">
            שלח
            <twig:ux:icon name="lucide:arrow-right" class="rtl:rotate-180" data-icon="inline-end" />
        </twig:Button>
        <twig:Button variant="outline" size="icon" aria-label="Add">
            <twig:ux:icon name="lucide:plus" />
        </twig:Button>
        <twig:Button variant="secondary" disabled>
            <twig:Spinner data-icon="inline-start" />
            טוען
        </twig:Button>
    </div>
</div>

API Reference

<twig:Button>

Prop Type Default
variant 
 'default'|'secondary'|'destructive'|'outline'|'ghost'|'link' 'default'
size 
 'default'|'xs'|'sm'|'lg'|'icon'|'icon-xs'|'icon-sm'|'icon-lg' 'default'
as 
 'button' 'button'
Block Description
content The button label and/or icon.