Support CoreUI Development

CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing.

You can support our Open Source software development in the following ways:

Buy the CoreUI PRO, and get access to PRO components, and dedicated support.
Became a sponsor, and get your logo on BACKERS.md/README.md files or each site of this documentation
Give us a star ⭐️ on Github.

Bootstrap buttons

Bootstrap button component for actions in tables, forms, cards, and more. CoreUI 4 for Bootstrap provides various styles, states, and size. Ready to use and easy to customize.

On this page

Examples

CoreUI includes a bunch of predefined Bootstrap buttons, each serving its own semantic purpose. CoreUI also offers some unique buttons styles.

Buttons show what action will happen when the user clicks or touches it. Bootstrap buttons are used to initialize operations, both in the background or foreground of an experience.

<button type="button" class="btn btn-primary">Primary</button>
<button type="button" class="btn btn-secondary">Secondary</button>
<button type="button" class="btn btn-success">Success</button>
<button type="button" class="btn btn-danger">Danger</button>
<button type="button" class="btn btn-warning">Warning</button>
<button type="button" class="btn btn-info">Info</button>
<button type="button" class="btn btn-light">Light</button>
<button type="button" class="btn btn-dark">Dark</button>

<button type="button" class="btn btn-link">Link</button>

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.

With icons

You can combine button with our CoreUI Icons.

<button type="button" class="btn btn-primary"><span class="cil-contrast btn-icon mr-2"></span> Primary</button>
<button type="button" class="btn btn-secondary"><span class="cil-contrast btn-icon mr-2"></span> Secondary</button>
<button type="button" class="btn btn-success"><span class="cil-contrast btn-icon mr-2"></span> Success</button>
<button type="button" class="btn btn-danger"><span class="cil-contrast btn-icon mr-2"></span> Danger</button>
<button type="button" class="btn btn-warning"><span class="cil-contrast btn-icon mr-2"></span> Warning</button>
<button type="button" class="btn btn-info"><span class="cil-contrast btn-icon mr-2"></span> Info</button>
<button type="button" class="btn btn-light"><span class="cil-contrast btn-icon mr-2"></span> Light</button>
<button type="button" class="btn btn-dark"><span class="cil-contrast btn-icon mr-2"></span> Dark</button>

<button type="button" class="btn btn-link">Link</button>

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.

Button tags

The .btn classes are designed for <button> , <a> or <input> elements (though some browsers may apply a slightly different rendering).

If you’re using .btn classes on <a> elements that are used to trigger functionality ex. collapsing content, these links should be given a role="button" to adequately communicate their meaning to assistive technologies such as screen readers.

Link

<a class="btn btn-primary" href="#" role="button">Link</a>
<button class="btn btn-primary" type="submit">Button</button>
<input class="btn btn-primary" type="button" value="Input">
<input class="btn btn-primary" type="submit" value="Submit">
<input class="btn btn-primary" type="reset" value="Reset">

Outline buttons

If you need a button, but without the strong background colors. Replace the default modifier classes with the .btn-outline-* ones to remove all background colors on any element with .btn class.

<button type="button" class="btn btn-outline-primary">Primary</button>
<button type="button" class="btn btn-outline-secondary">Secondary</button>
<button type="button" class="btn btn-outline-success">Success</button>
<button type="button" class="btn btn-outline-danger">Danger</button>
<button type="button" class="btn btn-outline-warning">Warning</button>
<button type="button" class="btn btn-outline-info">Info</button>
<button type="button" class="btn btn-outline-light">Light</button>
<button type="button" class="btn btn-outline-dark">Dark</button>

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.

Ghost buttons

Use .btn-ghost-* class for ghost buttons.

<button type="button" class="btn btn-ghost-primary">Primary</button>
<button type="button" class="btn btn-ghost-secondary">Secondary</button>
<button type="button" class="btn btn-ghost-success">Success</button>
<button type="button" class="btn btn-ghost-danger">Danger</button>
<button type="button" class="btn btn-ghost-warning">Warning</button>
<button type="button" class="btn btn-ghost-info">Info</button>
<button type="button" class="btn btn-ghost-light">Light</button>
<button type="button" class="btn btn-ghost-dark">Dark</button>

