core-logo

Dropdowns

Bootstrap dropdown component allows you to toggle contextual overlays for displaying lists, links, and more html elements.

On this page:



Overview

Dropdowns are toggleable, contextual overlays for displaying lists of links and more. They’re made interactive with the included Bootstrap dropdown JavaScript plugin. They’re toggled by clicking, not by hovering.

Dropdowns are built on a third party library, Popper.js, which provides dynamic positioning and viewport detection. Be sure to include popper.min.js before CoreUI’s JavaScript or use coreui.bundle.min.js / coreui.bundle.js which contains Popper.js. Popper.js isn’t used to position dropdowns in navbars though as dynamic positioning isn’t required.

If you’re building our JavaScript from source, it requires util.js.

//TODO: sprawdzić dudplikaty treści

Accessibility

The WAI ARIA standard defines an actual role="menu" widget, but this is specific to application-like menus which trigger actions or functions. ARIA menus can only contain menu items, checkbox menu items, radio button menu items, radio button groups, and sub-menus.

Bootstrap’s dropdowns, on the other hand, are designed to be generic and applicable to a variety of situations and markup structures. For instance, it is possible to create dropdowns that contain additional inputs and form controls, such as search fields or login forms. For this reason, Bootstrap does not expect (nor automatically add) any of the role and aria- attributes required for true ARIA menus. Authors will have to include these more specific attributes themselves.

However, Bootstrap does add built-in support for most standard keyboard menu interactions, such as the ability to move through individual .c-dropdown-item elements using the cursor keys and close the menu with the ESC key.

Examples

Bind the dropdown’s toggle and the dropdown menu inside .c-dropdown, or different element that declares position: relative;. Dropdowns can be triggered from <a> or <button> elements to better fit your possible requirements.

Single button

Each single .c-btn can be changed into a dropdown toggle with small changes. Here’s how you can put them to work with either <button> elements:

<div class="c-dropdown">
  <button class="c-btn c-btn-secondary c-dropdown-toggle" type="button" id="dropdownMenuButton" data-toggle="c-dropdown" aria-expanded="false">
    Dropdown button
  </button>
  <div class="c-dropdown-menu" aria-labelledby="dropdownMenuButton">
    <a class="c-dropdown-item" href="#">Item</a>
    <a class="c-dropdown-item" href="#">Another Item</a>
    <a class="c-dropdown-item" href="#">One more item</a>
  </div>
</div>

And with <a> elements:

<div class="c-dropdown">
  <a class="c-btn c-btn-secondary c-dropdown-toggle" href="#" role="button" id="dropdownMenuLink" data-toggle="c-dropdown" aria-expanded="false">
    Dropdown link
  </a>

  <div class="c-dropdown-menu" aria-labelledby="dropdownMenuLink">
    <a class="c-dropdown-item" href="#">Item</a>
    <a class="c-dropdown-item" href="#">Another Item</a>
    <a class="c-dropdown-item" href="#">One more item</a>
  </div>
</div>

The best part is you can do this with any button variant, too:

<!-- Example single danger button -->
<div class="c-btn-group">
  <button type="button" class="c-btn c-btn-danger c-dropdown-toggle" data-toggle="c-dropdown" aria-expanded="false">
    Action
  </button>
  <div class="c-dropdown-menu">
    <a class="c-dropdown-item" href="#">Item</a>
    <a class="c-dropdown-item" href="#">Another Item</a>
    <a class="c-dropdown-item" href="#">One more item</a>
    <div class="c-dropdown-divider"></div>
    <a class="c-dropdown-item" href="#">Separated link</a>
  </div>
</div>

Split button

Similarly, create split button dropdowns with virtually the same markup as single button dropdowns, but with the addition of .c-dropdown-toggle-split for proper spacing around the dropdown caret.

We use this extra class to reduce the horizontal padding on either side of the caret by 25% and remove the margin-left that’s attached for normal button dropdowns. Those additional changes hold the caret centered in the split button and implement a more properly sized hit area next to the main button.

