Button
<v-button>Click me!</v-button>
Sizes
The button component supports the following sizes through the use of props:
- x-small
- small
- (default)
- large
- x-large
Colors
You can set the color, background color, hover color, and background hover color with the --v-button-color, --v-button-background-color, --v-button-color-hover, and --v-button-background-color-hover css variables respectively:
<v-button>Click me</v-button>
<style>
.v-button {
--v-button-color: var(--red);
--v-button-background-color: var(--red-50);
--v-button-color-hover: var(--white);
--v-button-background-color-hover: var(--red);
}
</style>
Loading
The button has a loading state that can be enabled with the loading prop. By default, the button will render a v-spinner. You can override what's being shown during the loading state by using the #loading slot:
<v-button>
<template #loading>
... Almost done ...
</template>
</v-button>
The loading slot is rendered on top of the content that was there before. Make sure that your loading content doesn't exceed the size of the default state content. This restriction is put in place to prevent jumps when going from and to the loading state.
Props
| Prop | Description | Default |
|---|---|---|
block |
Enable ull width (display block) | false |
icon |
Remove padding / min-width. Meant to be used with just an icon as content | false |
outlined |
No background | false |
rounded |
Enable rounded corners | false |
type |
HTML type attribute |
button |
disabled |
Disabled state | false |
loading |
Loading state | false |
x-small |
Render extra small | false |
small |
Render small | false |
large |
Render large | false |
x-large |
Render extra large | false |
to |
Render as vue router-link | false |
Slots
| Slot | Description |
|---|---|
| default | Button content |
loading |
Content that's rendered during loading state |
Events
| Event | Description | Value |
|---|---|---|
click |
User clicks on button | MouseEvent |
CSS Variables
| Variable | Default |
|---|---|
--v-button-width |
auto |
--v-button-height |
44px |
--v-button-color |
var(--button-primary-foreground-color) |
--v-button-color-hover |
var(--button-primary-foreground-color-hover) |
--v-button-color-activated |
var(--button-primary-foreground-color-activated) |
--v-button-color-disabled |
var(--button-primary-foreground-color-disabled) |
--v-button-background-color |
var(--button-primary-background-color) |
--v-button-background-color-hover |
var(--button-primary-background-color-hover) |
--v-button-background-color-activated |
var(--button-primary-background-color-activated) |
--v-button-background-color-disabled |
var(--button-primary-background-color-disabled) |
--v-button-font-size |
16px |