Sizes

Larger or smaller buttons? Add .btn-lg or .btn-sm for additional sizes.

<button type="button" class="btn btn-primary btn-lg">Large button</button>
<button type="button" class="btn btn-secondary btn-lg">Large button</button>

<button type="button" class="btn btn-primary btn-sm">Small button</button>
<button type="button" class="btn btn-secondary btn-sm">Small button</button>

Shapes

Pill buttons

<button type="button" class="btn btn-primary rounded-pill">Primary</button>
<button type="button" class="btn btn-secondary rounded-pill">Secondary</button>
<button type="button" class="btn btn-success rounded-pill">Success</button>
<button type="button" class="btn btn-danger rounded-pill">Danger</button>
<button type="button" class="btn btn-warning rounded-pill">Warning</button>
<button type="button" class="btn btn-info rounded-pill">Info</button>
<button type="button" class="btn btn-light rounded-pill">Light</button>
<button type="button" class="btn btn-dark rounded-pill">Dark</button>

Square buttons

<button type="button" class="btn btn-primary rounded-0">Primary</button>
<button type="button" class="btn btn-secondary rounded-0">Secondary</button>
<button type="button" class="btn btn-success rounded-0">Success</button>
<button type="button" class="btn btn-danger rounded-0">Danger</button>
<button type="button" class="btn btn-warning rounded-0">Warning</button>
<button type="button" class="btn btn-info rounded-0">Info</button>
<button type="button" class="btn btn-light rounded-0">Light</button>
<button type="button" class="btn btn-dark rounded-0">Dark</button>

Disabled state

Add the disabled boolean attribute to any <button> element to make buttons look inactive. Disabled button has pointer-events: none applied to, disabling hover and active states from triggering.

<button type="button" class="btn btn-lg btn-primary" disabled>Primary button</button>
<button type="button" class="btn btn-secondary btn-lg" disabled>Button</button>

Disabled buttons using the <a> element act a little different:

<a>s don’t support the disabled attribute, so you have to add .disabled class to make buttons look inactive. The disabled bootstrap button must have the aria-disabled="true" attribute to show the state of the element to assistive technologies.

Primary link Link

<a href="#" class="btn btn-primary btn-lg disabled" tabindex="-1" role="button" aria-disabled="true">Primary link</a>
<a href="#" class="btn btn-secondary btn-lg disabled" tabindex="-1" role="button" aria-disabled="true">Link</a>

Link functionality caveat

To cover cases where you have to keep the href attribute on a disabled link, the .disabled class uses pointer-events: none to try to disable the link functionality of <a>s. Note that this CSS property is not yet standardized for HTML, but all modern browsers support it. 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, in addition to aria-disabled="true", also include a tabindex="-1" attribute on these links to prevent them from receiving keyboard focus, and use custom JavaScript to disable their functionality altogether.

Primary link Link

<a href="#" class="btn btn-primary btn-lg disabled" tabindex="-1" role="button" aria-disabled="true">Primary link</a>
<a href="#" class="btn btn-secondary btn-lg disabled" tabindex="-1" role="button" aria-disabled="true">Link</a>

Block buttons

Create buttons that span the full width of a parent—by using utilities.

<div class="d-grid gap-2">
  <button class="btn btn-primary" type="button">Button</button>
  <button class="btn btn-primary" type="button">Button</button>
</div>

Here we create a responsive variation, starting with vertically stacked buttons until the md breakpoint, where .d-md-block replaces the .d-grid class, thus nullifying the gap-2 utility. Resize your browser to see them change.

<div class="d-grid gap-2 d-md-block">
  <button class="btn btn-primary" type="button">Button</button>
  <button class="btn btn-primary" type="button">Button</button>
</div>

You can adjust the width of your block buttons with grid column width classes. For example, for a half-width “block button”, use .col-6. Center it horizontally with .mx-auto, too.