<!-- Example split danger button -->
<div class="c-btn-group">
  <button type="button" class="c-btn c-btn-danger">Action</button>
  <button type="button" class="c-btn c-btn-danger c-dropdown-toggle c-dropdown-toggle-split" data-toggle="c-dropdown" aria-expanded="false">
    <span class="sr-only">Toggle Dropdown</span>
  </button>
  <div class="c-dropdown-menu">
    <a class="c-dropdown-item" href="#">Item</a>
    <a class="c-dropdown-item" href="#">Another Item</a>
    <a class="c-dropdown-item" href="#">One more item</a>
    <div class="c-dropdown-divider"></div>
    <a class="c-dropdown-item" href="#">Separated link</a>
  </div>
</div>

Sizing

Button dropdowns work with buttons of all sizes, including default and split dropdown buttons.

<!-- Large button groups (default and split) -->
<div class="c-btn-group">
  <button class="c-btn c-btn-secondary c-btn-lg c-dropdown-toggle" type="button" data-toggle="c-dropdown" aria-expanded="false">
    Large button
  </button>
  <div class="c-dropdown-menu">
    ...
  </div>
</div>
<div class="c-btn-group">
  <button class="c-btn c-btn-secondary c-btn-lg" type="button">
    Large split button
  </button>
  <button type="button" class="c-btn c-btn-lg c-btn-secondary c-dropdown-toggle c-dropdown-toggle-split" data-toggle="c-dropdown" aria-expanded="false">
    <span class="sr-only">Toggle Dropdown</span>
  </button>
  <div class="c-dropdown-menu">
    ...
  </div>
</div>

<!-- Small button groups (default and split) -->
<div class="c-btn-group">
  <button class="c-btn c-btn-secondary c-btn-sm c-dropdown-toggle" type="button" data-toggle="c-dropdown" aria-expanded="false">
    Small button
  </button>
  <div class="c-dropdown-menu">
    ...
  </div>
</div>
<div class="c-btn-group">
  <button class="c-btn c-btn-secondary c-btn-sm" type="button">
    Small split button
  </button>
  <button type="button" class="c-btn c-btn-sm c-btn-secondary c-dropdown-toggle c-dropdown-toggle-split" data-toggle="c-dropdown" aria-expanded="false">
    <span class="sr-only">Toggle Dropdown</span>
  </button>
  <div class="c-dropdown-menu">
    ...
  </div>
</div>

Directions

Dropup

Trigger dropdown menus above elements by adding .c-dropup to the parent element.

<!-- Default dropup button -->
<div class="c-btn-group c-dropup">
  <button type="button" class="c-btn c-btn-secondary c-dropdown-toggle" data-toggle="c-dropdown" aria-expanded="false">
    Dropup
  </button>
  <div class="c-dropdown-menu">
    <!-- Dropdown menu links -->
  </div>
</div>

<!-- Split dropup button -->
<div class="c-btn-group c-dropup">
  <button type="button" class="c-btn c-btn-secondary">
    Split dropup
  </button>
  <button type="button" class="c-btn c-btn-secondary c-dropdown-toggle c-dropdown-toggle-split" data-toggle="c-dropdown" aria-expanded="false">
    <span class="sr-only">Toggle Dropdown</span>
  </button>
  <div class="c-dropdown-menu">
    <!-- Dropdown menu links -->
  </div>
</div>

Dropright

Trigger dropdown menus at the right of the elements by adding .c-dropright to the parent element.

<!-- Default dropright button -->
<div class="c-btn-group c-dropright">
  <button type="button" class="c-btn c-btn-secondary c-dropdown-toggle" data-toggle="c-dropdown" aria-expanded="false">
    Dropright
  </button>
  <div class="c-dropdown-menu">
    <!-- Dropdown menu links -->
  </div>
</div>

