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>
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.
Colors
MDB includes several predefined button styles, each serving its own semantic purpose, with a few extras thrown in for more control.
<template>
<MDBBtn color="primary">Primary</MDBBtn>
<MDBBtn color="secondary">Secondary</MDBBtn>
<MDBBtn color="success">Success</MDBBtn>
<MDBBtn color="danger">Danger</MDBBtn>
<MDBBtn color="warning">Warning</MDBBtn>
<MDBBtn color="info">Info</MDBBtn>
<MDBBtn color="light">Light</MDBBtn>
<MDBBtn color="dark">Dark</MDBBtn>
<MDBBtn color="link">Link</MDBBtn>
</template>
<script>
import { MDBBtn } from "mdb-vue-ui-kit";
export default {
components: {
MDBBtn
}
};
</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.
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
<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>
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). |