<div class="d-grid gap-2 col-6 mx-auto">
  <button class="btn btn-primary" type="button">Button</button>
  <button class="btn btn-primary" type="button">Button</button>
</div>

Additional utilities can be used to adjust the alignment of buttons when horizontal. Here we’ve taken our previous responsive example and added some flex utilities and a margin utility on the button to right align the buttons when they’re no longer stacked.

<div class="d-grid gap-2 d-md-flex justify-content-md-end">
  <button class="btn btn-primary me-md-2" type="button">Button</button>
  <button class="btn btn-primary" type="button">Button</button>
</div>

Button plugin

The button plugin allows you to create simple on/off toggle buttons.

Visually, these toggle buttons are identical to the checkbox toggle buttons. However, they are conveyed differently by assistive technologies: the checkbox toggles will be announced by screen readers as “checked”/“not checked” (since, despite their appearance, they are fundamentally still checkboxes), whereas these toggle buttons will be announced as “button”/“button pressed”. The choice between these two approaches will depend on the type of toggle you are creating, and whether or not the toggle will make sense to users when announced as a checkbox or as an actual button.

Toggle states

Add data-coreui-toggle="button" to toggle a button’s active state. If you’re pre-toggling a button, you must manually add the .active class and aria-pressed="true" to the <button>.

<button type="button" class="btn btn-primary" data-coreui-toggle="button" autocomplete="off">Toggle button</button>
<button type="button" class="btn btn-primary active" data-coreui-toggle="button" autocomplete="off" aria-pressed="true">Active toggle button</button>
<button type="button" class="btn btn-primary" disabled data-coreui-toggle="button" autocomplete="off">Disabled toggle button</button>

Toggle link Active toggle link Disabled toggle link

<a href="#" class="btn btn-primary" role="button" data-coreui-toggle="button">Toggle link</a>
<a href="#" class="btn btn-primary active" role="button" data-coreui-toggle="button" aria-pressed="true">Active toggle link</a>
<a href="#" class="btn btn-primary disabled" tabindex="-1" aria-disabled="true" role="button" data-coreui-toggle="button">Disabled toggle link</a>

Methods

You can create a button instance with the button constructor, for example:

const bsButton = new coreui.Button('#myButton')

Method	Description
`toggle`	Toggles push state. Gives the button the appearance that it has been activated.
`dispose`	Destroys an element’s button. (Removes stored data on the DOM element)
`getInstance`	Static method which allows you to get the button instance associated to a DOM element, you can use it like this: `coreui.Button.getInstance(element)`
`getOrCreateInstance`	Static method which returns a button instance associated to a DOM element or create a new one in case it wasn’t initialized. You can use it like this: `coreui.Button.getOrCreateInstance(element)`

For example, to toggle all buttons

document.querySelectorAll('.btn').forEach(buttonElement => {
  const button = coreui.Button.getOrCreateInstance(buttonElement)
  button.toggle()
})

Customizing

CSS variables

Buttons 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.

  --cui-btn-padding-x: #{$btn-padding-x};
  --cui-btn-padding-y: #{$btn-padding-y};
  --cui-btn-font-family: #{$btn-font-family};
  @include rfs($btn-font-size, --cui-btn-font-size);
  --cui-btn-font-weight: #{$btn-font-weight};
  --cui-btn-line-height: #{$btn-line-height};
  --cui-btn-color: #{$body-color};
  --cui-btn-bg: transparent;
  --cui-btn-border-width: #{$btn-border-width};
  --cui-btn-border-color: transparent;
  --cui-btn-border-radius: #{$btn-border-radius};
  --cui-btn-box-shadow: #{$btn-box-shadow};
  --cui-btn-disabled-opacity: #{$btn-disabled-opacity};
  --cui-btn-focus-box-shadow: 0 0 0 #{$btn-focus-width} rgba(var(--cui-btn-focus-shadow-rgb), .5);

Each .btn-* modifier class updates the appropriate CSS variables to minimize additional CSS rules with our button-variant(), button-outline-variant(), and button-size() mixins.

