Buttons
Vue Bootstrap 5 Buttons component
Use MDB custom button styles for actions in forms, dialogs, and more with support for multiple sizes, states, and more.
Note: Read the API tab to find all available options and advanced customization
Basic example
<template>
<MDBBtn color="primary">Primary</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
Disable text wrapping
If you don’t want the button text to wrap, you can add the
.text-nowrap> class to the button. In Sass, you can set
$btn-white-space: nowrap> to disable text wrapping for each button.
Hierarchy
Buttons, as one of the key UI elements, must have their own hierarchy. This means that the user should be able to easily identify which button is the most important (primary button), which is less important (secondary button) and which presents completely additional information (tertiary button).
Elements with strong, filled backgrounds and shadows attract attention the most, which is why button primary is built in this way.
A delicate background without shadows is less engaging, so it is well suited for button secondary.
The lack of background and shadow makes the element the least visible. These features characterize the button tertiary.
Note: Button tertiary may require additional margins. Without extra margins, the button edge will be flush with adjacent elements (which is sometimes the desired result). If you need margin - simply add margin utility classes like mx-2.
<template>
<MDBBtn color="primary">Primary</MDBBtn>
<MDBBtn color="secondary">Secondary</MDBBtn>
<MDBBtn color="tetriary">Tertiary</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
Hierarchy
MDB includes several predefined button styles, each serving its own semantic purpose.
<template>
<MDBBtn color="success">Success</MDBBtn>
<MDBBtn color="danger">Danger</MDBBtn>
<MDBBtn color="warning">Warning</MDBBtn>
<MDBBtn color="info">Info</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
Conveying meaning to assistive technologies:
Using color to add meaning only provides a visual indication, which will not be conveyed to
users of assistive technologies – such as screen readers. Ensure that information denoted by
the color is either obvious from the content itself (e.g. the visible text), or is included
through alternative means, such as additional text hidden with the
.visually-hidden class.
Neutral
Neutral buttons provide additional light and dark colors.
<template>
<MDBBtn color="light">Light</MDBBtn>
<MDBBtn color="dark">Dark</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
Link
Link button is similar to the tertiary button (and often is used as a substitute). The difference is, that the link button has a background on hover and also has a default padding.
<template>
<MDBBtn color="link">Link</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
Outline
In need of a button, but not the hefty background colors they bring? Add
outline property to remove all background images and colors on any button.
<template>
<MDBBtn outline="primary">Primary</MDBBtn>
<MDBBtn outline="secondary">Secondary</MDBBtn>
<MDBBtn outline="success">Success</MDBBtn>
<MDBBtn outline="danger">Danger</MDBBtn>
<MDBBtn outline="warning">Warning</MDBBtn>
<MDBBtn outline="info">Info</MDBBtn>
<MDBBtn outline="light">Light</MDBBtn>
<MDBBtn outline="dark">Dark</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
Some of the button styles use a relatively light foreground color, and should only be used on a dark background in order to have sufficient contrast.
Rounded
Add rounded property to make the button rounded.
<template>
<MDBBtn color="primary" rounded>Primary</MDBBtn>
<MDBBtn color="secondary" rounded>Secondary</MDBBtn>
<MDBBtn color="success" rounded>Success</MDBBtn>
<MDBBtn color="danger" rounded>Danger</MDBBtn>
<MDBBtn color="warning" rounded>Warning</MDBBtn>
<MDBBtn color="info" rounded>Info</MDBBtn>
<MDBBtn color="light" rounded>Light</MDBBtn>
<MDBBtn color="dark" rounded>Dark</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
Rounded outline
You can use outline and rounded properties together to make the
button outline and rounded at the same time.
<template>
<MDBBtn outline="primary" rounded>Primary</MDBBtn>
<MDBBtn outline="secondary" rounded>Secondary</MDBBtn>
<MDBBtn outline="success" rounded>Success</MDBBtn>
<MDBBtn outline="danger" rounded>Danger</MDBBtn>
<MDBBtn outline="warning" rounded>Warning</MDBBtn>
<MDBBtn outline="info" rounded>Info</MDBBtn>
<MDBBtn outline="light" rounded>Light</MDBBtn>
<MDBBtn outline="dark" rounded>Dark</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
Floating
Use floating property to make a circle button.
To make it works properly you have to put an icon inside. The text will not fit in. You can find hundreds of available icons in our icons docs.
<template>
<MDBBtn color="primary" floating>
<MDBIcon icon="download"></MDBIcon>
</MDBBtn>
</template>
<script>
import { MDBBtn, MDBIcon } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn,
MDBIcon
}
};
</script>
<script script lang="ts">
import { MDBBtn, MDBIcon } from "mdb-vue-ui-kit";
</script>
You can apply almost all the same classes and attributes to the floating buttons as to the regular buttons - colors, ripples, sizes, outline, etc.
<template>
<MDBBtn color="primary" floating size="lg">
<MDBIcon iconStyle="fab" icon="facebook-f"></MDBIcon>
</MDBBtn>
<MDBBtn outline="success" floating>
<MDBIcon icon="star"></MDBIcon>
</MDBBtn>
<MDBBtn color="danger" floating>
<MDBIcon icon="magic"></MDBIcon>
</MDBBtn>
<MDBBtn color="dark" floating>
<MDBIcon iconStyle="fab" icon="apple"></MDBIcon>
</MDBBtn>
</template>
<script>
import { MDBBtn, MDBIcon } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn,
MDBIcon
}
};
</script>
<script setup lang="ts">
import { MDBBtn, MDBIcon } from "mdb-vue-ui-kit";
</script>
Sizes
Fancy larger or smaller buttons? Add size="lg" or size="sm" for
additional sizes.
<template>
<MDBBtn color="primary" size="sm">Button</MDBBtn>
<MDBBtn color="primary">Button</MDBBtn>
<MDBBtn color="primary" size="lg">Button</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
Active state
Add .active class to make the button look pressed.
<template>
<MDBBtn tag="a" color="primary" size="lg" class="active" aria-pressed="true">Primary link</MDBBtn>
<MDBBtn tag="a" color="secondary" size="lg" class="active" aria-pressed="true">Link</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
Disabled state
Make buttons look inactive by adding the disabled boolean attribute to any
MDBBtn element. Disabled buttons have pointer-events: none applied
to, preventing hover and active states from triggering.
<template>
<MDBBtn color="primary" size="lg" disabled>Primary button</MDBBtn>
<MDBBtn color="secondary" size="lg" disabled>Button</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
Disabled MDBBtn using the a tag behave a bit different:
-
<a>s don’t support thedisabledattribute, so you must add the.disabledclass to make it visually appear disabled. -
Some future-friendly styles are included to disable all
pointer-eventson anchor buttons. In browsers which support that property, you won’t see the disabled cursor at all. -
Disabled buttons should include the
aria-disabled="true"attribute to indicate the state of the element to assistive technologies.
<template>
<MDBBtn tag="a" color="primary" size="lg" class="disabled" tabindex="-1" aria-disabled="true">Primary link</MDBBtn>
<MDBBtn tag="a" color="secondary" size="lg" class="disabled" tabindex="-1" aria-disabled="true">Link</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
</script>
Link functionality caveat:
The .disabled class uses pointer-events: none to try to disable the
link functionality of <a>s, but that CSS property is not yet standardized.
In addition, even in browsers that do support pointer-events: none, keyboard
navigation remains unaffected, meaning that sighted keyboard users and users of assistive
technologies will still be able to activate these links. So to be safe, add a
tabindex="-1" attribute on these links (to prevent them from receiving keyboard
focus) and use custom JavaScript to disable their functionality.
Toggle states
Add toggler<> and v-model:toggle<> props to toggle a button’s
active<> state.
<template>
<MDBBtn v-model:toggle="toggleBtn1" toggler color="primary" autocomplete="off">Toggle button</MDBBtn>
<MDBBtn v-model:toggle="toggleBtn2" toggler color="primary" autocomplete="off" aria-pressed="true">Active toggle button</MDBBtn>
<MDBBtn v-model:toggle="toggleBtn3" toggler color="primary" autocomplete="off" disabled>Disabled toggle button</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
import { ref } from "vue";
export default {
components: {
MDBBtn
},
setup() {
const toggleBtn1 = ref(false);
const toggleBtn2 = ref(true);
const toggleBtn3 = ref(false);
return {
toggleBtn1,
toggleBtn2,
toggleBtn3
};
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
import { ref } from "vue";
const toggleBtn1 = ref(false);
const toggleBtn2 = ref(true);
const toggleBtn3 = ref(false);
</script>
<template>
<MDBBtn v-model:toggle="toggleLink1" toggler tag="a" color="primary" autocomplete="off">Toggle link</MDBBtn>
<MDBBtn v-model:toggle="toggleLink2" toggler tag="a" color="primary" autocomplete="off" aria-pressed="true">Active toggle link</MDBBtn>
<MDBBtn v-model:toggle="toggleLink3" toggler tag="a" color="primary" autocomplete="off" class="disabled">Disabled toggle link</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
import { ref } from "vue";
export default {
components: {
MDBBtn
},
setup() {
const toggleLink1 = ref(false);
const toggleLink2 = ref(true);
const toggleLink3 = ref(false);
return {
toggleLink1,
toggleLink2,
toggleLink3
};
}
};
</script>
<script setup lang="ts">
import { MDBBtn } from "mdb-vue-ui-kit";
import { ref } from "vue";
const toggleLink1 = ref(false);
const toggleLink2 = ref(true);
const toggleLink3 = ref(false);
</script>
Buttons - API
Import
<script>
import {
MDBBtn
} from 'mdb-vue-ui-kit';
</script>
Properties
| Property | Type | Default | Description |
|---|---|---|---|
color |
String | "" |
Changes button color |
size |
String | "" |
Changes button size |
outline |
String | "" |
Changes button style and color to outline |
rounded |
Boolean | false |
Changes button style to rounded |
floating |
Boolean | false |
Changes button style to floating |
toggler |
Boolean | false |
Enables toggling |
toggle |
Boolean | false |
Defines toggle state |
role |
String | "button" |
Defines button's role |
ripple |
[Object, Boolean] | true |
Defines
ripple
configuration or disables it if false.
|
type |
String | "button" |
Defines button's type |
tag |
String | "button" |
Defines button's tag |
Events
| Event type | Description |
|---|---|
toggle |
Fires immediately when the toggler button is clicked. Returns toggle state (true/false). |
<template>
<MDBBtn color="primary" @toggle="doSomething">Button</MDBBtn>
</template>
CSS variables
As part of MDB’s evolving CSS variables approach, buttons now use local CSS variables on
.btn for enhanced real-time customization. Values for the CSS variables are set
via Sass, so Sass customization is still supported, too.
Button's CSS variables are in different classes which belong to this component. To make it easier to use them, you can find below all of the used CSS variables.
// .btn
--#{$prefix}btn-padding-x: #{$btn-padding-x};
--#{$prefix}btn-padding-top: #{$btn-padding-top};
--#{$prefix}btn-padding-bottom: #{$btn-padding-bottom};
--#{$prefix}btn-font-family: #{$btn-font-family};
@include rfs($btn-font-size, --#{$prefix}btn-font-size);
--#{$prefix}btn-font-weight: #{$btn-font-weight};
--#{$prefix}btn-line-height: #{$btn-line-height};
--#{$prefix}btn-color: #{$body-color};
--#{$prefix}btn-bg: transparent;
--#{$prefix}btn-border-width: 0;
--#{$prefix}btn-border-color: none;
--#{$prefix}btn-border-radius: #{$btn-border-radius};
--#{$prefix}btn-hover-border-color: transparent;
--#{$prefix}btn-box-shadow: #{$btn-box-shadow};
--#{$prefix}btn-hover-box-shadow: #{$btn-hover-box-shadow};
--#{$prefix}btn-focus-box-shadow: #{$btn-focus-box-shadow};
--#{$prefix}btn-active-box-shadow: #{$btn-active-box-shadow};
--#{$prefix}btn-disabled-opacity: #{$btn-disabled-opacity};
// [class*='btn-outline-']
--#{$prefix}btn-padding-top: #{$btn-outline-padding-top};
--#{$prefix}btn-padding-bottom: #{$btn-outline-padding-bottom};
--#{$prefix}btn-padding-x: #{$btn-outline-padding-x};
--#{$prefix}btn-border-width: #{$btn-outline-border-width};
--#{$prefix}btn-line-height: #{$btn-line-height};
// .btn-link
--#{$prefix}btn-font-weight: #{$font-weight-medium};
--#{$prefix}btn-color: #{$btn-link-color};
--#{$prefix}btn-bg: transparent;
--#{$prefix}btn-border-color: transparent;
--#{$prefix}btn-hover-color: #{$btn-link-hover-color};
--#{$prefix}btn-hover-bg: #{$btn-link-hover-bg};
--#{$prefix}btn-hover-border-color: transparent;
--#{$prefix}btn-focus-color: #{$btn-link-focus-color};
--#{$prefix}btn-active-color: #{$btn-link-active-color};
--#{$prefix}btn-active-border-color: transparent;
--#{$prefix}btn-disabled-color: #{$btn-link-disabled-color};
--#{$prefix}btn-disabled-border-color: transparent;
--#{$prefix}btn-box-shadow: none;
--#{$prefix}btn-focus-shadow-rgb: #{to-rgb(mix(color-contrast($primary), $primary, 15%))};
// .btn-tertiary
--#{$prefix}btn-font-weight: #{$font-weight-medium};
--#{$prefix}btn-color: #{$btn-link-color};
--#{$prefix}btn-hover-color: #{$btn-link-hover-color};
--#{$prefix}btn-hover-bg: transparent;
--#{$prefix}btn-focus-color: #{$btn-link-focus-color};
--#{$prefix}btn-active-color: #{$btn-link-active-color};
--#{$prefix}btn-disabled-color: #{$btn-link-disabled-color};
--#{$prefix}btn-box-shadow: none;
// .btn-rounded
--#{$prefix}btn-border-radius: #{$btn-rounded-border-radius};
// .btn-floating,
// [class*='btn-outline-'].btn-floating
--#{$prefix}btn-border-radius: #{$btn-floating-border-radius};
// .btn-floating
--#{$prefix}btn-width: #{$btn-floating-width};
--#{$prefix}btn-height: #{$btn-floating-height};
--#{$prefix}btn-icon-width: #{$btn-floating-icon-width};
--#{$prefix}btn-icon-line-height: #{$btn-floating-icon-line-height};
--#{$prefix}btn-width-lg: #{$btn-floating-width-lg};
--#{$prefix}btn-height-lg: #{$btn-floating-height-lg};
--#{$prefix}btn-icon-width-lg: #{$btn-floating-icon-width-lg};
--#{$prefix}btn-icon-line-height-lg: #{$btn-floating-icon-line-height-lg};
--#{$prefix}btn-width-sm: #{$btn-floating-width-sm};
--#{$prefix}btn-height-sm: #{$btn-floating-height-sm};
--#{$prefix}btn-icon-width-sm: #{$btn-floating-icon-width-sm};
--#{$prefix}btn-icon-line-height-sm: #{$btn-floating-icon-line-height-sm};
// [class*='btn-outline-'].btn-floating
--#{$prefix}btn-icon-width: #{$btn-outline-floating-icon-width};
--#{$prefix}btn-icon-width-lg: #{$btn-outline-floating-icon-width-lg};
--#{$prefix}btn-icon-width-sm: #{$btn-outline-floating-icon-width-sm};
--#{$prefix}btn-icon-line-height: #{$btn-outline-floating-icon-line-height};
--#{$prefix}btn-icon-line-height-lg: #{$btn-outline-floating-icon-line-height-lg};
--#{$prefix}btn-icon-line-height-sm: #{$btn-outline-floating-icon-line-height-sm};
// .fixed-action-btn
--#{$prefix}btn-right: #{$fixed-action-btn-right};
--#{$prefix}btn-bottom: #{$fixed-action-btn-bottom};
--#{$prefix}btn-zindex: #{$fixed-action-button-zindex};
--#{$prefix}btn-padding-top: #{$fixed-action-btn-padding-top};
--#{$prefix}btn-padding-bottom: #{$fixed-action-btn-padding-bottom};
--#{$prefix}btn-padding-x: #{$fixed-action-btn-padding-x};
--#{$prefix}btn-margin-bottom: #{$fixed-action-btn-li-margin-bottom};
// .btn-block
--#{$prefix}btn-margin-top: #{$btn-block-margin-top};
SCSS variables
$btn-padding-top: 0.625rem;
$btn-padding-bottom: 0.5rem;
$btn-padding-x: 1.5rem;
$btn-font-size: 0.75rem;
$btn-line-height: 1.5;
$btn-font-size: $input-btn-font-size;
$btn-white-space: null;
$btn-padding-top-lg: 0.75rem;
$btn-padding-bottom-lg: 0.6875rem;
$btn-padding-x-lg: 1.6875rem;
$btn-font-size-lg: 0.875rem;
$btn-line-height-lg: 1.6;
$btn-padding-top-sm: 0.375rem;
$btn-padding-bottom-sm: 0.3125rem;
$btn-padding-x-sm: 1rem;
$btn-font-size-sm: 0.75rem;
$btn-line-height-sm: 1.5;
$btn-border-width: $border-width-alternate;
$btn-font-weight: $font-weight-medium;
$btn-box-shadow: 0 4px 9px -4px rgba($black, 0.35);
$btn-hover-box-shadow: 0 8px 9px -4px rgba($black, 0.15), 0 4px 18px 0 rgba($black, 0.1);
$btn-focus-box-shadow: $btn-hover-box-shadow;
$btn-active-box-shadow: $btn-focus-box-shadow;
$btn-focus-width: $input-btn-focus-width;
$btn-disabled-opacity: 0.65;
$btn-link-color: $link-color;
$btn-link-hover-color: $link-hover-color;
$btn-link-focus-color: $link-focus-color;
$btn-link-active-color: $link-active-color;
$btn-link-disabled-color: $gray-500;
$btn-link-hover-bg: hsl(0, 0%, 96%);
$btn-border-radius: $border-radius;
$btn-transition: color 0.15s ease-in-out, background-color 0.15s ease-in-out,
border-color 0.15s ease-in-out, box-shadow 0.15s ease-in-out;
$btn-hover-bg-shade-amount: 5%;
$btn-focus-bg-shade-amount: 5%;
$btn-active-bg-shade-amount: 10%;
$btn-contextual-box-shadow: 0 4px 9px -4px;
$btn-contextual-box-shadow-state-first-part: 0 8px 9px -4px;
$btn-contextual-box-shadow-state-second-part: 0 4px 18px 0;
$btn-outline-padding-top: 0.5rem;
$btn-outline-padding-bottom: 0.375rem;
$btn-outline-padding-x: 1.375rem;
$btn-outline-border-width: $border-width-alternate;
$btn-outline-line-height: 1.5;
$btn-outline-padding-top-lg: 0.625rem;
$btn-outline-padding-bottom-lg: 0.5625rem;
$btn-outline-padding-x-lg: 1.5625rem;
$btn-outline-font-size-lg: 0.875rem;
$btn-outline-line-height-lg: 1.6;
$btn-outline-padding-top-sm: 0.25rem;
$btn-outline-padding-bottom-sm: 0.1875rem;
$btn-outline-padding-x-sm: 0.875rem;
$btn-outline-font-size-sm: 0.75rem;
$btn-outline-line-height-sm: 1.5;
$btn-rounded-border-radius: 10rem;
$btn-floating-border-radius: 50%;
$btn-floating-width: 2.3125rem;
$btn-floating-height: 2.3125rem;
$btn-floating-icon-width: 2.3125rem;
$btn-floating-width-lg: 2.8125rem;
$btn-floating-height-lg: 2.8125rem;
$btn-floating-icon-width-lg: 2.8125rem;
$btn-floating-width-sm: 1.8125rem;
$btn-floating-height-sm: 1.8125rem;
$btn-floating-icon-width-sm: 1.8125rem;
$btn-outline-floating-icon-width: 2.0625rem;
$btn-outline-floating-icon-width-lg: 2.5625rem;
$btn-outline-floating-icon-width-sm: 1.5625rem;
$btn-floating-icon-line-height: 2.3125rem;
$btn-floating-icon-line-height-lg: 2.8125rem;
$btn-floating-icon-line-height-sm: 1.8125rem;
$btn-outline-floating-icon-line-height: 2.0625rem;
$btn-outline-floating-icon-line-height-lg: 2.5625rem;
$btn-outline-floating-icon-line-height-sm: 1.5625rem;
$fixed-action-btn-right: 2.1875rem;
$fixed-action-btn-bottom: 2.1875rem;
$fixed-action-btn-padding-top: 0.9375rem;
$fixed-action-btn-padding-bottom: 1.25rem;
$fixed-action-btn-padding-x: 1.25rem;
$fixed-action-btn-li-margin-bottom: 1.5rem;
$btn-block-margin-top: 0.5rem;