<!-- Split dropright button -->
<div class="c-btn-group c-dropright">
  <button type="button" class="c-btn c-btn-secondary">
    Split dropright
  </button>
  <button type="button" class="c-btn c-btn-secondary c-dropdown-toggle c-dropdown-toggle-split" data-toggle="c-dropdown" aria-expanded="false">
    <span class="sr-only">Toggle Dropright</span>
  </button>
  <div class="c-dropdown-menu">
    <!-- Dropdown menu links -->
  </div>
</div>

Dropleft

Trigger dropdown menus at the left of the elements by adding .c-dropleft to the parent element.

<!-- Default dropleft button -->
<div class="c-btn-group c-dropleft">
  <button type="button" class="c-btn c-btn-secondary c-dropdown-toggle" data-toggle="c-dropdown" aria-expanded="false">
    Dropleft
  </button>
  <div class="c-dropdown-menu">
    <!-- Dropdown menu links -->
  </div>
</div>

<!-- Split dropleft button -->
<div class="c-btn-group">
  <div class="c-btn-group c-dropleft" role="group">
    <button type="button" class="c-btn c-btn-secondary c-dropdown-toggle c-dropdown-toggle-split" data-toggle="c-dropdown" aria-expanded="false">
      <span class="sr-only">Toggle Dropleft</span>
    </button>
    <div class="c-dropdown-menu">
      <!-- Dropdown menu links -->
    </div>
  </div>
  <button type="button" class="c-btn c-btn-secondary">
    Split dropleft
  </button>
</div>

Historically dropdown menu contents had to be linked, but that’s no longer the case with v4. Now you can optionally use <button> elements in your dropdowns instead of just <a>s.

<div class="c-dropdown">
  <button class="c-btn c-btn-secondary c-dropdown-toggle" type="button" id="dropdownMenu2" data-toggle="c-dropdown" aria-expanded="false">
    Dropdown
  </button>
  <div class="c-dropdown-menu" aria-labelledby="dropdownMenu2">
    <button class="c-dropdown-item" type="button">Action</button>
    <button class="c-dropdown-item" type="button">Another action</button>
    <button class="c-dropdown-item" type="button">Something else here</button>
  </div>
</div>

You can also create non-interactive dropdown items with .c-dropdown-item-text. Feel free to style further with custom CSS or text utilities.

Dropdown item text Item Another Item One more item
<div class="c-dropdown-menu">
  <span class="c-dropdown-item-text">Dropdown item text</span>
  <a class="c-dropdown-item" href="#">Item</a>
  <a class="c-dropdown-item" href="#">Another Item</a>
  <a class="c-dropdown-item" href="#">One more item</a>
</div>

Active

Add .active to items in the dropdown to style them as active.

<div class="c-dropdown-menu">
  <a class="c-dropdown-item" href="#">Regular link</a>
  <a class="c-dropdown-item active" href="#">Active link</a>
  <a class="c-dropdown-item" href="#">Another link</a>
</div>

Disabled

Add .disabled to items in the dropdown to style them as disabled.

<div class="c-dropdown-menu">
  <a class="c-dropdown-item" href="#">Regular link</a>
  <a class="c-dropdown-item disabled" href="#" tabindex="-1" aria-disabled="true">Disabled link</a>
  <a class="c-dropdown-item" href="#">Another link</a>
</div>

By default, a dropdown menu is automatically positioned 100% from the top and along the left side of its parent. Add .c-dropdown-menu-right to a .c-dropdown-menu to right align the dropdown menu.

Heads up! Dropdowns are positioned thanks to Popper.js (except when they are contained in a navbar).
<div class="c-btn-group">
  <button type="button" class="c-btn c-btn-secondary c-dropdown-toggle" data-toggle="c-dropdown" aria-expanded="false">
    Right-aligned menu
  </button>
  <div class="c-dropdown-menu c-dropdown-menu-right">
    <button class="c-dropdown-item" type="button">Action</button>
    <button class="c-dropdown-item" type="button">Another action</button>
    <button class="c-dropdown-item" type="button">Something else here</button>
  </div>