SASS variables

$btn-padding-y:               $input-btn-padding-y;
$btn-padding-x:               $input-btn-padding-x;
$btn-font-family:             $input-btn-font-family;
$btn-font-size:               $input-btn-font-size;
$btn-line-height:             $input-btn-line-height;
$btn-white-space:             null; // Set to `nowrap` to prevent text wrapping

$btn-padding-y-sm:            $input-btn-padding-y-sm;
$btn-padding-x-sm:            $input-btn-padding-x-sm;
$btn-font-size-sm:            $input-btn-font-size-sm;

$btn-padding-y-lg:            $input-btn-padding-y-lg;
$btn-padding-x-lg:            $input-btn-padding-x-lg;
$btn-font-size-lg:            $input-btn-font-size-lg;

$btn-border-width:            $input-btn-border-width;

$btn-font-weight:             $font-weight-normal;
$btn-box-shadow:              inset 0 1px 0 rgba($white, .15), 0 1px 1px rgba($black, .075);
$btn-focus-width:             $input-btn-focus-width;
$btn-focus-box-shadow:        $input-btn-focus-box-shadow;
$btn-disabled-opacity:        .65;
$btn-active-box-shadow:       inset 0 3px 5px rgba($black, .125);

$btn-link-color:              var(--cui-link-color);
$btn-link-hover-color:        var(--cui-link-hover-color);
$btn-link-disabled-color:     $gray-600;

// Allows for customizing button radius independently from global border radius
$btn-border-radius:           $border-radius;
$btn-border-radius-sm:        $border-radius-sm;
$btn-border-radius-lg:        $border-radius-lg;

$btn-transition:              color .15s ease-in-out, background-color .15s ease-in-out, border-color .15s ease-in-out, box-shadow .15s ease-in-out;

$btn-hover-bg-shade-amount:       15%;
$btn-hover-bg-tint-amount:        15%;
$btn-hover-border-shade-amount:   20%;
$btn-hover-border-tint-amount:    10%;
$btn-active-bg-shade-amount:      20%;
$btn-active-bg-tint-amount:       20%;
$btn-active-border-shade-amount:  25%;
$btn-active-border-tint-amount:   10%;

// scss-docs-start button-variants
$button-variants: (
  "primary": btn-color-map($primary, $primary),
  "secondary": btn-color-map($secondary, $secondary),
  "success": btn-color-map($success, $success),
  "danger": btn-color-map($danger, $danger),
  "warning": btn-color-map($warning, $warning),
  "info": btn-color-map($info, $info),
  "light": btn-color-map($light, $light),
  "dark": btn-color-map($dark, $dark)
);

$button-outline-ghost-variants: (
  "primary": btn-outline-color-map($primary),
  "secondary": btn-outline-color-map($secondary),
  "success": btn-outline-color-map($success),
  "danger": btn-outline-color-map($danger),
  "warning": btn-outline-color-map($warning),
  "info": btn-outline-color-map($info),
  "light": btn-outline-color-map($light),
  "dark": btn-outline-color-map($dark)
);
// scss-docs-end button-variants

SASS variants

CoreUI allows defining variant colors in two ways.

Manual

You can define each color manually and keep full control of the component appearance.

$button-variants: (
  "primary": (
    "background": $your-bg-color,
    "border": $your-border-color,
    "color": $your-color,
    "hover-background": $your-bg-hover-color,
    "hover-border": $your-hover-border-color,
    "hover-color": $your-hover-color,
    "active-background": $your-bg-active-color,
    "active-border": $your-active-border-color,
    "active-color": $your-active-color,
    "disabled-background": $your-bg-disabled-color,,
    "disabled-border": $your-disabled-border-color,
    "disabled-color": $your-disabled-color,
    "shadow": $your-shadow
  )
  ...
);

Color function

The color set can be generated automatically thanks to our button-color-map function.

@function btn-color($color, $shade, $tint) {
  @return if(color-contrast($color) == $color-contrast-light, shade-color($color, $shade), tint-color($color, $tint));
}

