Button

GitHub
A button element that can act as a link or trigger an action.

Usage

Use the default slot to set the label of the Button.

<template>
  <PButton>Button</PButton>
</template>

Label

Use the label prop to set the label of the Button.

<template>
  <PButton label="Button" />
</template>

Color

Use the color prop to change the color of the Button.

<template>
  <PButton color="neutral">Button</PButton>
</template>

Variant

Use the variant prop to change the variant of the Button.

<template>
  <PButton color="neutral" variant="outline">Button</PButton>
</template>

Size

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

<template>
  <PButton size="xl">Button</PButton>
</template>

Icon

Use the icon prop to show an Icon inside the Button.

<template>
  <PButton icon="i-lucide:rocket" size="md" color="primary" variant="solid">Button</PButton>
</template>

Use the leading and trailing props to set the icon position or the leading-icon and trailing-icon props to set a different icon for each position.

<template>
  <PButton trailing-icon="i-lucide:arrow-right" size="md">Button</PButton>
</template>

The label as prop or slot is optional so you can use the Button as an icon-only button.

<template>
  <PButton icon="i-lucide:search" size="md" color="primary" variant="solid" />
</template>

Avatar

Use the avatar prop to show an Avatar inside the Button.

<template>
  <PButton
    :avatar="{
      src: 'https://github.com/nuxt.png'
    }"
    size="md"
    color="neutral"
    variant="outline"
  >
    Button
  </PButton>
</template>

The label as prop or slot is optional so you can use the Button as an avatar-only button.

<template>
  <PButton
    :avatar="{
      src: 'https://github.com/nuxt.png'
    }"
    size="md"
    color="neutral"
    variant="outline"
  />
</template>

Link

You can pass any property from the Link component such as to, target, etc.

Button
<template>
  <PButton to="https://github.com/nuxt/ui" target="_blank">Button</PButton>
</template>

When the Button is a link or when using the active prop, you can use the active-color and active-variant props to customize the active state.

<template>
  <PButton active color="neutral" variant="outline" active-color="primary" active-variant="solid">
    Button
  </PButton>
</template>

You can also use the active-class and inactive-class props to customize the active state.

<template>
  <PButton active active-class="font-bold" inactive-class="font-light">Button</PButton>
</template>
You can configure these styles globally in your app.config.ts file under the pohon.button.variants.active key.
export default defineAppConfig({
  pohon: {
    button: {
      variants: {
        active: {
          true: {
            base: 'font-bold'
          }
        }
      }
    }
  }
})

Loading

Use the loading prop to show a loading icon and disable the Button.

<template>
  <PButton loading>Button</PButton>
</template>

Use the loading-auto prop to show the loading icon automatically while the @click promise is pending.

<script setup lang="ts">
async function onClick() {
  return new Promise<void>((res) => setTimeout(res, 1000));
}
</script>

<template>
  <PButton
    loading-auto
    @click="onClick"
  >
    Button
  </PButton>
</template>

This also works with the Form component.

<script setup lang="ts">
import { reactive } from 'vue';

const state = reactive({ fullName: '' });

async function onSubmit() {
  return new Promise<void>((res) => setTimeout(res, 1000));
}

async function validate(data: Partial<typeof state>) {
  if (!data.fullName?.length) {
    return [{ name: 'fullName', message: 'Required' }];
  }
  return [];
}
</script>

<template>
  <PForm
    :state="state"
    :validate="validate"
    @submit="onSubmit"
  >
    <PFormField
      name="fullName"
      label="Full name"
    >
      <PInput v-model="state.fullName" />
    </PFormField>
    <PButton
      type="submit"
      class="mt-2"
      loading-auto
    >
      Submit
    </PButton>
  </PForm>
</template>

Loading Icon

Use the loading-icon prop to customize the loading icon. Defaults to i-lucide:loader-circle.

<template>
  <PButton loading loading-icon="i-lucide:loader">Button</PButton>
</template>
You can customize this icon globally in your app.config.ts under pohon.icons.loading key.
You can customize this icon globally in your vite.config.ts under pohon.icons.loading key.

Disabled

Use the disabled prop to disable the Button.

<template>
  <PButton disabled>Button</PButton>
</template>

Examples

class prop

Use the class prop to override the base styles of the Button.

<template>
  <PButton class="akar:font-bold akar:rounded-full">Button</PButton>
</template>

pohon prop

Use the pohon prop to override the slots styles of the Button.

<template>
  <PButton
    icon="i-lucide:rocket"
    color="neutral"
    variant="outline"
    :pohon="{
      leadingIcon: 'color-primary'
    }"
  >
    Button
  </PButton>
</template>

API

Props

Prop Default Type
as'button'any

The element or component this component should render as when not a link.

tostring | kt | Tt

Route Location the link should navigate to when clicked on.

autofocusfalse | true | "true" | "false"
namestring
type'button'"submit" | "reset" | "button"

The type of the button when not a link.

downloadany
hreflangstring
mediastring
pingstring
targetstring & {} | "_blank" | "_parent" | "_self" | "_top"

Where to display the linked URL, as the name for a browsing context.

referrerpolicy"" | "no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"
trailingSlash"append" | "remove"

An option to either add or remove trailing slashes in the href for this specific link. Overrides the global trailingSlash option if provided.