</div>

Responsive alignment

If you want to use responsive alignment, disable dynamic positioning by adding the data-display="static" attribute and use the responsive variation classes.

To align right the dropdown menu with the given breakpoint or larger, add .c-dropdown-menu{-sm|-md|-lg|-xl}-right.

<div class="c-btn-group">
  <button type="button" class="c-btn c-btn-secondary c-dropdown-toggle" data-toggle="c-dropdown" data-display="static" aria-expanded="false">
    Left-aligned but right aligned when large screen
  </button>
  <div class="c-dropdown-menu c-dropdown-menu-lg-right">
    <button class="c-dropdown-item" type="button">Action</button>
    <button class="c-dropdown-item" type="button">Another action</button>
    <button class="c-dropdown-item" type="button">Something else here</button>
  </div>
</div>

To align left the dropdown menu with the given breakpoint or larger, add .c-dropdown-menu-right and .c-dropdown-menu{-sm|-md|-lg|-xl}-left.

<div class="c-btn-group">
  <button type="button" class="c-btn c-btn-secondary c-dropdown-toggle" data-toggle="c-dropdown" data-display="static" aria-expanded="false">
    Right-aligned but left aligned when large screen
  </button>
  <div class="c-dropdown-menu c-dropdown-menu-right c-dropdown-menu-lg-left">
    <button class="c-dropdown-item" type="button">Action</button>
    <button class="c-dropdown-item" type="button">Another action</button>
    <button class="c-dropdown-item" type="button">Something else here</button>
  </div>
</div>

Note that you don’t need to add a data-display="static" attribute to dropdown buttons in navbars, since Popper.js isn’t used in navbars.

Headers

Add a header to label sections of actions in any dropdown menu.

Dropdown header
Item Another Item
<div class="c-dropdown-menu">
  <h6 class="c-dropdown-header">Dropdown header</h6>
  <a class="c-dropdown-item" href="#">Item</a>
  <a class="c-dropdown-item" href="#">Another Item</a>
</div>

Dividers

Separate groups of related menu items with a divider.

<div class="c-dropdown-menu">
  <a class="c-dropdown-item" href="#">Item</a>
  <a class="c-dropdown-item" href="#">Another Item</a>
  <a class="c-dropdown-item" href="#">One more item</a>
  <div class="c-dropdown-divider"></div>
  <a class="c-dropdown-item" href="#">Separated link</a>
</div>

Text

Place any freeform text within a dropdown menu with text and use spacing utilities. Note that you’ll likely need additional sizing styles to constrain the menu width.

Some example text that's free-flowing within the dropdown menu.

And this is more example text.

<div class="c-dropdown-menu c-p-4 c-text-muted" style="max-width: 200px;">
  <p>
    Some example text that's free-flowing within the dropdown menu.
  </p>
  <p class="c-mb-0">
    And this is more example text.
  </p>
</div>

Forms

Put a form within a dropdown menu, or make it into a dropdown menu, and use margin or padding utilities to give it the negative space you require.

New around here? Sign up Forgot password?
<div class="c-dropdown-menu">
  <form class="c-px-4 c-py-3">
    <div class="c-form-group">
      <label for="exampleDropdownFormEmail1">Email address</label>
      <input type="email" class="c-form-control" id="exampleDropdownFormEmail1" placeholder="[email protected]">
    </div>
    <div class="c-form-group">
      <label for="exampleDropdownFormPassword1">Password</label>
      <input type="password" class="c-form-control" id="exampleDropdownFormPassword1" placeholder="Password">
    </div>
    <div class="c-form-group">
      <div class="c-form-check">
        <input type="checkbox" class="c-form-check-input" id="dropdownCheck">
        <label class="c-form-check-label" for="dropdownCheck">
          Remember me
        </label>
      </div>
    </div>
    <button type="submit" class="c-btn c-btn-primary">Sign in</button>
  </form>
  <div class="c-dropdown-divider"></div>
  <a class="c-dropdown-item" href="#">New around here? Sign up</a>
  <a class="c-dropdown-item" href="#">Forgot password?</a>