@function btn-color-map($background, $border-color) {
  @return (
    "bg": $background,
    "border-color": $border-color,
    "color": color-contrast($background),
    "hover-bg": btn-color($background, $btn-hover-bg-shade-amount, $btn-hover-bg-tint-amount),
    "hover-border-color": btn-color($border-color, $btn-hover-border-shade-amount, $btn-hover-border-tint-amount),
    "hover-color": color-contrast(btn-color($background, $btn-hover-bg-shade-amount, $btn-hover-bg-tint-amount)),
    "active-bg": btn-color($background, $btn-active-bg-shade-amount, $btn-active-bg-tint-amount),
    "active-border-color": btn-color($border-color, $btn-active-border-shade-amount, $btn-active-border-tint-amount),
    "active-color": color-contrast(btn-color($border-color, $btn-active-border-shade-amount, $btn-active-border-tint-amount)),
    "disabled-bg": $background,
    "disabled-border-color": $border-color,
    "disabled-color": color-contrast($background),
    "shadow": rgba(mix($background, $border-color, 15%), .5)
  );
}

@function btn-outline-color-map($background) {
  @return (
    "color": $background,
    "hover-bg": btn-color($background, $btn-hover-bg-shade-amount, $btn-hover-bg-tint-amount),
    "hover-border-color": btn-color($background, $btn-hover-border-shade-amount, $btn-hover-border-tint-amount),
    "hover-color": color-contrast(btn-color($background, $btn-hover-bg-shade-amount, $btn-hover-bg-tint-amount)),
    "active-bg": btn-color($background, $btn-active-bg-shade-amount, $btn-active-bg-tint-amount),
    "active-border-color": btn-color($background, $btn-active-border-shade-amount, $btn-active-border-tint-amount),
    "active-color": color-contrast(btn-color($background, $btn-active-border-shade-amount, $btn-active-border-tint-amount)),
    "disabled-color": $background,
    "shadow": rgba(mix($background, $background, 15%), .5)
  );
}

$button-variants: (
  "primary": btn-color-map($primary),
  ...
);

–>

SASS mixins

CoreUI’s button component is built with a base-modifier class approach. This means the bulk of the styling is contained to a base class .btn while style variations are confined to modifier classes (e.g., .btn-danger). These modifier classes are built from the $button-variants map to make customizing the number and name of our modifier classes.

There are three mixins for buttons: button and button outline variant mixins, plus a button size mixin.

@mixin button-variant($variant) {
  $background: map-get($variant, "bg");
  $border-color: map-get($variant, "border-color");
  $color: map-get($variant, "color");
  $hover-background: map-get($variant, "hover-bg");
  $hover-border-color: map-get($variant, "hover-border-color");
  $hover-color: map-get($variant, "hover-color");
  $active-background: map-get($variant, "active-bg");
  $active-border-color: map-get($variant, "active-border-color");
  $active-color: map-get($variant, "active-color");
  $disabled-background: map-get($variant, "disabled-bg");
  $disabled-border-color: map-get($variant, "disabled-border-color");
  $disabled-color: map-get($variant, "disabled-color");
  $shadow: map-get($variant, "shadow");

  --cui-btn-color: #{$color};
  --cui-btn-bg: #{$background};
  --cui-btn-border-color: #{$border-color};
  --cui-btn-hover-color: #{$hover-color};
  --cui-btn-hover-bg: #{$hover-background};
  --cui-btn-hover-border-color: #{$hover-border-color};
  --cui-btn-focus-shadow-rgb: #{to-rgb(mix($color, $border-color, 15%))};
  --cui-btn-active-color: #{$active-color};
  --cui-btn-active-bg: #{$active-background};
  --cui-btn-active-border-color: #{$active-border-color};
  --cui-btn-active-shadow: #{$btn-active-box-shadow};
  --cui-btn-disabled-color: #{$disabled-color};
  --cui-btn-disabled-bg: #{$disabled-background};
  --cui-btn-disabled-border-color: #{$disabled-border-color};
}