labelstring
color'primary'"primary" | "secondary" | "success" | "info" | "warning" | "error" | "neutral"
activeColor"primary" | "secondary" | "success" | "info" | "warning" | "error" | "neutral"
variant'solid'"link" | "solid" | "outline" | "soft" | "subtle" | "ghost"
activeVariant"link" | "solid" | "outline" | "soft" | "subtle" | "ghost"
size'md'"md" | "xs" | "sm" | "lg" | "xl"
iconstring | object

Display an icon based on the leading and trailing props.

avatarPAvatarProps

Display an avatar on the left side.

leadingIconstring | object

Display an icon on the left side.

trailingIconstring | object

Display an icon on the right side.

loadingIconappConfig.pohon.icons.loadingstring | object

The icon when the loading prop is true.

disabledboolean
activeboolean

Force the link to be active independent of the current route.

squareboolean

Render the button with equal padding on all sides.

blockboolean

Render the button full width.

loadingAutoboolean

Set loading state automatically based on the @click promise state

leadingboolean

When true, the icon will be displayed on the left side.

trailingboolean

When true, the icon will be displayed on the right side.

loadingboolean

When true, the loading icon will be displayed.

pohon{ base?: ClassValue; label?: ClassValue; leadingIcon?: ClassValue; leadingAvatar?: ClassValue; leadingAvatarSize?: ClassValue; trailingIcon?: ClassValue; }
The Button component extends the Link component. Check out the source code on GitHub.

Slots

Slot Type
leading{ pohon: object; }
default{ pohon: object; }
trailing{ pohon: object; }
This component also supports all native <button> HTML attributes.

Theme

We use unocss-variants to customize the theme. Read more about it in the theming guide.

Below is the theme configuration skeleton for the PButton. Since the component is provided unstyled by default, you will need to fill in these values to apply your own custom look and feel. If you prefer to use our pre-built, opinionated styling, you can instead use our UnoCSS preset, this docs is using it as well.

app.config.ts
export default defineAppConfig({
  pohon: {
    button: {
      slots: {
        base: '',
        label: '',
        leadingIcon: '',
        leadingAvatar: '',
        leadingAvatarSize: '',
        trailingIcon: ''
      },
      variants: {
        fieldGroup: {
          horizontal: '',
          vertical: ''
        },
        color: {
          primary: '',
          secondary: '',
          success: '',
          info: '',
          warning: '',
          error: '',
          neutral: ''
        },
        variant: {
          solid: '',
          outline: '',
          soft: '',
          subtle: '',
          ghost: '',
          link: ''
        },
        size: {
          xs: {
            base: '',
            leadingIcon: '',
            leadingAvatarSize: '',
            trailingIcon: ''
          },
          sm: {
            base: '',
            leadingIcon: '',
            leadingAvatarSize: '',
            trailingIcon: ''
          },
          md: {
            base: '',
            leadingIcon: '',
            leadingAvatarSize: '',
            trailingIcon: ''
          },
          lg: {
            base: '',
            leadingIcon: '',
            leadingAvatarSize: '',
            trailingIcon: ''
          },
          xl: {
            base: '',
            leadingIcon: '',
            leadingAvatarSize: '',
            trailingIcon: ''
          }
        },
        block: {
          true: {
            base: '',
            trailingIcon: ''
          }
        },
        square: {
          true: ''
        },
        leading: {
          true: ''
        },
        trailing: {
          true: ''
        },
        loading: {
          true: ''
        },
        active: {
          true: {
            base: ''
          },
          false: {
            base: ''
          }
        }
      },
      compoundVariants: [],
      defaultVariants: {
        color: 'primary',
        variant: 'solid',
        size: 'md'
      }
    }
  }
};
vite.config.ts
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import pohon from 'pohon-ui/vite'

export default defineAppConfig({
  pohon: {
    button: {
      slots: {
        base: '',
        label: '',
        leadingIcon: '',
        leadingAvatar: '',
        leadingAvatarSize: '',
        trailingIcon: ''
      },
      variants: {
        fieldGroup: {
          horizontal: '',
          vertical: ''
        },
        color: {
          primary: '',
          secondary: '',
          success: '',
          info: '',
          warning: '',
          error: '',
          neutral: ''
        },
        variant: {
          solid: '',
          outline: '',
          soft: '',
          subtle: '',
          ghost: '',
          link: ''
        },
        size: {
          xs: {
            base: '',
            leadingIcon: '',
            leadingAvatarSize: '',
            trailingIcon: ''
          },
          sm: {
            base: '',
            leadingIcon: '',
            leadingAvatarSize: '',
            trailingIcon: ''
          },
          md: {
            base: '',
            leadingIcon: '',
            leadingAvatarSize: '',
            trailingIcon: ''
          },
          lg: {
            base: '',
            leadingIcon: '',
            leadingAvatarSize: '',
            trailingIcon: ''
          },
          xl: {
            base: '',
            leadingIcon: '',
            leadingAvatarSize: '',
            trailingIcon: ''
          }
        },
        block: {
          true: {
            base: '',
            trailingIcon: ''
          }
        },
        square: {
          true: ''
        },
        leading: {
          true: ''
        },
        trailing: {
          true: ''
        },
        loading: {
          true: ''
        },
        active: {
          true: {
            base: ''
          },
          false: {
            base: ''
          }
        }
      },
      compoundVariants: [],
      defaultVariants: {
        color: 'primary',
        variant: 'solid',
        size: 'md'
      }
    }
  }
};

Changelog

No recent changes

Banner

Display a banner at the top of your website to inform users about important information.

Calendar

Displays dates and days of the week, facilitating date-related interactions.