</div>
<form class="c-dropdown-menu c-p-4">
  <div class="c-form-group">
    <label for="exampleDropdownFormEmail2">Email address</label>
    <input type="email" class="c-form-control" id="exampleDropdownFormEmail2" placeholder="[email protected]">
  </div>
  <div class="c-form-group">
    <label for="exampleDropdownFormPassword2">Password</label>
    <input type="password" class="c-form-control" id="exampleDropdownFormPassword2" placeholder="Password">
  </div>
  <div class="c-form-group">
    <div class="c-form-check">
      <input type="checkbox" class="c-form-check-input" id="dropdownCheck2">
      <label class="c-form-check-label" for="dropdownCheck2">
        Remember me
      </label>
    </div>
  </div>
  <button type="submit" class="c-btn c-btn-primary">Sign in</button>
</form>

Use data-offset or data-reference to change the location of the dropdown.

<div class="c-d-flex">
  <div class="c-dropdown c-mr-1">
    <button type="button" class="c-btn c-btn-secondary c-dropdown-toggle" id="dropdownMenuOffset" data-toggle="c-dropdown" aria-expanded="false" data-offset="10,20">
      Offset
    </button>
    <div class="c-dropdown-menu" aria-labelledby="dropdownMenuOffset">
      <a class="c-dropdown-item" href="#">Item</a>
      <a class="c-dropdown-item" href="#">Another Item</a>
      <a class="c-dropdown-item" href="#">One more item</a>
    </div>
  </div>
  <div class="c-btn-group">
    <button type="button" class="c-btn c-btn-secondary">Reference</button>
    <button type="button" class="c-btn c-btn-secondary c-dropdown-toggle c-dropdown-toggle-split" id="dropdownMenuReference" data-toggle="c-dropdown" aria-expanded="false" data-reference="parent">
      <span class="sr-only">Toggle Dropdown</span>
    </button>
    <div class="c-dropdown-menu" aria-labelledby="dropdownMenuReference">
      <a class="c-dropdown-item" href="#">Item</a>
      <a class="c-dropdown-item" href="#">Another Item</a>
      <a class="c-dropdown-item" href="#">One more item</a>
      <div class="c-dropdown-divider"></div>
      <a class="c-dropdown-item" href="#">Separated link</a>
    </div>
  </div>
</div>

Usage

Via data attributes or JavaScript, the dropdown plugin toggles hidden content (dropdown menus) by toggling the .c-show class on the parent list item. The data-toggle="c-dropdown" attribute is relied on for closing dropdown menus at an application level, so it’s a good idea to always use it.

On touch-enabled devices, opening a dropdown adds empty ($.noop) mouseover handlers to the immediate children of the <body> element. This admittedly ugly hack is necessary to work around a quirk in iOS’ event delegation, which would otherwise prevent a tap anywhere outside of the dropdown from triggering the code that closes the dropdown. Once the dropdown is closed, these additional empty mouseover handlers are removed.

Via data attributes

Add data-toggle="c-dropdown" to a link or button to toggle a dropdown.

<div class="c-dropdown">
  <button id="dLabel" type="button" data-toggle="c-dropdown" aria-expanded="false">
    Dropdown trigger
  </button>
  <div class="c-dropdown-menu" aria-labelledby="dLabel">
    ...
  </div>
</div>

Via JavaScript (no jQuery)

Call the dropdowns via JavaScript:

var dropdownElementList = [].slice.call(document.querySelectorAll('.dropdown-toggle'))
var dropdownList = dropdownElementList.map(function (dropdownToggleEl) {
  return new coreui.Dropdown(dropdownToggleEl)
})
data-toggle="dropdown" still required