@mixin button-outline-variant($variant) {
  $color: map-get($variant, "color");
  $hover-background: map-get($variant, "hover-bg");
  $hover-border-color: map-get($variant, "hover-border-color");
  $hover-color: map-get($variant, "hover-color");
  $active-background: map-get($variant, "active-bg");
  $active-border-color: map-get($variant, "active-border-color");
  $active-color: map-get($variant, "active-color");
  $disabled-color: map-get($variant, "disabled-color");
  $shadow: map-get($variant, "shadow");

  --cui-btn-color: #{$color};
  --cui-btn-border-color: #{$color};
  --cui-btn-hover-color: #{$hover-color};
  --cui-btn-hover-bg: #{$active-background};
  --cui-btn-hover-border-color: #{$active-border-color};
  --cui-btn-focus-shadow-rgb: #{to-rgb($color)};
  --cui-btn-active-color: #{$active-color};
  --cui-btn-active-bg: #{$active-background};
  --cui-btn-active-border-color: #{$active-border-color};
  --cui-btn-active-shadow: #{$btn-active-box-shadow};
  --cui-btn-disabled-color: #{$color};
  --cui-btn-disabled-bg: transparent;
  --cui-gradient: none;
}

@mixin button-ghost-variant($variant) {
  $color: map-get($variant, "color");
  $hover-background: map-get($variant, "hover-bg");
  $hover-border-color: map-get($variant, "hover-border-color");
  $hover-color: map-get($variant, "hover-color");
  $active-background: map-get($variant, "active-bg");
  $active-border-color: map-get($variant, "active-border-color");
  $active-color: map-get($variant, "active-color");
  $disabled-color: map-get($variant, "disabled-color");
  $shadow: map-get($variant, "shadow");

  --cui-btn-color: #{$color};
  --cui-btn-hover-bg: #{$hover-background};
  --cui-btn-hover-border-color: #{$hover-border-color};
  --cui-btn-hover-color: #{$hover-color};
  --cui-btn-active-bg: #{$active-background};
  --cui-btn-active-border-color: #{$active-border-color};
  --cui-btn-active-color: #{$active-color};
  --cui-btn-disabled-color: #{$disabled-color};
  --cui-btn-shadow: #{$shadow};
}

@mixin button-size($padding-y, $padding-x, $font-size, $border-radius) {
  --cui-btn-padding-y: #{$padding-y};
  --cui-btn-padding-x: #{$padding-x};
  @include rfs($font-size, --cui-btn-font-size);
  --cui-btn-border-radius: #{$border-radius};
}

SASS loops

Button variants (for regular and outline buttons) use their respective mixins with our $theme-colors map to generate the modifier classes in scss/_buttons.scss.

$button-variants: (
  "primary": btn-color-map($primary, $primary),
  "secondary": btn-color-map($secondary, $secondary),
  "success": btn-color-map($success, $success),
  "danger": btn-color-map($danger, $danger),
  "warning": btn-color-map($warning, $warning),
  "info": btn-color-map($info, $info),
  "light": btn-color-map($light, $light),
  "dark": btn-color-map($dark, $dark)
);

$button-outline-ghost-variants: (
  "primary": btn-outline-color-map($primary),
  "secondary": btn-outline-color-map($secondary),
  "success": btn-outline-color-map($success),
  "danger": btn-outline-color-map($danger),
  "warning": btn-outline-color-map($warning),
  "info": btn-outline-color-map($info),
  "light": btn-outline-color-map($light),
  "dark": btn-outline-color-map($dark)
);

@each $state, $variant in $button-variants {
  .btn-#{$state} {
    @include button-variant($variant);
  }
}

@each $state, $variant in $button-outline-ghost-variants {
  .btn-outline-#{$state} {
    @include button-outline-variant($variant);
  }
}

@each $state, $variant in $button-outline-ghost-variants {
  .btn-ghost-#{$state} {
    @include button-ghost-variant($variant);
  }
}