Regardless of whether you call your dropdown via JavaScript or instead use the data-api, data-toggle="dropdown" is always required to be present on the dropdown’s trigger element.

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-offset="".

Note when boundary is set to any value other than 'scrollParent', the style position: static is applied to the .dropdown container.

Methods

Method Description
toggle Toggles the dropdown menu of a given navbar or tabbed navigation.
show Shows the dropdown menu of a given navbar or tabbed navigation.
hide Hides the dropdown menu of a given navbar or tabbed navigation.
update Updates the position of an element’s dropdown.
dispose Destroys an element’s dropdown.
_getInstance Static method which allows you to get the dropdown instance associated with a DOM element

Events

All dropdown events are fired at the .dropdown-menu’s parent element and have a relatedTarget property, whose value is the toggling anchor element. hide.coreui.dropdown and hidden.coreui.dropdown events have a clickEvent property (only when the original event type is click) that contains an Event Object for the click event.

Event Description
show.coreui.dropdown This event fires immediately when the show instance method is called.
shown.coreui.dropdown This event is fired when the dropdown has been made visible to the user (will wait for CSS transitions, to complete).
hide.coreui.dropdown This event is fired immediately when the hide instance method has been called.
hidden.coreui.dropdown This event is fired when the dropdown has finished being hidden from the user (will wait for CSS transitions, to complete).
var myDropdown = document.getElementById('myDropdown')
myDropdown.addEventListener('show.coreui.dropdown', function () {
  // do something...
})

Via JavaScript (jQuery)

Call the dropdowns via JavaScript:

$('.c-dropdown-toggle').dropdown()
data-toggle="c-dropdown" still required

Regardless of whether you call your dropdown via JavaScript or use the data-api, data-toggle="c-dropdown" is always needed to be present on the dropdown’s trigger element.

Options

Options can be transferred via data attributes or JavaScript. For data properties, add the option name to data-, as in data-offset="".

Name Type Default Description
offset number | string | function 0

Offset of the dropdown relative to its target. For more information refer to Popper.js's offset docs.

flip boolean true Allow Dropdown to flip in case of an overlapping on the reference element. For more information refer to Popper.js's flip docs.
boundary string | element 'scrollParent' Overflow constraint boundary of the dropdown menu. Accepts the values of 'viewport', 'window', 'scrollParent', or an HTMLElement reference (JavaScript only). For more information refer to Popper.js's preventOverflow docs.
reference string | element 'toggle' Reference element of the dropdown menu. Accepts the values of 'toggle', 'parent', or an HTMLElement reference. For more information refer to Popper.js's referenceObject docs.
display string 'dynamic' By default, we use Popper.js for dynamic positioning. Disable this with static.

Note when boundary is set to any value other than 'scrollParent', the style position: static is applied to the .c-dropdown container.

Methods

Method Description
$().dropdown('toggle') Toggles the dropdown menu of a given navbar or tabbed navigation.
$().dropdown('show') Shows the dropdown menu of a given navbar or tabbed navigation.
$().dropdown('hide') Hides the dropdown menu of a given navbar or tabbed navigation.
$().dropdown('update') Updates the position of an element’s dropdown.
$().dropdown('dispose') Destroys an element’s dropdown.

Events

All dropdown events are fired at the .c-dropdown-menu’s parent element and have a relatedTarget property, whose value is the toggling anchor element. hide.coreui.dropdown and hidden.coreui.dropdown events have a clickEvent property (only when the original event type is click) that contains an Event Object for the click event.

Event Description
show.coreui.dropdown This event fires immediately when the show instance method is called.
shown.coreui.dropdown This event is fired when the dropdown has been made visible to the user (will wait for CSS transitions, to complete).
hide.coreui.dropdown This event is fired immediately when the hide instance method has been called.
hidden.coreui.dropdown This event is fired when the dropdown has finished being hidden from the user (will wait for CSS transitions, to complete).
$('#myDropdown').on('show.coreui.dropdown', function () {
  // do something...
})